Oracle Database@Google Cloud API . projects . locations . goldengateConnectionAssignments

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, goldengateConnectionAssignmentId=None, requestId=None, x__xgafv=None)

Creates a new GoldengateConnectionAssignment in a given project and location.

delete(name, requestId=None, x__xgafv=None)

Deletes a single GoldengateConnectionAssignment.

get(name, x__xgafv=None)

Gets details of a single GoldengateConnectionAssignment.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists GoldengateConnectionAssignments in a given project and location.

list_next()

Retrieves the next page of results.

test(name, body=None, x__xgafv=None)

Tests a single GoldengateConnectionAssignment.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, goldengateConnectionAssignmentId=None, requestId=None, x__xgafv=None)
Creates a new GoldengateConnectionAssignment in a given project and location.

Args:
  parent: string, Required. The parent resource where this GoldengateConnectionAssignment will be created. Format: projects/{project}/locations/{location} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents the metadata of a Goldengate Connection Assignment.
  "createTime": "A String", # Output only. The time when the connection assignment was created.
  "displayName": "A String", # Optional. The display name for the GoldengateConnectionAssignment.
  "entitlementId": "A String", # Output only. The OCID of the entitlement linked to this resource.
  "labels": { # Optional. The labels or tags associated with the GoldengateConnectionAssignment.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The name of the GoldengateConnectionAssignment resource in the following format: projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}
  "properties": { # The properties of a GoldengateConnectionAssignment. # Required. The properties of the GoldengateConnectionAssignment.
    "alias": "A String", # Output only. Credential store alias.
    "goldengateConnection": "A String", # Required. The GoldengateConnection resource to be assigned. Format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}
    "goldengateDeployment": "A String", # Required. The GoldenGateDeployment to assign the connection to. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}
    "ocid": "A String", # Output only. The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced.
    "state": "A String", # Output only. The lifecycle state of the connection assignment.
  },
}

  goldengateConnectionAssignmentId: string, Required. The ID of the GoldengateConnectionAssignment to create.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
delete(name, requestId=None, x__xgafv=None)
Deletes a single GoldengateConnectionAssignment.

Args:
  name: string, Required. The name of the GoldengateConnectionAssignment to delete. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment} (required)
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, x__xgafv=None)
Gets details of a single GoldengateConnectionAssignment.

Args:
  name: string, Required. The name of the GoldengateConnectionAssignment to retrieve. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents the metadata of a Goldengate Connection Assignment.
  "createTime": "A String", # Output only. The time when the connection assignment was created.
  "displayName": "A String", # Optional. The display name for the GoldengateConnectionAssignment.
  "entitlementId": "A String", # Output only. The OCID of the entitlement linked to this resource.
  "labels": { # Optional. The labels or tags associated with the GoldengateConnectionAssignment.
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The name of the GoldengateConnectionAssignment resource in the following format: projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}
  "properties": { # The properties of a GoldengateConnectionAssignment. # Required. The properties of the GoldengateConnectionAssignment.
    "alias": "A String", # Output only. Credential store alias.
    "goldengateConnection": "A String", # Required. The GoldengateConnection resource to be assigned. Format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}
    "goldengateDeployment": "A String", # Required. The GoldenGateDeployment to assign the connection to. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}
    "ocid": "A String", # Output only. The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced.
    "state": "A String", # Output only. The lifecycle state of the connection assignment.
  },
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists GoldengateConnectionAssignments in a given project and location.

Args:
  parent: string, Required. The parent value for the GoldengateConnectionAssignments. Format: projects/{project}/locations/{location} (required)
  filter: string, Optional. A filter expression that filters GoldengateConnectionAssignments listed in the response.
  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "DESC" after a field name for descending.
  pageSize: integer, Optional. The maximum number of GoldengateConnectionAssignments to return. The service may return fewer than this value. If unspecified, at most 50 GoldengateConnectionAssignments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Optional. A page token, received from a previous `ListGoldengateConnectionAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoldengateConnectionAssignments` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for listing GoldengateConnectionAssignments.
  "goldengateConnectionAssignments": [ # The list of GoldengateConnectionAssignments.
    { # Represents the metadata of a Goldengate Connection Assignment.
      "createTime": "A String", # Output only. The time when the connection assignment was created.
      "displayName": "A String", # Optional. The display name for the GoldengateConnectionAssignment.
      "entitlementId": "A String", # Output only. The OCID of the entitlement linked to this resource.
      "labels": { # Optional. The labels or tags associated with the GoldengateConnectionAssignment.
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The name of the GoldengateConnectionAssignment resource in the following format: projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}
      "properties": { # The properties of a GoldengateConnectionAssignment. # Required. The properties of the GoldengateConnectionAssignment.
        "alias": "A String", # Output only. Credential store alias.
        "goldengateConnection": "A String", # Required. The GoldengateConnection resource to be assigned. Format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}
        "goldengateDeployment": "A String", # Required. The GoldenGateDeployment to assign the connection to. Format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}
        "ocid": "A String", # Output only. The [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the connection assignment being referenced.
        "state": "A String", # Output only. The lifecycle state of the connection assignment.
      },
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "unreachable": [ # Unreachable locations when listing resources across all locations using wildcard location '-'.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
test(name, body=None, x__xgafv=None)
Tests a single GoldengateConnectionAssignment.

Args:
  name: string, Required. Name of the connection assignment for which to test connection. projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for TestGoldengateConnectionAssignment.
  "type": "A String", # Optional. The type of the test of the assigned connection. The only type actually supported is DEFAULT.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The result of the connectivity test performed between the Goldengate deployment and the associated database / service.
  "error": { # Error details for TestGoldengateConnectionAssignment. # Error details if test connection failed.
    "action": "A String", # The text describing the action required to fix the issue.
    "code": "A String", # A short error code that defines the error, meant for programmatic parsing.
    "issue": "A String", # The text describing the root cause of the reported issue.
    "message": "A String", # A human-readable error message.
  },
  "errors": [ # List of test connection assignment error objects.
    { # Error details for TestGoldengateConnectionAssignment.
      "action": "A String", # The text describing the action required to fix the issue.
      "code": "A String", # A short error code that defines the error, meant for programmatic parsing.
      "issue": "A String", # The text describing the root cause of the reported issue.
      "message": "A String", # A human-readable error message.
    },
  ],
  "resultType": "A String", # Type of the result i.e. Success, Failure or Timeout.
}