Close httplib2 connections.
create(parent, body=None, goldengateDeploymentId=None, requestId=None, x__xgafv=None)
Creates a new GoldengateDeployment in a given project and location.
delete(name, requestId=None, x__xgafv=None)
Deletes a single GoldengateDeployment.
Gets details of a single GoldengateDeployment.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the GoldengateDeployments for the given project and location.
Retrieves the next page of results.
start(name, body=None, x__xgafv=None)
Starts a single GoldengateDeployment.
stop(name, body=None, x__xgafv=None)
Stops a single GoldengateDeployment.
close()
Close httplib2 connections.
create(parent, body=None, goldengateDeploymentId=None, requestId=None, x__xgafv=None)
Creates a new GoldengateDeployment in a given project and location.
Args:
parent: string, Required. The value for parent of the GoldengateDeployment in the following format: projects/{project}/locations/{location}. (required)
body: object, The request body.
The object takes the form of:
{ # GoldengateDeployment Goldengate Deployment resource model.
"createTime": "A String", # Output only. The date and time that the GoldengateDeployment was created.
"displayName": "A String", # Required. The display name for the GoldengateDeployment.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the GoldengateDeployment
"gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
"labels": { # Optional. The labels or tags associated with the GoldengateDeployment.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the GoldengateDeployment.
"odbSubnet": "A String", # Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.
"properties": { # Properties of GoldengateDeployment. # Required. The properties of the GoldengateDeployment.
"backupSchedule": { # The backup schedule of the GoldengateDeployment. # Output only. The backup schedule of the GoldengateDeployment.
"backupScheduledTime": "A String", # Output only. The timestamp of when the backup was scheduled.
"bucket": "A String", # Output only. The bucket name.
"compartmentId": "A String", # Output only. The compartment id.
"frequencyBackupScheduled": "A String", # Output only. The frequency backup scheduled.
"metadataOnly": True or False, # Output only. If metadata only.
"namespace": "A String", # Output only. The namespace name.
},
"category": "A String", # Output only. The category of the GoldengateDeployment.
"cpuCoreCount": 42, # Optional. The Minimum number of OCPUs to be made available for this Deployment.
"deploymentBackupId": "A String", # Output only. The deployment backup id of the GoldengateDeployment.
"deploymentDiagnosticData": { # The deployment diagnostic data. # Output only. The deployment diagnostic data of the GoldengateDeployment.
"bucket": "A String", # Output only. The bucket name.
"diagnosticEndTime": "A String", # Output only. The time diagnostic end.
"diagnosticStartTime": "A String", # Output only. The time diagnostic start.
"diagnosticState": "A String", # Output only. The diagnostic state.
"namespace": "A String", # Output only. The namespace name.
"object": "A String", # Output only. The object name.
},
"deploymentRole": "A String", # Output only. The deployment role of the GoldengateDeployment.
"deploymentType": "A String", # Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation.
"deploymentUrl": "A String", # Output only. The deployment url of the GoldengateDeployment.
"description": "A String", # Optional. The description of the GoldengateDeployment.
"environmentType": "A String", # Optional. The environment type of the GoldengateDeployment.
"fqdn": "A String", # Output only. The Fully Qualified Domain Name of the GoldengateDeployment.
"healthy": True or False, # Output only. Whether the GoldengateDeployment is healthy.
"ingressIps": [ # Output only. The ingress ips of the GoldengateDeployment.
{ # The ingress IPs of the GoldengateDeployment.
"ingressIpAddress": "A String", # Output only. The ingress IP.
},
],
"isAutoScalingEnabled": True or False, # Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.
"isLatestVersion": True or False, # Output only. Whether the GoldengateDeployment is of the latest version.
"isPublic": True or False, # Output only. Whether the GoldengateDeployment is public.
"isStorageUtilizationLimitExceeded": True or False, # Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.
"lastBackupScheduleTime": "A String", # Output only. The time last backup scheduled of the GoldengateDeployment.
"licenseModel": "A String", # Optional. The Oracle license model that applies to a Deployment.
"lifecycleDetails": "A String", # Output only. The lifecycle details of the GoldengateDeployment.
"lifecycleState": "A String", # Output only. State of the GoldengateDeployment.
"lifecycleSubState": "A String", # Output only. The lifecycle sub-state of the GoldengateDeployment.
"loadBalancerId": "A String", # Output only. The load balancer id of the GoldengateDeployment.
"loadBalancerSubnetId": "A String", # Output only. The load balancer subnet id of the GoldengateDeployment.
"locks": [ # Output only. The locks of the GoldengateDeployment.
{ # The lock of the GoldengateDeployment.
"compartmentId": "A String", # Output only. The compartment id.
"createTime": "A String", # Output only. The time created.
"message": "A String", # Output only. The message.
"relatedResourceId": "A String", # Output only. The related resource id.
"type": "A String", # Output only. The type of lock.
},
],
"maintenanceConfig": { # The maintenance configuration of the GoldengateDeployment. # Optional. The maintenance configuration of the GoldengateDeployment.
"bundleReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
"interimReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
"isInterimReleaseAutoUpgradeEnabled": True or False, # Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too.
"majorReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.
"securityPatchUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.
},
"maintenanceWindow": { # The maintenance window of the GoldengateDeployment. # Optional. The maintenance window of the GoldengateDeployment.
"day": "A String", # Required. Days of the week.
"startHour": 42, # Required. Start hour for maintenance period. Hour is in UTC.
},
"nextBackupScheduleTime": "A String", # Output only. The time next backup scheduled of the GoldengateDeployment.
"nextMaintenanceActionType": "A String", # Output only. The next maintenance action type of the GoldengateDeployment.
"nextMaintenanceDescription": "A String", # Output only. The next maintenance description of the GoldengateDeployment.
"nextMaintenanceTime": "A String", # Output only. The time of next maintenance of the GoldengateDeployment.
"nsgIds": [ # Output only. The nsg ids of the GoldengateDeployment.
"A String",
],
"ocid": "A String", # Output only. OCID of the GoldengateDeployment.
"oggData": { # The Ogg data of the GoldengateDeployment. # Required. The ogg data of the GoldengateDeployment.
"adminPassword": "A String", # Optional. The Goldengate deployment console password in plain text.
"adminPasswordSecretVersion": "A String", # Optional. Input only. The Goldengate deployment console password secret version.
"adminUsername": "A String", # Required. The Goldengate deployment console username.
"certificate": "A String", # Output only. The certificate of the GoldengateDeployment.
"credentialStore": "A String", # Output only. The credential store of the GoldengateDeployment.
"deployment": "A String", # Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
"groupRolesMapping": { # The group to roles mapping of the GoldengateDeployment. # Output only. The group to roles mapping of the GoldengateDeployment.
"administratorGroupId": "A String", # Output only. The administrator group id.
"operatorGroupId": "A String", # Output only. The operator group id.
"securityGroupId": "A String", # Output only. The security group id.
"userGroupId": "A String", # Output only. The user group id.
},
"identityDomainId": "A String", # Output only. The identity domain id of the GoldengateDeployment.
"oggVersion": "A String", # Optional. Version of OGG
"passwordSecretId": "A String", # Output only. The password secret id of the GoldengateDeployment.
},
"oggVersionSupportEndTime": "A String", # Output only. The time ogg version supported until of the GoldengateDeployment.
"placements": [ # Output only. The placements of the GoldengateDeployment.
{ # The placement of the GoldengateDeployment.
"availabilityDomain": "A String", # Output only. The availability domain.
"faultDomain": "A String", # Output only. The fault domain.
},
],
"privateIpAddress": "A String", # Output only. The private ip address of the GoldengateDeployment.
"publicIpAddress": "A String", # Output only. The public ip address of the GoldengateDeployment.
"roleChangeTime": "A String", # Output only. The time when the role of the GoldengateDeployment was changed.
"storageUtilizationBytes": "A String", # Output only. The storage utilization in bytes of the GoldengateDeployment.
"updateTime": "A String", # Output only. The time the GoldengateDeployment was updated.
"upgradeRequiredTime": "A String", # Output only. The time upgrade required of the GoldengateDeployment.
},
}
goldengateDeploymentId: string, Required. The ID of the GoldengateDeployment to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
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 GoldengateDeployment.
Args:
name: string, Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}. (required)
requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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 GoldengateDeployment.
Args:
name: string, Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # GoldengateDeployment Goldengate Deployment resource model.
"createTime": "A String", # Output only. The date and time that the GoldengateDeployment was created.
"displayName": "A String", # Required. The display name for the GoldengateDeployment.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the GoldengateDeployment
"gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
"labels": { # Optional. The labels or tags associated with the GoldengateDeployment.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the GoldengateDeployment.
"odbSubnet": "A String", # Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.
"properties": { # Properties of GoldengateDeployment. # Required. The properties of the GoldengateDeployment.
"backupSchedule": { # The backup schedule of the GoldengateDeployment. # Output only. The backup schedule of the GoldengateDeployment.
"backupScheduledTime": "A String", # Output only. The timestamp of when the backup was scheduled.
"bucket": "A String", # Output only. The bucket name.
"compartmentId": "A String", # Output only. The compartment id.
"frequencyBackupScheduled": "A String", # Output only. The frequency backup scheduled.
"metadataOnly": True or False, # Output only. If metadata only.
"namespace": "A String", # Output only. The namespace name.
},
"category": "A String", # Output only. The category of the GoldengateDeployment.
"cpuCoreCount": 42, # Optional. The Minimum number of OCPUs to be made available for this Deployment.
"deploymentBackupId": "A String", # Output only. The deployment backup id of the GoldengateDeployment.
"deploymentDiagnosticData": { # The deployment diagnostic data. # Output only. The deployment diagnostic data of the GoldengateDeployment.
"bucket": "A String", # Output only. The bucket name.
"diagnosticEndTime": "A String", # Output only. The time diagnostic end.
"diagnosticStartTime": "A String", # Output only. The time diagnostic start.
"diagnosticState": "A String", # Output only. The diagnostic state.
"namespace": "A String", # Output only. The namespace name.
"object": "A String", # Output only. The object name.
},
"deploymentRole": "A String", # Output only. The deployment role of the GoldengateDeployment.
"deploymentType": "A String", # Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation.
"deploymentUrl": "A String", # Output only. The deployment url of the GoldengateDeployment.
"description": "A String", # Optional. The description of the GoldengateDeployment.
"environmentType": "A String", # Optional. The environment type of the GoldengateDeployment.
"fqdn": "A String", # Output only. The Fully Qualified Domain Name of the GoldengateDeployment.
"healthy": True or False, # Output only. Whether the GoldengateDeployment is healthy.
"ingressIps": [ # Output only. The ingress ips of the GoldengateDeployment.
{ # The ingress IPs of the GoldengateDeployment.
"ingressIpAddress": "A String", # Output only. The ingress IP.
},
],
"isAutoScalingEnabled": True or False, # Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.
"isLatestVersion": True or False, # Output only. Whether the GoldengateDeployment is of the latest version.
"isPublic": True or False, # Output only. Whether the GoldengateDeployment is public.
"isStorageUtilizationLimitExceeded": True or False, # Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.
"lastBackupScheduleTime": "A String", # Output only. The time last backup scheduled of the GoldengateDeployment.
"licenseModel": "A String", # Optional. The Oracle license model that applies to a Deployment.
"lifecycleDetails": "A String", # Output only. The lifecycle details of the GoldengateDeployment.
"lifecycleState": "A String", # Output only. State of the GoldengateDeployment.
"lifecycleSubState": "A String", # Output only. The lifecycle sub-state of the GoldengateDeployment.
"loadBalancerId": "A String", # Output only. The load balancer id of the GoldengateDeployment.
"loadBalancerSubnetId": "A String", # Output only. The load balancer subnet id of the GoldengateDeployment.
"locks": [ # Output only. The locks of the GoldengateDeployment.
{ # The lock of the GoldengateDeployment.
"compartmentId": "A String", # Output only. The compartment id.
"createTime": "A String", # Output only. The time created.
"message": "A String", # Output only. The message.
"relatedResourceId": "A String", # Output only. The related resource id.
"type": "A String", # Output only. The type of lock.
},
],
"maintenanceConfig": { # The maintenance configuration of the GoldengateDeployment. # Optional. The maintenance configuration of the GoldengateDeployment.
"bundleReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
"interimReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
"isInterimReleaseAutoUpgradeEnabled": True or False, # Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too.
"majorReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.
"securityPatchUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.
},
"maintenanceWindow": { # The maintenance window of the GoldengateDeployment. # Optional. The maintenance window of the GoldengateDeployment.
"day": "A String", # Required. Days of the week.
"startHour": 42, # Required. Start hour for maintenance period. Hour is in UTC.
},
"nextBackupScheduleTime": "A String", # Output only. The time next backup scheduled of the GoldengateDeployment.
"nextMaintenanceActionType": "A String", # Output only. The next maintenance action type of the GoldengateDeployment.
"nextMaintenanceDescription": "A String", # Output only. The next maintenance description of the GoldengateDeployment.
"nextMaintenanceTime": "A String", # Output only. The time of next maintenance of the GoldengateDeployment.
"nsgIds": [ # Output only. The nsg ids of the GoldengateDeployment.
"A String",
],
"ocid": "A String", # Output only. OCID of the GoldengateDeployment.
"oggData": { # The Ogg data of the GoldengateDeployment. # Required. The ogg data of the GoldengateDeployment.
"adminPassword": "A String", # Optional. The Goldengate deployment console password in plain text.
"adminPasswordSecretVersion": "A String", # Optional. Input only. The Goldengate deployment console password secret version.
"adminUsername": "A String", # Required. The Goldengate deployment console username.
"certificate": "A String", # Output only. The certificate of the GoldengateDeployment.
"credentialStore": "A String", # Output only. The credential store of the GoldengateDeployment.
"deployment": "A String", # Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
"groupRolesMapping": { # The group to roles mapping of the GoldengateDeployment. # Output only. The group to roles mapping of the GoldengateDeployment.
"administratorGroupId": "A String", # Output only. The administrator group id.
"operatorGroupId": "A String", # Output only. The operator group id.
"securityGroupId": "A String", # Output only. The security group id.
"userGroupId": "A String", # Output only. The user group id.
},
"identityDomainId": "A String", # Output only. The identity domain id of the GoldengateDeployment.
"oggVersion": "A String", # Optional. Version of OGG
"passwordSecretId": "A String", # Output only. The password secret id of the GoldengateDeployment.
},
"oggVersionSupportEndTime": "A String", # Output only. The time ogg version supported until of the GoldengateDeployment.
"placements": [ # Output only. The placements of the GoldengateDeployment.
{ # The placement of the GoldengateDeployment.
"availabilityDomain": "A String", # Output only. The availability domain.
"faultDomain": "A String", # Output only. The fault domain.
},
],
"privateIpAddress": "A String", # Output only. The private ip address of the GoldengateDeployment.
"publicIpAddress": "A String", # Output only. The public ip address of the GoldengateDeployment.
"roleChangeTime": "A String", # Output only. The time when the role of the GoldengateDeployment was changed.
"storageUtilizationBytes": "A String", # Output only. The storage utilization in bytes of the GoldengateDeployment.
"updateTime": "A String", # Output only. The time the GoldengateDeployment was updated.
"upgradeRequiredTime": "A String", # Output only. The time upgrade required of the GoldengateDeployment.
},
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all the GoldengateDeployments for the given project and location.
Args:
parent: string, Required. The parent value for GoldengateDeployments in the following format: projects/{project}/locations/{location}. (required)
filter: string, Optional. An expression for filtering the results of the request.
orderBy: string, Optional. An expression for ordering the results of the request.
pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateDeployments 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 ListGoldengateDeployments call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `GoldengateDeployment.List`.
"goldengateDeployments": [ # The list of GoldengateDeployments.
{ # GoldengateDeployment Goldengate Deployment resource model.
"createTime": "A String", # Output only. The date and time that the GoldengateDeployment was created.
"displayName": "A String", # Required. The display name for the GoldengateDeployment.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the GoldengateDeployment
"gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle GoldengateDeployment is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
"labels": { # Optional. The labels or tags associated with the GoldengateDeployment.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the GoldengateDeployment resource in the following format: projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the GoldengateDeployment.
"odbSubnet": "A String", # Required. The name of the OdbSubnet associated with the GoldengateDeployment for IP allocation.
"properties": { # Properties of GoldengateDeployment. # Required. The properties of the GoldengateDeployment.
"backupSchedule": { # The backup schedule of the GoldengateDeployment. # Output only. The backup schedule of the GoldengateDeployment.
"backupScheduledTime": "A String", # Output only. The timestamp of when the backup was scheduled.
"bucket": "A String", # Output only. The bucket name.
"compartmentId": "A String", # Output only. The compartment id.
"frequencyBackupScheduled": "A String", # Output only. The frequency backup scheduled.
"metadataOnly": True or False, # Output only. If metadata only.
"namespace": "A String", # Output only. The namespace name.
},
"category": "A String", # Output only. The category of the GoldengateDeployment.
"cpuCoreCount": 42, # Optional. The Minimum number of OCPUs to be made available for this Deployment.
"deploymentBackupId": "A String", # Output only. The deployment backup id of the GoldengateDeployment.
"deploymentDiagnosticData": { # The deployment diagnostic data. # Output only. The deployment diagnostic data of the GoldengateDeployment.
"bucket": "A String", # Output only. The bucket name.
"diagnosticEndTime": "A String", # Output only. The time diagnostic end.
"diagnosticStartTime": "A String", # Output only. The time diagnostic start.
"diagnosticState": "A String", # Output only. The diagnostic state.
"namespace": "A String", # Output only. The namespace name.
"object": "A String", # Output only. The object name.
},
"deploymentRole": "A String", # Output only. The deployment role of the GoldengateDeployment.
"deploymentType": "A String", # Required. A valid Goldengate Deployment type. For a list of supported types, use the `ListGoldengateDeploymentTypes` operation.
"deploymentUrl": "A String", # Output only. The deployment url of the GoldengateDeployment.
"description": "A String", # Optional. The description of the GoldengateDeployment.
"environmentType": "A String", # Optional. The environment type of the GoldengateDeployment.
"fqdn": "A String", # Output only. The Fully Qualified Domain Name of the GoldengateDeployment.
"healthy": True or False, # Output only. Whether the GoldengateDeployment is healthy.
"ingressIps": [ # Output only. The ingress ips of the GoldengateDeployment.
{ # The ingress IPs of the GoldengateDeployment.
"ingressIpAddress": "A String", # Output only. The ingress IP.
},
],
"isAutoScalingEnabled": True or False, # Optional. Indicates if auto scaling is enabled for the Deployment's CPU core count.
"isLatestVersion": True or False, # Output only. Whether the GoldengateDeployment is of the latest version.
"isPublic": True or False, # Output only. Whether the GoldengateDeployment is public.
"isStorageUtilizationLimitExceeded": True or False, # Output only. Whether storage utilization limit is exceeded of the GoldengateDeployment.
"lastBackupScheduleTime": "A String", # Output only. The time last backup scheduled of the GoldengateDeployment.
"licenseModel": "A String", # Optional. The Oracle license model that applies to a Deployment.
"lifecycleDetails": "A String", # Output only. The lifecycle details of the GoldengateDeployment.
"lifecycleState": "A String", # Output only. State of the GoldengateDeployment.
"lifecycleSubState": "A String", # Output only. The lifecycle sub-state of the GoldengateDeployment.
"loadBalancerId": "A String", # Output only. The load balancer id of the GoldengateDeployment.
"loadBalancerSubnetId": "A String", # Output only. The load balancer subnet id of the GoldengateDeployment.
"locks": [ # Output only. The locks of the GoldengateDeployment.
{ # The lock of the GoldengateDeployment.
"compartmentId": "A String", # Output only. The compartment id.
"createTime": "A String", # Output only. The time created.
"message": "A String", # Output only. The message.
"relatedResourceId": "A String", # Output only. The related resource id.
"type": "A String", # Output only. The type of lock.
},
],
"maintenanceConfig": { # The maintenance configuration of the GoldengateDeployment. # Optional. The maintenance configuration of the GoldengateDeployment.
"bundleReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
"interimReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
"isInterimReleaseAutoUpgradeEnabled": True or False, # Optional. By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interim_release_upgrade_period_days too.
"majorReleaseUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.
"securityPatchUpgradePeriodDays": 42, # Optional. Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.
},
"maintenanceWindow": { # The maintenance window of the GoldengateDeployment. # Optional. The maintenance window of the GoldengateDeployment.
"day": "A String", # Required. Days of the week.
"startHour": 42, # Required. Start hour for maintenance period. Hour is in UTC.
},
"nextBackupScheduleTime": "A String", # Output only. The time next backup scheduled of the GoldengateDeployment.
"nextMaintenanceActionType": "A String", # Output only. The next maintenance action type of the GoldengateDeployment.
"nextMaintenanceDescription": "A String", # Output only. The next maintenance description of the GoldengateDeployment.
"nextMaintenanceTime": "A String", # Output only. The time of next maintenance of the GoldengateDeployment.
"nsgIds": [ # Output only. The nsg ids of the GoldengateDeployment.
"A String",
],
"ocid": "A String", # Output only. OCID of the GoldengateDeployment.
"oggData": { # The Ogg data of the GoldengateDeployment. # Required. The ogg data of the GoldengateDeployment.
"adminPassword": "A String", # Optional. The Goldengate deployment console password in plain text.
"adminPasswordSecretVersion": "A String", # Optional. Input only. The Goldengate deployment console password secret version.
"adminUsername": "A String", # Required. The Goldengate deployment console username.
"certificate": "A String", # Output only. The certificate of the GoldengateDeployment.
"credentialStore": "A String", # Output only. The credential store of the GoldengateDeployment.
"deployment": "A String", # Required. The name given to the Goldengate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
"groupRolesMapping": { # The group to roles mapping of the GoldengateDeployment. # Output only. The group to roles mapping of the GoldengateDeployment.
"administratorGroupId": "A String", # Output only. The administrator group id.
"operatorGroupId": "A String", # Output only. The operator group id.
"securityGroupId": "A String", # Output only. The security group id.
"userGroupId": "A String", # Output only. The user group id.
},
"identityDomainId": "A String", # Output only. The identity domain id of the GoldengateDeployment.
"oggVersion": "A String", # Optional. Version of OGG
"passwordSecretId": "A String", # Output only. The password secret id of the GoldengateDeployment.
},
"oggVersionSupportEndTime": "A String", # Output only. The time ogg version supported until of the GoldengateDeployment.
"placements": [ # Output only. The placements of the GoldengateDeployment.
{ # The placement of the GoldengateDeployment.
"availabilityDomain": "A String", # Output only. The availability domain.
"faultDomain": "A String", # Output only. The fault domain.
},
],
"privateIpAddress": "A String", # Output only. The private ip address of the GoldengateDeployment.
"publicIpAddress": "A String", # Output only. The public ip address of the GoldengateDeployment.
"roleChangeTime": "A String", # Output only. The time when the role of the GoldengateDeployment was changed.
"storageUtilizationBytes": "A String", # Output only. The storage utilization in bytes of the GoldengateDeployment.
"updateTime": "A String", # Output only. The time the GoldengateDeployment was updated.
"upgradeRequiredTime": "A String", # Output only. The time upgrade required of the GoldengateDeployment.
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Optional. Locations that could not be reached.
"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.
start(name, body=None, x__xgafv=None)
Starts a single GoldengateDeployment.
Args:
name: string, Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `GoldengateDeployment.Start`.
}
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.
},
}
stop(name, body=None, x__xgafv=None)
Stops a single GoldengateDeployment.
Args:
name: string, Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}. (required)
body: object, The request body.
The object takes the form of:
{ # The request for `GoldengateDeployment.Stop`.
}
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.
},
}