2026-05-12
▼ ▲ oracledatabase.projects.locations.goldengateDeployments.list
Description : Lists all the GoldengateDeployments for the given project and location.
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent value for GoldengateDeployments in the following format: projects/{project}/locations/{location}.
Required : Yes
Type : string
pageToken
Type : string
Description : Optional. A page token, received from a previous ListGoldengateDeployments call. Provide this to retrieve the subsequent page.
Location : query
pageSize
Description : 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.
Location : query
Format : int32
Type : integer
filter
Description : Optional. An expression for filtering the results of the request.
Location : query
Type : string
orderBy
Type : string
Description : Optional. An expression for ordering the results of the request.
Location : query
HTTP Method : GET
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments
Path : v1/{+parent}/goldengateDeployments
▼ ▲ oracledatabase.projects.locations.goldengateDeployments.create
HTTP Method : POST
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Description : Required. The value for parent of the GoldengateDeployment in the following format: projects/{project}/locations/{location}.
Required : Yes
goldengateDeploymentId
Description : 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.
Location : query
Type : string
requestId
Type : string
Description : 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).
Location : query
Parameter Order : parent
Description : Creates a new GoldengateDeployment in a given project and location.
Path : v1/{+parent}/goldengateDeployments
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments
▼ ▲ oracledatabase.projects.locations.goldengateDeployments.start
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}:start
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:start
Description : Starts a single GoldengateDeployment.
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$
Required : Yes
Description : Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
Type : string
▼ ▲ oracledatabase.projects.locations.goldengateDeployments.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Gets details of a single GoldengateDeployment.
Parameter Order : name
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
▼ ▲ oracledatabase.projects.locations.goldengateDeployments.delete
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$
Location : path
Type : string
Description : Required. The name of the GoldengateDeployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
Required : Yes
requestId
Description : 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).
Location : query
Type : string
HTTP Method : DELETE
Description : Deletes a single GoldengateDeployment.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}
▼ ▲ oracledatabase.projects.locations.goldengateDeployments.stop
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeployments/[^/]+$
Description : Required. The name of the Goldengate Deployment in the following format: projects/{project}/locations/{location}/goldengateDeployments/{goldengate_deployment}.
Required : Yes
Type : string
Description : Stops a single GoldengateDeployment.
Path : v1/{+name}:stop
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeployments/{goldengateDeploymentsId}:stop
▼ ▲ oracledatabase.projects.locations.goldengateDeploymentVersions.get
Parameter Order : name
HTTP Method : GET
Parameters :
name
Description : Required. The name of the GoldengateDeploymentVersion to retrieve. Format: projects/{project}/locations/{location}/goldengateDeploymentVersions/{goldengate_deployment_version}
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeploymentVersions/[^/]+$
Description : Gets details of a single GoldengateDeploymentVersion.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentVersions/{goldengateDeploymentVersionsId}
▼ ▲ oracledatabase.projects.locations.goldengateDeploymentVersions.list
Description : Lists GoldengateDeploymentVersions in a given project and location.
Parameter Order : parent
HTTP Method : GET
Parameters :
parent
Description : Required. Parent value for ListGoldengateDeploymentVersionsRequest Format: projects/{project}/locations/{location}
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Type : integer
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
filter
Description : Optional. An expression for filtering the results of the request. Either the deployment_id and deployment_type fields must be specified in the format: `deployment_id="id"` or `deployment_type="DATABASE_ORACLE"`.
Location : query
Type : string
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentVersions
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/goldengateDeploymentVersions
▼ ▲ oracledatabase.projects.locations.goldengateConnectionTypes.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionTypes/{goldengateConnectionTypesId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Gets details of a single GoldengateConnectionType.
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateConnectionTypes/[^/]+$
Required : Yes
Description : Required. Name of the resource in the format: projects/{project}/locations/{location}/goldengateConnectionTypes/{goldengate_connection_type}
Type : string
HTTP Method : GET
▼ ▲ oracledatabase.projects.locations.goldengateConnectionTypes.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionTypes
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/goldengateConnectionTypes
Description : Lists GoldengateConnectionTypes in a given project and location.
Parameter Order : parent
HTTP Method : GET
Parameters :
pageToken
Type : string
Description : Optional. A token identifying a page of results the server should return.
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. Parent value for ListGoldengateConnectionTypesRequest Format: projects/{project}/locations/{location}
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Format : int32
Type : integer
filter
Type : string
Description : Optional. An expression for filtering the results of the request. The connection_type field must be specified in the format: `connection_type="ORACLE"`.
Location : query
▼ ▲ oracledatabase.projects.locations.goldengateConnectionAssignments.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Description : Deletes a single GoldengateConnectionAssignment.
Parameter Order : name
Parameters :
name
Type : string
Description : Required. The name of the GoldengateConnectionAssignment to delete. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$
Location : path
requestId
Type : string
Description : 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).
Location : query
HTTP Method : DELETE
▼ ▲ oracledatabase.projects.locations.goldengateConnectionAssignments.get
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}
HTTP Method : GET
Parameters :
name
Type : string
Required : Yes
Description : Required. The name of the GoldengateConnectionAssignment to retrieve. Format: projects/{project}/locations/{location}/goldengateConnectionAssignments/{goldengate_connection_assignment}
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$
Location : path
Parameter Order : name
Description : Gets details of a single GoldengateConnectionAssignment.
▼ ▲ oracledatabase.projects.locations.goldengateConnectionAssignments.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/goldengateConnectionAssignments
Description : Lists GoldengateConnectionAssignments in a given project and location.
Parameter Order : parent
Parameters :
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "DESC" after a field name for descending.
Location : query
Type : string
pageSize
Description : 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.
Location : query
Format : int32
Type : integer
filter
Description : Optional. A filter expression that filters GoldengateConnectionAssignments listed in the response.
Location : query
Type : string
pageToken
Description : 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.
Location : query
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. The parent value for the GoldengateConnectionAssignments. Format: projects/{project}/locations/{location}
HTTP Method : GET
▼ ▲ oracledatabase.projects.locations.goldengateConnectionAssignments.create
Path : v1/{+parent}/goldengateConnectionAssignments
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments
HTTP Method : POST
Parameters :
parent
Type : string
Description : Required. The parent resource where this GoldengateConnectionAssignment will be created. Format: projects/{project}/locations/{location}
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
goldengateConnectionAssignmentId
Description : Required. The ID of the GoldengateConnectionAssignment to create.
Location : query
Type : string
requestId
Type : string
Description : 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).
Location : query
Parameter Order : parent
Description : Creates a new GoldengateConnectionAssignment in a given project and location.
▼ ▲ oracledatabase.projects.locations.goldengateConnectionAssignments.test
Parameter Order : name
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateConnectionAssignments/[^/]+$
Location : path
Type : string
Description : Required. Name of the connection assignment for which to test connection. projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}
Required : Yes
HTTP Method : POST
Description : Tests a single GoldengateConnectionAssignment.
Path : v1/{+name}:test
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnectionAssignments/{goldengateConnectionAssignmentsId}:test
▼ ▲ oracledatabase.projects.locations.goldengateDeploymentTypes.get
Description : Gets details of a single GoldenGateDeploymentType.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeploymentTypes/[^/]+$
Required : Yes
Description : Required. The name of the GoldengateDeploymentType to retrieve. Format: projects/{project}/locations/{location}/goldengateDeploymentTypes/{goldengate_deployment_type}
Type : string
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentTypes/{goldengateDeploymentTypesId}
Path : v1/{+name}
▼ ▲ oracledatabase.projects.locations.goldengateDeploymentTypes.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentTypes
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/goldengateDeploymentTypes
Description : Lists GoldenGateDeploymentTypes in a given project and location.
Parameter Order : parent
Parameters :
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource. Format: projects/{project}/locations/{location}
Type : string
orderBy
Type : string
Description : Optional. Hint for how to order the results
Location : query
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Format : int32
Type : integer
filter
Description : Optional. An expression for filtering the results of the request. Either the deployment_type and ogg_version fields must be specified in the format: `deployment_type="DATABASE_ORACLE"` or `ogg_version="version"`. Allowed values for deployment_type are: `DATABASE_ORACLE`, `BIGDATA`, `DATABASE_MICROSOFT_SQLSERVER`, `DATABASE_MYSQL`, `DATABASE_POSTGRESQL`, `DATABASE_DB2ZOS`, `DATABASE_DB2I`, `GGSA`, `DATA_TRANSFORMS`.
Location : query
Type : string
HTTP Method : GET
▼ ▲ oracledatabase.projects.locations.goldengateDeploymentEnvironments.get
Parameters :
name
Description : Required. Name of the resource with the format: projects/{project}/locations/{location}/goldengateDeploymentEnvironments/{goldengate_deployment_environment}
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateDeploymentEnvironments/[^/]+$
HTTP Method : GET
Parameter Order : name
Description : Gets details of a single GoldengateDeploymentEnvironment.
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentEnvironments/{goldengateDeploymentEnvironmentsId}
▼ ▲ oracledatabase.projects.locations.goldengateDeploymentEnvironments.list
Parameter Order : parent
Parameters :
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
parent
Required : Yes
Description : Required. The parent, which owns this collection of GoldengateDeploymentEnvironments. Format: projects/{project}/locations/{location}
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Type : integer
Format : int32
Description : Optional. The maximum number of items to return. If unspecified, at most 50 deployment environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
HTTP Method : GET
Description : Lists GoldengateDeploymentEnvironments in a given project and location.
Path : v1/{+parent}/goldengateDeploymentEnvironments
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateDeploymentEnvironments
▼ ▲ oracledatabase.projects.locations.goldengateConnections.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/goldengateConnections
Description : Lists all the GoldengateConnections for the given project and location.
Parameter Order : parent
Parameters :
orderBy
Type : string
Description : Optional. An expression for ordering the results of the request.
Location : query
pageSize
Description : Optional. The maximum number of items to return. If unspecified, at most 50 GoldengateConnections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
filter
Description : Optional. An expression for filtering the results of the request.
Location : query
Type : string
pageToken
Type : string
Description : Optional. A page token, received from a previous ListGoldengateConnections call. Provide this to retrieve the subsequent page.
Location : query
parent
Description : Required. The parent value for GoldengateConnections in the following format: projects/{project}/locations/{location}.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
HTTP Method : GET
▼ ▲ oracledatabase.projects.locations.goldengateConnections.create
Path : v1/{+parent}/goldengateConnections
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Parameters :
goldengateConnectionId
Description : Required. The ID of the GoldengateConnection 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.
Location : query
Type : string
requestId
Type : string
Description : 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).
Location : query
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The value for parent of the GoldengateConnection in the following format: projects/{project}/locations/{location}.
Type : string
HTTP Method : POST
Description : Creates a new GoldengateConnection in a given project and location.
▼ ▲ oracledatabase.projects.locations.goldengateConnections.get
Description : Gets details of a single GoldengateConnection.
HTTP Method : GET
Parameters :
name
Type : string
Description : Required. The name of the GoldengateConnection in the following format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateConnections/[^/]+$
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections/{goldengateConnectionsId}
Path : v1/{+name}
▼ ▲ oracledatabase.projects.locations.goldengateConnections.delete
Description : Deletes a single GoldengateConnection.
Parameter Order : name
HTTP Method : DELETE
Parameters :
requestId
Description : 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).
Location : query
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/goldengateConnections/[^/]+$
Location : path
Type : string
Description : Required. The name of the GoldengateConnection in the following format: projects/{project}/locations/{location}/goldengateConnections/{goldengate_connection}.
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/goldengateConnections/{goldengateConnectionsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}