{ "protocol": "rest", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "id": "datastream:v1", "ownerDomain": "google.com", "kind": "discovery#restDescription", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/datastream/", "name": "datastream", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "id": "datastream.projects.locations.list", "parameters": { "filter": { "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "pageToken": { "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query" }, "name": { "pattern": "^projects/[^/]+$", "description": "The resource that owns the locations collection, if applicable.", "location": "path", "required": true, "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "path": "v1/{+name}/locations" }, "get": { "path": "v1/{+name}", "description": "Gets information about a location.", "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Resource name for the location.", "location": "path", "required": true, "type": "string" } }, "id": "datastream.projects.locations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET" }, "fetchStaticIps": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:fetchStaticIps", "httpMethod": "GET", "id": "datastream.projects.locations.fetchStaticIps", "parameters": { "pageSize": { "description": "Optional. Maximum number of Ips to return, will likely not be specified.", "location": "query", "type": "integer", "format": "int32" }, "name": { "description": "Required. The resource name for the location for which static IPs should be returned. Must be in the format `projects/*/locations/*`.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `ListStaticIps` call. will likely not be specified.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "FetchStaticIpsResponse" }, "description": "The FetchStaticIps API call exposes the static IP addresses used by Datastream.", "path": "v1/{+name}:fetchStaticIps" } }, "resources": { "operations": { "methods": { "get": { "path": "v1/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource.", "location": "path", "required": true } }, "id": "datastream.projects.locations.operations.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "id": "datastream.projects.locations.operations.list", "parameters": { "pageToken": { "type": "string", "description": "The standard list page token.", "location": "query" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "type": "integer", "format": "int32", "description": "The standard list page size.", "location": "query" }, "returnPartialSuccess": { "type": "boolean", "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query" }, "name": { "description": "The name of the operation's parent resource.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1/{+name}/operations" }, "delete": { "path": "v1/{+name}", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "type": "string" } }, "id": "datastream.projects.locations.operations.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "request": { "$ref": "CancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "datastream.projects.locations.operations.cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true, "type": "string" } } } } }, "privateConnections": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListPrivateConnectionsResponse" }, "description": "Use this method to list private connectivity configurations in a project and location.", "path": "v1/{+parent}/privateConnections", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", "httpMethod": "GET", "id": "datastream.projects.locations.privateConnections.list", "parameters": { "pageSize": { "description": "Maximum number of private connectivity configurations to return. If unspecified, at most 50 private connectivity configurations that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "description": "Optional. Order by fields for the result.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent that owns the collection of private connectivity configurations.", "location": "path", "required": true, "type": "string" }, "filter": { "description": "Optional. Filter request.", "location": "query", "type": "string" } } }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/privateConnections", "request": { "$ref": "PrivateConnection" }, "description": "Use this method to create a private connectivity configuration.", "id": "datastream.projects.locations.privateConnections.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", "httpMethod": "POST", "parameters": { "validateOnly": { "type": "boolean", "description": "Optional. When supplied with PSC Interface config, will get/create the tenant project required for the customer to allow list and won't actually create the private connection.", "location": "query" }, "privateConnectionId": { "description": "Required. The private connectivity identifier.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent that owns the collection of PrivateConnections.", "location": "path", "required": true, "type": "string" }, "requestId": { "type": "string", "description": "Optional. A 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" }, "force": { "description": "Optional. If set to true, will skip validations.", "location": "query", "type": "boolean" } } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", "httpMethod": "GET", "id": "datastream.projects.locations.privateConnections.get", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "description": "Required. The name of the private connectivity configuration to get.", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "PrivateConnection" }, "description": "Use this method to get details about a private connectivity configuration.", "path": "v1/{+name}" }, "delete": { "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "description": "Required. The name of the private connectivity configuration to delete.", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. A 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", "type": "string" }, "force": { "description": "Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.", "location": "query", "type": "boolean" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", "httpMethod": "DELETE", "id": "datastream.projects.locations.privateConnections.delete", "description": "Use this method to delete a private connectivity configuration.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" } } }, "resources": { "routes": { "methods": { "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "description": "Use this method to delete a route.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}", "httpMethod": "DELETE", "id": "datastream.projects.locations.privateConnections.routes.delete", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+/routes/[^/]+$", "description": "Required. The name of the Route resource to delete.", "location": "path", "required": true, "type": "string" }, "requestId": { "type": "string", "description": "Optional. A 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" } } }, "list": { "id": "datastream.projects.locations.privateConnections.routes.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes", "httpMethod": "GET", "parameters": { "filter": { "type": "string", "description": "Optional. Filter request.", "location": "query" }, "parent": { "description": "Required. The parent that owns the collection of Routess.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "type": "string" }, "pageToken": { "description": "Optional. Page token received from a previous `ListRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRoutes` must match the call that provided the page token.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Order by fields for the result.", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. Maximum number of Routes to return. The service may return fewer than this value. If unspecified, at most 50 Routes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRoutesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/routes", "description": "Use this method to list routes created for a private connectivity configuration in a project and location." }, "create": { "id": "datastream.projects.locations.privateConnections.routes.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes", "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "description": "Required. The parent that owns the collection of Routes.", "location": "path", "required": true }, "routeId": { "description": "Required. The Route identifier.", "location": "query", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A 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" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/routes", "request": { "$ref": "Route" }, "description": "Use this method to create a route for a private connectivity configuration in a project and location." }, "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Route" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Use this method to get details about a route.", "id": "datastream.projects.locations.privateConnections.routes.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Route resource to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+/routes/[^/]+$", "type": "string" } } } } } } }, "connectionProfiles": { "methods": { "delete": { "id": "datastream.projects.locations.connectionProfiles.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "description": "Required. The name of the connection profile resource to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$" }, "requestId": { "description": "Optional. A 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", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Use this method to delete a connection profile." }, "discover": { "parameterOrder": [ "parent" ], "response": { "$ref": "DiscoverConnectionProfileResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/connectionProfiles:discover", "request": { "$ref": "DiscoverConnectionProfileRequest" }, "description": "Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.", "id": "datastream.projects.locations.connectionProfiles.discover", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles:discover", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the connection profile type. Must be in the format `projects/*/locations/*`.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } } }, "create": { "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/connectionProfiles", "request": { "$ref": "ConnectionProfile" }, "description": "Use this method to create a connection profile in a project and location.", "id": "datastream.projects.locations.connectionProfiles.create", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles", "httpMethod": "POST", "parameters": { "connectionProfileId": { "type": "string", "description": "Required. The connection profile identifier.", "location": "query" }, "validateOnly": { "description": "Optional. Only validate the connection profile, but don't create any resources. The default is false.", "location": "query", "type": "boolean" }, "requestId": { "type": "string", "description": "Optional. A 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" }, "force": { "description": "Optional. Create the connection profile without validating it.", "location": "query", "type": "boolean" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent that owns the collection of ConnectionProfiles.", "location": "path", "required": true } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "ListConnectionProfilesResponse" }, "description": "Use this method to list connection profiles created in a project and location.", "path": "v1/{+parent}/connectionProfiles", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles", "httpMethod": "GET", "id": "datastream.projects.locations.connectionProfiles.list", "parameters": { "orderBy": { "type": "string", "description": "Optional. Order by fields for the result.", "location": "query" }, "pageSize": { "description": "Optional. Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "type": "string", "description": "Optional. Filter request.", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent that owns the collection of connection profiles.", "location": "path", "required": true }, "pageToken": { "type": "string", "description": "Optional. Page token received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.", "location": "query" } } }, "get": { "description": "Use this method to get details about a connection profile.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "ConnectionProfile" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", "description": "Required. The name of the connection profile resource to get.", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "httpMethod": "GET", "id": "datastream.projects.locations.connectionProfiles.get" }, "patch": { "path": "v1/{+name}", "request": { "$ref": "ConnectionProfile" }, "description": "Use this method to update the parameters of a connection profile.", "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "force": { "description": "Optional. Update the connection profile without validating it.", "location": "query", "type": "boolean" }, "requestId": { "type": "string", "description": "Optional. A 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" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "description": "Output only. Identifier. The resource's name.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", "type": "string" }, "validateOnly": { "description": "Optional. Only validate the connection profile, but don't update any resources. The default is false.", "location": "query", "type": "boolean" } }, "id": "datastream.projects.locations.connectionProfiles.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "httpMethod": "PATCH" } } }, "streams": { "methods": { "list": { "path": "v1/{+parent}/streams", "description": "Use this method to list streams in a project and location.", "parameterOrder": [ "parent" ], "response": { "$ref": "ListStreamsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageSize": { "description": "Optional. Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "orderBy": { "type": "string", "description": "Optional. Order by fields for the result.", "location": "query" }, "pageToken": { "description": "Optional. Page token received from a previous `ListStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreams` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent that owns the collection of streams.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "description": "Optional. Filter request.", "location": "query" } }, "id": "datastream.projects.locations.streams.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams", "httpMethod": "GET" }, "get": { "description": "Use this method to get details about a stream.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Stream" }, "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "description": "Required. The name of the stream resource to get.", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}", "httpMethod": "GET", "id": "datastream.projects.locations.streams.get" }, "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}", "httpMethod": "PATCH", "id": "datastream.projects.locations.streams.patch", "parameters": { "updateMask": { "type": "string", "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query" }, "name": { "description": "Output only. Identifier. The stream's name.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "type": "string" }, "validateOnly": { "type": "boolean", "description": "Optional. Only validate the stream with the changes, without actually updating it. The default is false.", "location": "query" }, "requestId": { "description": "Optional. A 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", "type": "string" }, "force": { "type": "boolean", "description": "Optional. Update the stream without validating it.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "request": { "$ref": "Stream" }, "description": "Use this method to update the configuration of a stream.", "path": "v1/{+name}" }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "description": "Use this method to delete a stream.", "id": "datastream.projects.locations.streams.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}", "httpMethod": "DELETE", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "description": "Required. The name of the stream resource to delete.", "location": "path", "required": true }, "requestId": { "description": "Optional. A 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", "type": "string" } } }, "run": { "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:run", "request": { "$ref": "RunStreamRequest" }, "description": "Use this method to start, resume or recover a stream with a non default CDC strategy.", "id": "datastream.projects.locations.streams.run", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}:run", "httpMethod": "POST", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "description": "Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name}", "location": "path", "required": true, "type": "string" } } }, "create": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams", "httpMethod": "POST", "id": "datastream.projects.locations.streams.create", "parameters": { "streamId": { "type": "string", "description": "Required. The stream identifier.", "location": "query" }, "validateOnly": { "type": "boolean", "description": "Optional. Only validate the stream, but don't create any resources. The default is false.", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent that owns the collection of streams.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "force": { "type": "boolean", "description": "Optional. Create the stream without validating it.", "location": "query" }, "requestId": { "type": "string", "description": "Optional. A 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" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "Operation" }, "request": { "$ref": "Stream" }, "description": "Use this method to create a stream.", "path": "v1/{+parent}/streams" } }, "resources": { "objects": { "methods": { "lookup": { "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "description": "Required. The parent stream that owns the collection of objects.", "location": "path", "required": true } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects:lookup", "httpMethod": "POST", "id": "datastream.projects.locations.streams.objects.lookup", "request": { "$ref": "LookupStreamObjectRequest" }, "description": "Use this method to look up a stream object by its source object identifier.", "path": "v1/{+parent}/objects:lookup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "response": { "$ref": "StreamObject" } }, "stopBackfillJob": { "parameterOrder": [ "object" ], "response": { "$ref": "StopBackfillJobResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+object}:stopBackfillJob", "request": { "$ref": "StopBackfillJobRequest" }, "description": "Use this method to stop a backfill job for the specified stream object.", "id": "datastream.projects.locations.streams.objects.stopBackfillJob", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:stopBackfillJob", "httpMethod": "POST", "parameters": { "object": { "type": "string", "description": "Required. The name of the stream object resource to stop the backfill job for.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$" } } }, "list": { "parameterOrder": [ "parent" ], "response": { "$ref": "ListStreamObjectsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/objects", "description": "Use this method to list the objects of a specific stream.", "id": "datastream.projects.locations.streams.objects.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects", "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "format": "int32", "description": "Optional. Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" }, "pageToken": { "type": "string", "description": "Optional. Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreamObjectsRequest` must match the call that provided the page token.", "location": "query" }, "parent": { "type": "string", "description": "Required. The parent stream that owns the collection of objects.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$" } } }, "get": { "parameters": { "name": { "description": "Required. The name of the stream object resource to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}", "httpMethod": "GET", "id": "datastream.projects.locations.streams.objects.get", "description": "Use this method to get details about a stream object.", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "response": { "$ref": "StreamObject" } }, "startBackfillJob": { "parameterOrder": [ "object" ], "response": { "$ref": "StartBackfillJobResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+object}:startBackfillJob", "request": { "$ref": "StartBackfillJobRequest" }, "description": "Use this method to start a backfill job for the specified stream object.", "id": "datastream.projects.locations.streams.objects.startBackfillJob", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:startBackfillJob", "httpMethod": "POST", "parameters": { "object": { "type": "string", "description": "Required. The name of the stream object resource to start a backfill job for.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$" } } } } } } } } } } } }, "title": "Datastream API", "baseUrl": "https://datastream.googleapis.com/", "schemas": { "SqlServerSourceConfig": { "type": "object", "properties": { "maxConcurrentBackfillTasks": { "type": "integer", "format": "int32", "description": "Max concurrent backfill tasks." }, "changeTables": { "description": "CDC reader reads from change tables.", "$ref": "SqlServerChangeTables" }, "includeObjects": { "description": "The SQLServer objects to include in the stream.", "$ref": "SqlServerRdbms" }, "transactionLogs": { "description": "CDC reader reads from transaction logs.", "$ref": "SqlServerTransactionLogs" }, "excludeObjects": { "$ref": "SqlServerRdbms", "description": "The SQLServer objects to exclude from the stream." }, "maxConcurrentCdcTasks": { "description": "Max concurrent CDC tasks.", "type": "integer", "format": "int32" } }, "description": "Configuration for syncing data from a SQLServer source.", "id": "SqlServerSourceConfig" }, "EncryptionNotEnforced": { "id": "EncryptionNotEnforced", "type": "object", "properties": {}, "description": "Message to represent the option where encryption is not enforced. An empty message right now to allow future extensibility." }, "StreamLargeObjects": { "description": "Configuration to stream large object values.", "type": "object", "properties": {}, "id": "StreamLargeObjects" }, "PostgresqlSslConfig": { "id": "PostgresqlSslConfig", "type": "object", "properties": { "serverVerification": { "$ref": "ServerVerification", "description": " If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated." }, "serverAndClientVerification": { "description": "If this field is set, the communication will be encrypted with TLS encryption and both the server identity and the client identity will be authenticated.", "$ref": "ServerAndClientVerification" } }, "description": "PostgreSQL SSL configuration information." }, "SqlServerSslConfig": { "id": "SqlServerSslConfig", "type": "object", "properties": { "encryptionNotEnforced": { "description": "If set, Datastream will not enforce encryption. If the DB server mandates encryption, then connection will be encrypted but server identity will not be authenticated.", "$ref": "EncryptionNotEnforced" }, "basicEncryption": { "$ref": "BasicEncryption", "description": "If set, Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default." }, "encryptionAndServerValidation": { "description": "If set, Datastream will enforce encryption and authenticate server identity.", "$ref": "EncryptionAndServerValidation" } }, "description": "SQL Server SSL configuration information." }, "SpecificStartPosition": { "id": "SpecificStartPosition", "type": "object", "properties": { "oracleScnPosition": { "$ref": "OracleScnPosition", "description": "Oracle SCN to start replicating from." }, "mysqlGtidPosition": { "$ref": "MysqlGtidPosition", "description": "MySQL GTID set to start replicating from." }, "mysqlLogPosition": { "description": "MySQL specific log position to start replicating from.", "$ref": "MysqlLogPosition" }, "sqlServerLsnPosition": { "description": "SqlServer LSN to start replicating from.", "$ref": "SqlServerLsnPosition" }, "mongodbChangeStreamPosition": { "description": "MongoDB change stream position to start replicating from.", "$ref": "MongodbChangeStreamPosition" }, "spannerChangeStreamPosition": { "description": "Optional. Spanner change stream position to start replicating from.", "$ref": "SpannerChangeStreamPosition" } }, "description": "CDC strategy to start replicating from a specific position in the source." }, "ListConnectionProfilesResponse": { "type": "object", "properties": { "connectionProfiles": { "description": "List of connection profiles.", "type": "array", "items": { "$ref": "ConnectionProfile" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "description": "Response message for listing connection profiles.", "id": "ListConnectionProfilesResponse" }, "Secret": { "id": "Secret", "description": "A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager.", "type": "object", "properties": { "rawValue": { "description": "Optional. Input only. The actual raw value of the secret as plain text.", "type": "string" }, "secretVersion": { "type": "string", "description": "Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats: * projects/{project}/locations/{location}/secrets/{secret}/versions/{version} * projects/{project}/secrets/{secret}/versions/{version}" } } }, "ForwardSshTunnelConnectivity": { "id": "ForwardSshTunnelConnectivity", "type": "object", "properties": { "port": { "description": "Port for the SSH tunnel, default value is 22.", "type": "integer", "format": "int32" }, "password": { "description": "Input only. SSH password.", "type": "string" }, "username": { "description": "Required. Username for the SSH tunnel.", "type": "string" }, "hostname": { "description": "Required. Hostname for the SSH tunnel.", "type": "string" }, "privateKey": { "description": "Input only. SSH private key.", "type": "string" } }, "description": "Forward SSH Tunnel connectivity." }, "MongodbField": { "id": "MongodbField", "description": "MongoDB Field.", "type": "object", "properties": { "field": { "description": "The field name.", "type": "string" } } }, "Route": { "id": "Route", "description": "The route resource is the child of the private connection resource, used for defining a route for a private connection.", "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels." }, "createTime": { "readOnly": true, "description": "Output only. The create time of the resource.", "type": "string", "format": "google-datetime" }, "displayName": { "description": "Required. Display name.", "type": "string" }, "destinationAddress": { "type": "string", "description": "Required. Destination address for connection" }, "destinationPort": { "description": "Destination port for connection", "type": "integer", "format": "int32" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The resource's name." }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The update time of the resource." } } }, "StartBackfillJobResponse": { "id": "StartBackfillJobResponse", "type": "object", "properties": { "object": { "description": "The stream object resource a backfill job was started for.", "$ref": "StreamObject" } }, "description": "Response for manually initiating a backfill job for a specific stream object." }, "SalesforceField": { "description": "Salesforce field.", "type": "object", "properties": { "dataType": { "description": "The data type.", "type": "string" }, "name": { "description": "The field name.", "type": "string" }, "nillable": { "description": "Indicates whether the field can accept nil values.", "type": "boolean" } }, "id": "SalesforceField" }, "RetryInfo": { "id": "RetryInfo", "description": "Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses. It's always recommended that clients should use exponential backoff when retrying. Clients should wait until `retry_delay` amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on `retry_delay`, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.", "type": "object", "properties": { "retryDelay": { "description": "Clients should wait at least this long between retrying the same request.", "type": "string", "format": "google-duration" } } }, "LogMiner": { "id": "LogMiner", "type": "object", "properties": {}, "description": "Configuration to use LogMiner CDC method." }, "Merge": { "id": "Merge", "type": "object", "properties": {}, "description": "Merge mode defines that all changes to a table will be merged at the destination table." }, "PostgresqlTable": { "id": "PostgresqlTable", "description": "PostgreSQL table.", "type": "object", "properties": { "table": { "description": "The table name.", "type": "string" }, "postgresqlColumns": { "type": "array", "items": { "$ref": "PostgresqlColumn" }, "description": "PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything." } } }, "MostRecentStartPosition": { "id": "MostRecentStartPosition", "type": "object", "properties": {}, "description": "CDC strategy to start replicating from the most recent position in the source." }, "DropLargeObjects": { "id": "DropLargeObjects", "type": "object", "properties": {}, "description": "Configuration to drop large object values." }, "MongodbChangeStreamPosition": { "id": "MongodbChangeStreamPosition", "description": "MongoDB change stream position", "type": "object", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "Required. The timestamp to start change stream from." } } }, "StopBackfillJobRequest": { "type": "object", "properties": {}, "description": "Request for manually stopping a running backfill job for a specific stream object.", "id": "StopBackfillJobRequest" }, "SpannerSchema": { "description": "Spanner schema.", "type": "object", "properties": { "tables": { "description": "Optional. Spanner tables in the schema.", "type": "array", "items": { "$ref": "SpannerTable" } }, "schema": { "type": "string", "description": "Required. The schema name." } }, "id": "SpannerSchema" }, "OracleSourceConfig": { "id": "OracleSourceConfig", "description": "Configuration for syncing data from an Oracle source.", "type": "object", "properties": { "logMiner": { "$ref": "LogMiner", "description": "Use LogMiner." }, "includeObjects": { "description": "The Oracle objects to include in the stream.", "$ref": "OracleRdbms" }, "streamLargeObjects": { "$ref": "StreamLargeObjects", "description": "Stream large object values." }, "excludeObjects": { "$ref": "OracleRdbms", "description": "The Oracle objects to exclude from the stream." }, "maxConcurrentCdcTasks": { "type": "integer", "format": "int32", "description": "Maximum number of concurrent CDC tasks. The number should be non-negative. If not set (or set to 0), the system's default value is used." }, "maxConcurrentBackfillTasks": { "description": "Maximum number of concurrent backfill tasks. The number should be non-negative. If not set (or set to 0), the system's default value is used.", "type": "integer", "format": "int32" }, "binaryLogParser": { "description": "Use Binary Log Parser.", "$ref": "BinaryLogParser" }, "dropLargeObjects": { "$ref": "DropLargeObjects", "description": "Drop large object values." } } }, "UserPasswordCredentials": { "id": "UserPasswordCredentials", "description": "User-password credentials.", "type": "object", "properties": { "username": { "description": "Required. Username for the connection.", "type": "string" }, "password": { "$ref": "Secret", "description": "Required. Password for the connection." } } }, "ListPrivateConnectionsResponse": { "id": "ListPrivateConnectionsResponse", "description": "Response containing a list of private connection configurations.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "privateConnections": { "type": "array", "items": { "$ref": "PrivateConnection" }, "description": "List of private connectivity configurations." }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "SqlServerSchema": { "description": "SQLServer schema.", "type": "object", "properties": { "schema": { "type": "string", "description": "The schema name." }, "tables": { "type": "array", "items": { "$ref": "SqlServerTable" }, "description": "Tables in the schema." } }, "id": "SqlServerSchema" }, "OperationMetadata": { "id": "OperationMetadata", "type": "object", "properties": { "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "format": "google-datetime", "readOnly": true }, "requestedCancellation": { "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "apiVersion": { "description": "Output only. API version used to start the operation.", "type": "string", "readOnly": true }, "validationResult": { "$ref": "ValidationResult", "readOnly": true, "description": "Output only. Results of executed validations if there are any." }, "endTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running.", "readOnly": true }, "target": { "readOnly": true, "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string" } }, "description": "Represents the metadata of the long-running operation." }, "ListOperationsResponse": { "id": "ListOperationsResponse", "type": "object", "properties": { "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } }, "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." } }, "description": "The response message for Operations.ListOperations." }, "SingleTargetDataset": { "id": "SingleTargetDataset", "description": "A single target dataset to which all data will be streamed.", "type": "object", "properties": { "datasetId": { "description": "The dataset ID of the target dataset. DatasetIds allowed characters: https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference.", "type": "string" } } }, "OracleRdbms": { "type": "object", "properties": { "oracleSchemas": { "type": "array", "items": { "$ref": "OracleSchema" }, "description": "Oracle schemas/databases in the database server." } }, "description": "Oracle database structure.", "id": "OracleRdbms" }, "SqlServerColumn": { "type": "object", "properties": { "column": { "description": "The column name.", "type": "string" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "ordinalPosition": { "description": "The ordinal position of the column in the table.", "type": "integer", "format": "int32" }, "length": { "type": "integer", "format": "int32", "description": "Column length." }, "precision": { "type": "integer", "format": "int32", "description": "Column precision." }, "scale": { "type": "integer", "format": "int32", "description": "Column scale." }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "dataType": { "description": "The SQLServer data type.", "type": "string" } }, "description": "SQLServer Column.", "id": "SqlServerColumn" }, "MysqlSslConfig": { "description": "MySQL SSL configuration information.", "type": "object", "properties": { "clientKeySet": { "type": "boolean", "description": "Output only. Indicates whether the client_key field is set.", "readOnly": true }, "caCertificate": { "type": "string", "description": "Input only. PEM-encoded certificate of the CA that signed the source database server's certificate." }, "clientKey": { "type": "string", "description": "Optional. Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory." }, "clientCertificate": { "description": "Optional. Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.", "type": "string" }, "caCertificateSet": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the ca_certificate field is set." }, "clientCertificateSet": { "readOnly": true, "description": "Output only. Indicates whether the client_certificate field is set.", "type": "boolean" } }, "id": "MysqlSslConfig" }, "SrvConnectionFormat": { "id": "SrvConnectionFormat", "description": "Srv connection format.", "type": "object", "properties": {} }, "Gtid": { "id": "Gtid", "description": "Use GTID based replication.", "type": "object", "properties": {} }, "CustomizationRule": { "id": "CustomizationRule", "description": "A customization rule to apply to a set of objects.", "type": "object", "properties": { "bigqueryPartitioning": { "description": "BigQuery partitioning rule.", "$ref": "BigQueryPartitioning" }, "bigqueryClustering": { "$ref": "BigQueryClustering", "description": "BigQuery clustering rule." } } }, "SalesforceMarketingCloudProfile": { "id": "SalesforceMarketingCloudProfile", "description": "Profile for connecting to a Salesforce Marketing Cloud source.", "type": "object", "properties": { "subdomain": { "description": "Required. Subdomain for the Salesforce Marketing Cloud connection. Example: if your specific endpoint is `https://{your-specific-subdomain}.rest.marketingcloudapis.com/`, the subdomain is `{your-specific-subdomain}`. Must be 1-63 characters, start and end with an alphanumeric character, and contain only lowercase letters, numbers, and hyphens (-).", "type": "string" }, "oauthClientCredentials": { "$ref": "OauthClientCredentials", "description": "Required. Input only. Credentials for authenticating with the Salesforce Marketing Cloud API." } } }, "SalesforceObject": { "description": "Salesforce object.", "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "SalesforceField" }, "description": "Salesforce fields. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing." }, "objectName": { "type": "string", "description": "The object name." } }, "id": "SalesforceObject" }, "BinaryLogParser": { "id": "BinaryLogParser", "type": "object", "properties": { "oracleAsmLogFileAccess": { "$ref": "OracleAsmLogFileAccess", "description": "Use Oracle ASM." }, "logFileDirectories": { "description": "Use Oracle directories.", "$ref": "LogFileDirectories" } }, "description": "Configuration to use Binary Log Parser CDC technique." }, "OracleSslConfig": { "id": "OracleSslConfig", "description": "Oracle SSL configuration information.", "type": "object", "properties": { "caCertificate": { "description": "Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.", "type": "string" }, "caCertificateSet": { "description": "Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile.", "type": "boolean", "readOnly": true }, "serverCertificateDistinguishedName": { "type": "string", "description": "Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced." } } }, "SqlServerRdbms": { "description": "SQLServer database structure.", "type": "object", "properties": { "schemas": { "type": "array", "items": { "$ref": "SqlServerSchema" }, "description": "SQLServer schemas in the database server." } }, "id": "SqlServerRdbms" }, "PreconditionFailureViolation": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, \"TOS\" for \"Terms of Service violation\"." }, "subject": { "type": "string", "description": "The subject, relative to the type, that failed. For example, \"google.com/cloud\" relative to the \"TOS\" type would indicate which terms of service is being referenced." }, "description": { "type": "string", "description": "A description of how the precondition failed. Developers can use this description to understand how to fix the failure. For example: \"Terms of service not accepted\"." } }, "description": "A message type used to describe a single precondition failure.", "id": "PreconditionFailureViolation" }, "SourceConfig": { "id": "SourceConfig", "description": "The configuration of the stream source.", "type": "object", "properties": { "spannerSourceConfig": { "$ref": "SpannerSourceConfig", "description": "Spanner data source configuration." }, "sourceConnectionProfile": { "type": "string", "description": "Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`" }, "postgresqlSourceConfig": { "$ref": "PostgresqlSourceConfig", "description": "PostgreSQL data source configuration." }, "mysqlSourceConfig": { "description": "MySQL data source configuration.", "$ref": "MysqlSourceConfig" }, "serviceNowSourceConfig": { "description": "ServiceNow data source configuration.", "$ref": "ServiceNowSourceConfig" }, "salesforceSourceConfig": { "$ref": "SalesforceSourceConfig", "description": "Salesforce data source configuration." }, "dataverseSourceConfig": { "$ref": "DataverseSourceConfig", "description": "Dataverse data source configuration." }, "mongodbSourceConfig": { "description": "MongoDB data source configuration.", "$ref": "MongodbSourceConfig" }, "sqlServerSourceConfig": { "description": "SQLServer data source configuration.", "$ref": "SqlServerSourceConfig" }, "oracleSourceConfig": { "description": "Oracle data source configuration.", "$ref": "OracleSourceConfig" }, "salesforceMarketingCloudSourceConfig": { "$ref": "SalesforceMarketingCloudSourceConfig", "description": "Salesforce Marketing Cloud data source configuration." } } }, "PostgresqlObjectIdentifier": { "type": "object", "properties": { "table": { "type": "string", "description": "Required. The table name." }, "schema": { "description": "Required. The schema name.", "type": "string" } }, "description": "PostgreSQL data source object identifier.", "id": "PostgresqlObjectIdentifier" }, "OracleScnPosition": { "description": "Oracle SCN position", "type": "object", "properties": { "scn": { "type": "string", "format": "int64", "description": "Required. SCN number from where Logs will be read" } }, "id": "OracleScnPosition" }, "ListLocationsResponse": { "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse" }, "Status": { "id": "Status", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "type": "string", "description": "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." }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "description": "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)." }, "DiscoverConnectionProfileResponse": { "id": "DiscoverConnectionProfileResponse", "description": "Response from a discover request.", "type": "object", "properties": { "sqlServerRdbms": { "$ref": "SqlServerRdbms", "description": "Enriched SQLServer RDBMS object." }, "mongodbCluster": { "description": "Enriched MongoDB cluster.", "$ref": "MongodbCluster" }, "sourceCatalog": { "description": "Enriched source catalog. This is mainly used to represent SaaS sources databases.", "$ref": "SourceCatalog" }, "mysqlRdbms": { "description": "Enriched MySQL RDBMS object.", "$ref": "MysqlRdbms" }, "postgresqlRdbms": { "$ref": "PostgresqlRdbms", "description": "Enriched PostgreSQL RDBMS object." }, "salesforceOrg": { "$ref": "SalesforceOrg", "description": "Enriched Salesforce organization." }, "oracleRdbms": { "description": "Enriched Oracle RDBMS object.", "$ref": "OracleRdbms" }, "spannerDatabase": { "$ref": "SpannerDatabase", "description": "Enriched Spanner database." } } }, "BlmtConfig": { "id": "BlmtConfig", "description": "The configuration for BLMT.", "type": "object", "properties": { "bucket": { "type": "string", "description": "Required. The Cloud Storage bucket name." }, "fileFormat": { "enum": [ "FILE_FORMAT_UNSPECIFIED", "PARQUET" ], "enumDescriptions": [ "Default value.", "Parquet file format." ], "type": "string", "description": "Required. The file format." }, "tableFormat": { "enum": [ "TABLE_FORMAT_UNSPECIFIED", "ICEBERG" ], "enumDescriptions": [ "Default value.", "Iceberg table format." ], "type": "string", "description": "Required. The table format." }, "rootPath": { "description": "The root path inside the Cloud Storage bucket.", "type": "string" }, "connectionName": { "description": "Required. The bigquery connection. Format: `{project}.{location}.{name}`", "type": "string" } } }, "SpannerDatabase": { "type": "object", "properties": { "schemas": { "description": "Optional. Spanner schemas in the database.", "type": "array", "items": { "$ref": "SpannerSchema" } } }, "description": "Spanner database structure.", "id": "SpannerDatabase" }, "BigQueryProfile": { "type": "object", "properties": {}, "description": "Profile for connecting to a BigQuery destination.", "id": "BigQueryProfile" }, "DiscoverConnectionProfileRequest": { "id": "DiscoverConnectionProfileRequest", "description": "Request message for 'discover' ConnectionProfile request.", "type": "object", "properties": { "mongodbCluster": { "$ref": "MongodbCluster", "description": "Optional. MongoDB cluster to enrich with child data objects and metadata." }, "sourceCatalog": { "description": "Optional. Source catalog to enrich with child data objects and metadata. This is mainly used to represent SaaS sources databases.", "$ref": "SourceCatalog" }, "hierarchyDepth": { "type": "integer", "format": "int32", "description": "Optional. The number of hierarchy levels below the current level to be retrieved." }, "mysqlRdbms": { "description": "Optional. MySQL RDBMS to enrich with child data objects and metadata.", "$ref": "MysqlRdbms" }, "postgresqlRdbms": { "$ref": "PostgresqlRdbms", "description": "Optional. PostgreSQL RDBMS to enrich with child data objects and metadata." }, "oracleRdbms": { "description": "Optional. Oracle RDBMS to enrich with child data objects and metadata.", "$ref": "OracleRdbms" }, "salesforceOrg": { "description": "Optional. Salesforce organization to enrich with child data objects and metadata.", "$ref": "SalesforceOrg" }, "sqlServerRdbms": { "description": "Optional. SQLServer RDBMS to enrich with child data objects and metadata.", "$ref": "SqlServerRdbms" }, "connectionProfileName": { "type": "string", "description": "Optional. A reference to an existing connection profile." }, "connectionProfile": { "description": "Optional. An ad-hoc connection profile configuration.", "$ref": "ConnectionProfile" }, "spannerDatabase": { "description": "Optional. Spanner database to enrich with child data objects and metadata.", "$ref": "SpannerDatabase" }, "fullHierarchy": { "type": "boolean", "description": "Optional. Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE)." } } }, "SpannerColumn": { "description": "Spanner column.", "type": "object", "properties": { "dataType": { "type": "string", "description": "Optional. Spanner data type." }, "ordinalPosition": { "type": "string", "format": "int64", "description": "Optional. The ordinal position of the column in the table." }, "isPrimaryKey": { "description": "Optional. Whether or not the column is a primary key.", "type": "boolean" }, "column": { "description": "Required. The column name.", "type": "string" } }, "id": "SpannerColumn" }, "OracleObjectIdentifier": { "id": "OracleObjectIdentifier", "description": "Oracle data source object identifier.", "type": "object", "properties": { "table": { "description": "Required. The table name.", "type": "string" }, "schema": { "type": "string", "description": "Required. The schema name." } } }, "Help": { "id": "Help", "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "Link" }, "description": "URL(s) pointing to additional information on handling the current error." } }, "description": "Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit." }, "OracleTable": { "id": "OracleTable", "description": "Oracle table.", "type": "object", "properties": { "table": { "type": "string", "description": "The table name." }, "oracleColumns": { "description": "Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.", "type": "array", "items": { "$ref": "OracleColumn" } } } }, "BasicEncryption": { "type": "object", "properties": {}, "description": "Message to represent the option where Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default.", "id": "BasicEncryption" }, "ObjectFilter": { "id": "ObjectFilter", "type": "object", "properties": { "sourceObjectIdentifier": { "$ref": "SourceObjectIdentifier", "description": "Specific source object identifier." } }, "description": "Object filter to apply the rules to." }, "SpannerChangeStreamPosition": { "type": "object", "properties": { "startTime": { "description": "Required. The timestamp to start change stream queries from. The timestamp must be a positive value.", "type": "string", "format": "google-datetime" } }, "description": "Represents a position in a Spanner change stream from which to start replicating.", "id": "SpannerChangeStreamPosition" }, "IngestionTimePartition": { "id": "IngestionTimePartition", "description": "Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time", "type": "object", "properties": { "partitioningTimeGranularity": { "enumDescriptions": [ "Unspecified partitioing interval.", "Hourly partitioning.", "Daily partitioning.", "Monthly partitioning.", "Yearly partitioning." ], "enum": [ "PARTITIONING_TIME_GRANULARITY_UNSPECIFIED", "PARTITIONING_TIME_GRANULARITY_HOUR", "PARTITIONING_TIME_GRANULARITY_DAY", "PARTITIONING_TIME_GRANULARITY_MONTH", "PARTITIONING_TIME_GRANULARITY_YEAR" ], "description": "Optional. Partition granularity", "type": "string" } } }, "SqlServerLsnPosition": { "description": "SQL Server LSN position", "type": "object", "properties": { "lsn": { "type": "string", "description": "Required. Log sequence number (LSN) from where Logs will be read" } }, "id": "SqlServerLsnPosition" }, "LookupStreamObjectRequest": { "type": "object", "properties": { "sourceObjectIdentifier": { "$ref": "SourceObjectIdentifier", "description": "Required. The source object identifier which maps to the stream object." } }, "description": "Request for looking up a specific stream object by its source object identifier.", "id": "LookupStreamObjectRequest" }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {}, "id": "Empty" }, "MongodbDatabase": { "id": "MongodbDatabase", "type": "object", "properties": { "database": { "description": "The database name.", "type": "string" }, "collections": { "type": "array", "items": { "$ref": "MongodbCollection" }, "description": "Collections in the database." } }, "description": "MongoDB Database." }, "SqlServerObjectIdentifier": { "id": "SqlServerObjectIdentifier", "type": "object", "properties": { "schema": { "description": "Required. The schema name.", "type": "string" }, "table": { "type": "string", "description": "Required. The table name." } }, "description": "SQLServer data source object identifier." }, "IntegerRangePartition": { "description": "Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range", "type": "object", "properties": { "interval": { "description": "Required. The interval of each range within the partition.", "type": "string", "format": "int64" }, "column": { "type": "string", "description": "Required. The partitioning column." }, "start": { "description": "Required. The starting value for range partitioning (inclusive).", "type": "string", "format": "int64" }, "end": { "description": "Required. The ending value for range partitioning (exclusive).", "type": "string", "format": "int64" } }, "id": "IntegerRangePartition" }, "GcsProfile": { "type": "object", "properties": { "bucket": { "type": "string", "description": "Required. The Cloud Storage bucket name." }, "rootPath": { "type": "string", "description": "Optional. The root path inside the Cloud Storage bucket." } }, "description": "Profile for connecting to a Cloud Storage destination.", "id": "GcsProfile" }, "OracleColumn": { "id": "OracleColumn", "type": "object", "properties": { "precision": { "type": "integer", "format": "int32", "description": "Column precision." }, "dataType": { "description": "The Oracle data type.", "type": "string" }, "encoding": { "type": "string", "description": "Column encoding." }, "nullable": { "type": "boolean", "description": "Whether or not the column can accept a null value." }, "scale": { "type": "integer", "format": "int32", "description": "Column scale." }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "length": { "description": "Column length.", "type": "integer", "format": "int32" }, "ordinalPosition": { "type": "integer", "format": "int32", "description": "The ordinal position of the column in the table." }, "column": { "description": "The column name.", "type": "string" } }, "description": "Oracle Column." }, "Validation": { "id": "Validation", "type": "object", "properties": { "description": { "type": "string", "description": "A short description of the validation." }, "message": { "type": "array", "items": { "$ref": "ValidationMessage" }, "description": "Messages reflecting the validation results." }, "state": { "enum": [ "STATE_UNSPECIFIED", "NOT_EXECUTED", "FAILED", "PASSED", "WARNING" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified state.", "Validation did not execute.", "Validation failed.", "Validation passed.", "Validation executed with warnings." ], "description": "Output only. Validation execution status." }, "code": { "type": "string", "description": "A custom code identifying this validation." } }, "description": "A validation to perform on a stream." }, "LocalizedMessage": { "type": "object", "properties": { "locale": { "type": "string", "description": "The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: \"en-US\", \"fr-CH\", \"es-MX\"" }, "message": { "type": "string", "description": "The localized error message in the above locale." } }, "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", "id": "LocalizedMessage" }, "JsonFileFormat": { "id": "JsonFileFormat", "description": "JSON file format configuration.", "type": "object", "properties": { "schemaFileFormat": { "enum": [ "SCHEMA_FILE_FORMAT_UNSPECIFIED", "NO_SCHEMA_FILE", "AVRO_SCHEMA_FILE" ], "enumDescriptions": [ "Unspecified schema file format.", "Do not attach schema file.", "Avro schema format." ], "type": "string", "description": "The schema file format along JSON data files." }, "compression": { "description": "Compression of the loaded JSON file.", "type": "string", "enumDescriptions": [ "Unspecified json file compression.", "Do not compress JSON file.", "Gzip compression." ], "enum": [ "JSON_COMPRESSION_UNSPECIFIED", "NO_COMPRESSION", "GZIP" ] } } }, "QuotaFailureViolation": { "id": "QuotaFailureViolation", "type": "object", "properties": { "subject": { "description": "The subject on which the quota check failed. For example, \"clientip:\" or \"project:\".", "type": "string" }, "quotaDimensions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The dimensions of the violated quota. Every non-global quota is enforced on a set of dimensions. While quota metric defines what to count, the dimensions specify for what aspects the counter should be increased. For example, the quota \"CPUs per region per VM family\" enforces a limit on the metric \"compute.googleapis.com/cpus_per_vm_family\" on dimensions \"region\" and \"vm_family\". And if the violation occurred in region \"us-central1\" and for VM family \"n1\", the quota_dimensions would be, { \"region\": \"us-central1\", \"vm_family\": \"n1\", } When a quota is enforced globally, the quota_dimensions would always be empty." }, "description": { "description": "A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console. For example: \"Service disabled\" or \"Daily Limit for read operations exceeded\".", "type": "string" }, "apiService": { "description": "The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".", "type": "string" }, "futureQuotaValue": { "description": "The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set. For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.", "type": "string", "format": "int64" }, "quotaValue": { "description": "The enforced quota value at the time of the `QuotaFailure`. For example, if the enforced quota value at the time of the `QuotaFailure` on the number of CPUs is \"10\", then the value of this field would reflect this quantity.", "type": "string", "format": "int64" }, "quotaMetric": { "description": "The metric of the violated quota. A quota metric is a named counter to measure usage, such as API requests or CPUs. When an activity occurs in a service, such as Virtual Machine allocation, one or more quota metrics may be affected. For example, \"compute.googleapis.com/cpus_per_vm_family\", \"storage.googleapis.com/internet_egress_bandwidth\".", "type": "string" }, "quotaId": { "description": "The id of the violated quota. Also know as \"limit name\", this is the unique identifier of a quota in the context of an API service. For example, \"CPUS-PER-VM-FAMILY-per-project-region\".", "type": "string" } }, "description": "A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded." }, "OracleAsmConfig": { "description": "Configuration for Oracle Automatic Storage Management (ASM) connection.", "type": "object", "properties": { "hostname": { "type": "string", "description": "Required. Hostname for the Oracle ASM connection." }, "asmService": { "description": "Required. ASM service name for the Oracle ASM connection.", "type": "string" }, "password": { "description": "Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "oracleSslConfig": { "description": "Optional. SSL configuration for the Oracle connection.", "$ref": "OracleSslConfig" }, "port": { "type": "integer", "format": "int32", "description": "Required. Port for the Oracle ASM connection." }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the Oracle ASM connection password. Mutually exclusive with the `password` field.", "type": "string" }, "username": { "description": "Required. Username for the Oracle ASM connection.", "type": "string" }, "connectionAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Connection string attributes" } }, "id": "OracleAsmConfig" }, "BigQueryClustering": { "id": "BigQueryClustering", "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" }, "description": "Required. Column names to set as clustering columns." } }, "description": "BigQuery clustering configuration." }, "SqlServerProfile": { "description": "Profile for connecting to a SQLServer source.", "type": "object", "properties": { "hostname": { "type": "string", "description": "Required. Hostname for the SQLServer connection." }, "sslConfig": { "description": "Optional. SSL configuration for the SQLServer connection.", "$ref": "SqlServerSslConfig" }, "password": { "description": "Optional. Password for the SQLServer connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "port": { "type": "integer", "format": "int32", "description": "Port for the SQLServer connection, default value is 1433." }, "secretManagerStoredPassword": { "type": "string", "description": "Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field." }, "username": { "description": "Required. Username for the SQLServer connection.", "type": "string" }, "database": { "type": "string", "description": "Required. Database for the SQLServer connection." } }, "id": "SqlServerProfile" }, "BadRequest": { "id": "BadRequest", "type": "object", "properties": { "fieldViolations": { "type": "array", "items": { "$ref": "FieldViolation" }, "description": "Describes all violations in a client request." } }, "description": "Describes violations in a client request. This error type focuses on the syntactic aspects of the request." }, "OracleSchema": { "id": "OracleSchema", "description": "Oracle schema.", "type": "object", "properties": { "oracleTables": { "type": "array", "items": { "$ref": "OracleTable" }, "description": "Tables in the schema." }, "schema": { "description": "The schema name.", "type": "string" } } }, "ListStreamObjectsResponse": { "type": "object", "properties": { "streamObjects": { "description": "List of stream objects.", "type": "array", "items": { "$ref": "StreamObject" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page." } }, "description": "Response containing the objects for a stream.", "id": "ListStreamObjectsResponse" }, "MysqlDatabase": { "id": "MysqlDatabase", "type": "object", "properties": { "database": { "type": "string", "description": "The database name." }, "mysqlTables": { "description": "Tables in the database.", "type": "array", "items": { "$ref": "MysqlTable" } } }, "description": "MySQL database." }, "PostgresqlSchema": { "id": "PostgresqlSchema", "description": "PostgreSQL schema.", "type": "object", "properties": { "postgresqlTables": { "type": "array", "items": { "$ref": "PostgresqlTable" }, "description": "Tables in the schema." }, "schema": { "description": "The schema name.", "type": "string" } } }, "StandardConnectionFormat": { "description": "Standard connection format.", "type": "object", "properties": { "directConnection": { "type": "boolean", "description": "Optional. Deprecated: Use the `additional_options` map to specify the `directConnection` parameter instead. For example: `additional_options = {\"directConnection\": \"true\"}`. Specifies whether the client connects directly to the host[:port] in the connection URI.", "deprecated": true } }, "id": "StandardConnectionFormat" }, "SourceObjectIdentifier": { "id": "SourceObjectIdentifier", "description": "Represents an identifier of an object in the data source.", "type": "object", "properties": { "oracleIdentifier": { "$ref": "OracleObjectIdentifier", "description": "Oracle data source object identifier." }, "mongodbIdentifier": { "description": "MongoDB data source object identifier.", "$ref": "MongodbObjectIdentifier" }, "spannerIdentifier": { "description": "Spanner data source object identifier.", "$ref": "SpannerObjectIdentifier" }, "mysqlIdentifier": { "$ref": "MysqlObjectIdentifier", "description": "Mysql data source object identifier." }, "postgresqlIdentifier": { "$ref": "PostgresqlObjectIdentifier", "description": "PostgreSQL data source object identifier." }, "salesforceIdentifier": { "description": "Salesforce data source object identifier.", "$ref": "SalesforceObjectIdentifier" }, "sqlServerIdentifier": { "$ref": "SqlServerObjectIdentifier", "description": "SQLServer data source object identifier." } } }, "SalesforceProfile": { "description": "Profile for connecting to a Salesforce source.", "type": "object", "properties": { "oauth2ClientCredentials": { "$ref": "Oauth2ClientCredentials", "description": "Connected app authentication." }, "userCredentials": { "deprecated": true, "$ref": "UserCredentials", "description": "Deprecated: Salesforce is retiring Username-Password authentication. Use `oauth2_client_credentials` instead." }, "domain": { "type": "string", "description": "Required. Domain endpoint for the Salesforce connection." } }, "id": "SalesforceProfile" }, "ValidationResult": { "description": "Contains the current validation results.", "type": "object", "properties": { "validations": { "description": "A list of validations (includes both executed as well as not executed validations).", "type": "array", "items": { "$ref": "Validation" } } }, "id": "ValidationResult" }, "RunStreamRequest": { "id": "RunStreamRequest", "type": "object", "properties": { "force": { "description": "Optional. Update the stream without validating it.", "type": "boolean" }, "cdcStrategy": { "$ref": "CdcStrategy", "description": "Optional. The CDC strategy of the stream. If not set, the system's default value will be used." } }, "description": "Request message for running a stream." }, "LogFileDirectories": { "description": "Configuration to specify the Oracle directories to access the log files.", "type": "object", "properties": { "onlineLogDirectory": { "description": "Required. Oracle directory for online logs.", "type": "string" }, "archivedLogDirectory": { "type": "string", "description": "Required. Oracle directory for archived logs." } }, "id": "LogFileDirectories" }, "SpannerTable": { "type": "object", "properties": { "table": { "type": "string", "description": "Required. The table name." }, "columns": { "type": "array", "items": { "$ref": "SpannerColumn" }, "description": "Optional. Spanner columns in the table." } }, "description": "Spanner table.", "id": "SpannerTable" }, "MysqlColumn": { "description": "MySQL Column.", "type": "object", "properties": { "collation": { "description": "Column collation.", "type": "string" }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "scale": { "type": "integer", "format": "int32", "description": "Column scale." }, "length": { "description": "Column length.", "type": "integer", "format": "int32" }, "ordinalPosition": { "type": "integer", "format": "int32", "description": "The ordinal position of the column in the table." }, "column": { "description": "The column name.", "type": "string" }, "dataType": { "type": "string", "description": "The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html" }, "precision": { "type": "integer", "format": "int32", "description": "Column precision." }, "nullable": { "type": "boolean", "description": "Whether or not the column can accept a null value." } }, "id": "MysqlColumn" }, "PostgresqlSourceConfig": { "id": "PostgresqlSourceConfig", "type": "object", "properties": { "maxConcurrentBackfillTasks": { "type": "integer", "format": "int32", "description": "Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system's default value will be used." }, "replicationSlot": { "type": "string", "description": "Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin." }, "publication": { "description": "Required. The name of the publication that includes the set of all tables that are defined in the stream's include_objects.", "type": "string" }, "excludeObjects": { "description": "The PostgreSQL objects to exclude from the stream.", "$ref": "PostgresqlRdbms" }, "includeObjects": { "$ref": "PostgresqlRdbms", "description": "The PostgreSQL objects to include in the stream." } }, "description": "Configuration for syncing data from a PostgreSQL source." }, "MongodbSslConfig": { "id": "MongodbSslConfig", "description": "MongoDB SSL configuration information.", "type": "object", "properties": { "clientKeySet": { "description": "Output only. Indicates whether the client_key field is set.", "type": "boolean", "readOnly": true }, "caCertificate": { "type": "string", "description": "Optional. Input only. PEM-encoded certificate of the CA that signed the source database server's certificate." }, "clientKey": { "type": "string", "description": "Optional. Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory." }, "clientCertificate": { "description": "Optional. Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.", "type": "string" }, "caCertificateSet": { "readOnly": true, "description": "Output only. Indicates whether the ca_certificate field is set.", "type": "boolean" }, "clientCertificateSet": { "type": "boolean", "description": "Output only. Indicates whether the client_certificate field is set.", "readOnly": true }, "secretManagerStoredClientKey": { "type": "string", "description": "Optional. Input only. A reference to a Secret Manager resource name storing the PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory. Mutually exclusive with the `client_key` field." } } }, "ServiceNowProfile": { "id": "ServiceNowProfile", "type": "object", "properties": { "userPasswordCredentials": { "$ref": "UserPasswordCredentials", "description": "User-password authentication." }, "oauthClientCredentials": { "description": "Credentials for authenticating with the ServiceNow API.", "$ref": "OauthClientCredentials" }, "instance": { "type": "string", "description": "Required. The instance of the ServiceNow account. This is the `` part of the URL `https://.service-now.com`." } }, "description": "Profile for connecting to a ServiceNow source." }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "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`." }, "done": { "description": "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.", "type": "boolean" }, "name": { "description": "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}`.", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "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." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } } }, "MysqlProfile": { "id": "MysqlProfile", "type": "object", "properties": { "sslConfig": { "description": "SSL configuration for the MySQL connection.", "$ref": "MysqlSslConfig" }, "hostname": { "type": "string", "description": "Required. Hostname for the MySQL connection." }, "username": { "description": "Required. Username for the MySQL connection.", "type": "string" }, "port": { "type": "integer", "format": "int32", "description": "Port for the MySQL connection, default value is 3306." }, "secretManagerStoredPassword": { "type": "string", "description": "Optional. A reference to a Secret Manager resource name storing the MySQL connection password. Mutually exclusive with the `password` field." }, "password": { "type": "string", "description": "Optional. Input only. Password for the MySQL connection. Mutually exclusive with the `secret_manager_stored_password` field." } }, "description": "Profile for connecting to a MySQL source." }, "PscInterfaceConfig": { "id": "PscInterfaceConfig", "description": "The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer's PSC.", "type": "object", "properties": { "networkAttachment": { "description": "Required. Fully qualified name of the Network Attachment that Datastream will connect to. Format: `projects/{project}/regions/{region}/networkAttachments/{name}`", "type": "string" } } }, "StartBackfillJobRequest": { "id": "StartBackfillJobRequest", "description": "Request for manually initiating a backfill job for a specific stream object.", "type": "object", "properties": { "eventFilter": { "$ref": "EventFilter", "description": "Optional. Optional event filter. If not set, or empty, the backfill will be performed on the entire object. This is currently used for partial backfill and only supported for SQL sources." } } }, "SpannerProfile": { "id": "SpannerProfile", "type": "object", "properties": { "database": { "description": "Required. Immutable. Cloud Spanner database resource. This field is immutable. Must be in the format: projects/{project}/instances/{instance}/databases/{database_id}.", "type": "string" }, "host": { "description": "Optional. The Spanner endpoint to connect to. Defaults to the global endpoint (https://spanner.googleapis.com). Must be in the format: https://spanner.{region}.rep.googleapis.com.", "type": "string" } }, "description": "Profile for connecting to a Spanner source." }, "FetchStaticIpsResponse": { "description": "Response message for a 'FetchStaticIps' response.", "type": "object", "properties": { "staticIps": { "description": "list of static ips by account", "type": "array", "items": { "type": "string" } }, "nextPageToken": { "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "id": "FetchStaticIpsResponse" }, "EncryptionAndServerValidation": { "id": "EncryptionAndServerValidation", "type": "object", "properties": { "caCertificate": { "description": "Optional. Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.", "type": "string" }, "serverCertificateHostname": { "type": "string", "description": "Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. This field is used for bypassing the hostname validation while verifying server certificate. This is required for scenarios where the host name that datastream connects to is different from the certificate's subject. This specifically happens for private connectivity. It could also happen when the customer provides a public IP in connection profile but the same is not present in the server certificate." } }, "description": "Message to represent the option where Datastream will enforce encryption and authenticate server identity. ca_certificate must be set if user selects this option." }, "BigQueryDestinationConfig": { "id": "BigQueryDestinationConfig", "type": "object", "properties": { "sourceHierarchyDatasets": { "$ref": "SourceHierarchyDatasets", "description": "Source hierarchy datasets." }, "dataFreshness": { "description": "The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.", "type": "string", "format": "google-duration" }, "appendOnly": { "description": "Append only mode", "$ref": "AppendOnly" }, "blmtConfig": { "$ref": "BlmtConfig", "description": "Optional. Big Lake Managed Tables (BLMT) configuration." }, "merge": { "$ref": "Merge", "description": "The standard mode" }, "singleTargetDataset": { "description": "Single destination dataset.", "$ref": "SingleTargetDataset" } }, "description": "BigQuery destination configuration" }, "AppendOnly": { "type": "object", "properties": {}, "description": "AppendOnly mode defines that all changes to a table will be written to the destination table.", "id": "AppendOnly" }, "ListRoutesResponse": { "type": "object", "properties": { "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "routes": { "description": "List of Routes.", "type": "array", "items": { "$ref": "Route" } } }, "description": "Route list response.", "id": "ListRoutesResponse" }, "RuleSet": { "type": "object", "properties": { "objectFilter": { "description": "Required. Object filter to apply the customization rules to.", "$ref": "ObjectFilter" }, "customizationRules": { "type": "array", "items": { "$ref": "CustomizationRule" }, "description": "Required. List of customization rules to apply." } }, "description": "A set of rules to apply to a set of objects.", "id": "RuleSet" }, "DataverseSourceConfig": { "id": "DataverseSourceConfig", "description": "Configuration for syncing data from a Dataverse source.", "type": "object", "properties": { "excludeObjects": { "description": "Optional. The objects to exclude from the stream.", "$ref": "SourceCatalog" }, "includeObjects": { "$ref": "SourceCatalog", "description": "Optional. The objects to retrieve from the source." }, "pollingInterval": { "description": "Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.", "type": "string", "format": "google-duration" } } }, "ErrorInfo": { "type": "object", "properties": { "reason": { "description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" }, "domain": { "description": "The logical grouping to which the \"reason\" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: \"pubsub.googleapis.com\". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is \"googleapis.com\".", "type": "string" }, "metadata": { "description": "Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{\"instanceLimit\": \"100/request\"}`, should be returned as, `{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of instances that can be created in a single (batch) request.", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Describes the cause of the error with structured details. Example of an error when contacting the \"pubsub.googleapis.com\" API when it is not enabled: { \"reason\": \"API_DISABLED\" \"domain\": \"googleapis.com\" \"metadata\": { \"resource\": \"projects/123\", \"service\": \"pubsub.googleapis.com\" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { \"reason\": \"STOCKOUT\" \"domain\": \"spanner.googleapis.com\", \"metadata\": { \"availableRegions\": \"us-central1,us-east2\" } }", "id": "ErrorInfo" }, "MysqlTable": { "type": "object", "properties": { "mysqlColumns": { "type": "array", "items": { "$ref": "MysqlColumn" }, "description": "MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything." }, "table": { "type": "string", "description": "The table name." } }, "description": "MySQL table.", "id": "MysqlTable" }, "Error": { "id": "Error", "description": "Represent a user-facing Error.", "type": "object", "properties": { "reason": { "description": "A title that explains the reason for the error.", "type": "string" }, "errorUuid": { "type": "string", "description": "A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses." }, "details": { "description": "Additional information about the error.", "type": "object", "additionalProperties": { "type": "string" } }, "message": { "type": "string", "description": "A message containing more information about the error that occurred." }, "errorTime": { "description": "The time when the error occurred.", "type": "string", "format": "google-datetime" } } }, "GcsDestinationConfig": { "id": "GcsDestinationConfig", "type": "object", "properties": { "path": { "description": "Path inside the Cloud Storage bucket to write data to.", "type": "string" }, "fileRotationMb": { "description": "The maximum file size to be saved in the bucket.", "type": "integer", "format": "int32" }, "avroFileFormat": { "$ref": "AvroFileFormat", "description": "AVRO file format configuration." }, "jsonFileFormat": { "$ref": "JsonFileFormat", "description": "JSON file format configuration." }, "fileRotationInterval": { "description": "The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.", "type": "string", "format": "google-duration" } }, "description": "Google Cloud Storage destination configuration" }, "DestinationConfig": { "description": "The configuration of the stream destination.", "type": "object", "properties": { "gcsDestinationConfig": { "$ref": "GcsDestinationConfig", "description": "A configuration for how data should be loaded to Cloud Storage." }, "destinationConnectionProfile": { "type": "string", "description": "Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`" }, "bigqueryDestinationConfig": { "$ref": "BigQueryDestinationConfig", "description": "BigQuery destination configuration." } }, "id": "DestinationConfig" }, "Oauth2ClientCredentials": { "type": "object", "properties": { "clientSecret": { "description": "Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field.", "type": "string" }, "secretManagerStoredClientSecret": { "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce OAuth2 client_secret. Mutually exclusive with the `client_secret` field.", "type": "string" }, "clientId": { "description": "Required. Client ID for Salesforce OAuth2 Client Credentials.", "type": "string" } }, "description": "OAuth2 Client Credentials.", "id": "Oauth2ClientCredentials" }, "StopBackfillJobResponse": { "id": "StopBackfillJobResponse", "type": "object", "properties": { "object": { "description": "The stream object resource the backfill job was stopped for.", "$ref": "StreamObject" } }, "description": "Response for manually stop a backfill job for a specific stream object." }, "SourceHierarchyDatasets": { "id": "SourceHierarchyDatasets", "type": "object", "properties": { "datasetTemplate": { "$ref": "DatasetTemplate", "description": "The dataset template to use for dynamic dataset creation." }, "projectId": { "type": "string", "description": "Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource." } }, "description": "Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy." }, "ConnectionProfile": { "id": "ConnectionProfile", "description": "A set of reusable connection configurations to be used as a source or destination for a stream.", "type": "object", "properties": { "spannerProfile": { "description": "Profile for connecting to a Spanner source.", "$ref": "SpannerProfile" }, "privateConnectivity": { "description": "Private connectivity.", "$ref": "PrivateConnectivity" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "satisfiesPzi": { "type": "boolean", "description": "Output only. Reserved for future use.", "readOnly": true }, "serviceNowProfile": { "description": "Profile for connecting to a ServiceNow source.", "$ref": "ServiceNowProfile" }, "sqlServerProfile": { "description": "Profile for connecting to a SQLServer source.", "$ref": "SqlServerProfile" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The resource's name." }, "oracleProfile": { "$ref": "OracleProfile", "description": "Profile for connecting to an Oracle source." }, "salesforceMarketingCloudProfile": { "description": "Profile for connecting to a Salesforce Marketing Cloud source.", "$ref": "SalesforceMarketingCloudProfile" }, "labels": { "description": "Labels.", "type": "object", "additionalProperties": { "type": "string" } }, "updateTime": { "description": "Output only. The update time of the resource.", "type": "string", "format": "google-datetime", "readOnly": true }, "postgresqlProfile": { "description": "Profile for connecting to a PostgreSQL source.", "$ref": "PostgresqlProfile" }, "bigqueryProfile": { "description": "Profile for connecting to a BigQuery destination.", "$ref": "BigQueryProfile" }, "mongodbProfile": { "$ref": "MongodbProfile", "description": "Profile for connecting to a MongoDB source." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The create time of the resource.", "readOnly": true }, "forwardSshConnectivity": { "description": "Forward SSH tunnel connectivity.", "$ref": "ForwardSshTunnelConnectivity" }, "displayName": { "type": "string", "description": "Required. Display name." }, "gcsProfile": { "$ref": "GcsProfile", "description": "Profile for connecting to a Cloud Storage destination." }, "salesforceProfile": { "description": "Profile for connecting to a Salesforce source.", "$ref": "SalesforceProfile" }, "staticServiceIpConnectivity": { "description": "Static Service IP connectivity.", "$ref": "StaticServiceIpConnectivity" }, "mysqlProfile": { "description": "Profile for connecting to a MySQL source.", "$ref": "MysqlProfile" }, "dataverseProfile": { "description": "Profile for connecting to a Dataverse source.", "$ref": "DataverseProfile" } } }, "CdcStrategy": { "type": "object", "properties": { "mostRecentStartPosition": { "description": "Optional. Start replicating from the most recent position in the source.", "$ref": "MostRecentStartPosition" }, "specificStartPosition": { "$ref": "SpecificStartPosition", "description": "Optional. Start replicating from a specific position in the source." }, "nextAvailableStartPosition": { "description": "Optional. Resume replication from the next available position in the source.", "$ref": "NextAvailableStartPosition" } }, "description": "The strategy that the stream uses for CDC replication.", "id": "CdcStrategy" }, "BackfillJob": { "description": "Represents a backfill job on a specific stream object.", "type": "object", "properties": { "lastEndTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Backfill job's end time." }, "trigger": { "type": "string", "description": "Backfill job's triggering reason.", "enum": [ "TRIGGER_UNSPECIFIED", "AUTOMATIC", "MANUAL" ], "enumDescriptions": [ "Default value.", "Object backfill job was triggered automatically according to the stream's backfill strategy.", "Object backfill job was triggered manually using the dedicated API." ] }, "lastStartTime": { "description": "Output only. Backfill job's start time.", "type": "string", "format": "google-datetime", "readOnly": true }, "state": { "enumDescriptions": [ "Default value.", "Backfill job was never started for the stream object (stream has backfill strategy defined as manual or object was explicitly excluded from automatic backfill).", "Backfill job will start pending available resources.", "Backfill job is running.", "Backfill job stopped (next job run will start from beginning).", "Backfill job failed (due to an error).", "Backfill completed successfully.", "Backfill job failed since the table structure is currently unsupported for backfill." ], "description": "Output only. Backfill job state.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "NOT_STARTED", "PENDING", "ACTIVE", "STOPPED", "FAILED", "COMPLETED", "UNSUPPORTED" ], "type": "string" }, "errors": { "description": "Output only. Errors which caused the backfill job to fail.", "type": "array", "items": { "$ref": "Error" }, "readOnly": true }, "eventFilter": { "readOnly": true, "$ref": "EventFilter", "description": "Output only. The filter for performing a partial backfill." } }, "id": "BackfillJob" }, "MysqlGtidPosition": { "id": "MysqlGtidPosition", "type": "object", "properties": { "gtidSet": { "type": "string", "description": "Required. The gtid set to start replication from." } }, "description": "MySQL GTID position" }, "ServerVerification": { "id": "ServerVerification", "description": "Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option.", "type": "object", "properties": { "caCertificate": { "type": "string", "description": "Required. Input only. PEM-encoded server root CA certificate." }, "serverCertificateHostname": { "type": "string", "description": "Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated." } } }, "HostAddress": { "id": "HostAddress", "description": "A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number.", "type": "object", "properties": { "hostname": { "type": "string", "description": "Required. Hostname for the connection." }, "port": { "type": "integer", "format": "int32", "description": "Optional. Port for the connection." } } }, "DataverseProfile": { "id": "DataverseProfile", "description": "Profile for connecting to a Dataverse source.", "type": "object", "properties": { "tenantId": { "description": "Required. Tenant id of the Microsoft Dataverse instance.", "type": "string" }, "environmentUrl": { "description": "Required. Environment URL of the Microsoft Dataverse instance. Example: `.crm.dynamics.com`", "type": "string" }, "oauthClientCredentials": { "$ref": "OauthClientCredentials", "description": "Required. Credentials for authenticating with the Dataverse API." } } }, "SalesforceMarketingCloudSourceConfig": { "id": "SalesforceMarketingCloudSourceConfig", "description": "Configuration for syncing data from a Salesforce Marketing Cloud source.", "type": "object", "properties": { "includeObjects": { "$ref": "SourceCatalog", "description": "Optional. The objects to retrieve from the source." }, "excludeObjects": { "description": "Optional. The objects to exclude from the stream.", "$ref": "SourceCatalog" }, "fullRefreshPollingInterval": { "description": "Required. Specifies the polling interval for a full refresh of objects that do not support incremental sync. If not set, a default value of 24 hours is used. The duration must be between 1 and 24 hours, inclusive.", "type": "string", "format": "google-duration" }, "pollingInterval": { "description": "Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive.", "type": "string", "format": "google-duration" } } }, "ResourceInfo": { "id": "ResourceInfo", "type": "object", "properties": { "resourceType": { "type": "string", "description": "A name for the type of resource being accessed, e.g. \"sql table\", \"cloud storage bucket\", \"file\", \"Google calendar\"; or the type URL of the resource: e.g. \"type.googleapis.com/google.pubsub.v1.Topic\"." }, "description": { "description": "Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the `writer` permission on the developer console project.", "type": "string" }, "resourceName": { "description": "The name of the resource being accessed. For example, a shared calendar name: \"example.com_4fghdhgsrgh@group.calendar.google.com\", if the current error is google.rpc.Code.PERMISSION_DENIED.", "type": "string" }, "owner": { "description": "The owner of the resource (optional). For example, \"user:\" or \"project:\".", "type": "string" } }, "description": "Describes the resource that is being accessed." }, "QuotaFailure": { "type": "object", "properties": { "violations": { "type": "array", "items": { "$ref": "QuotaFailureViolation" }, "description": "Describes all quota violations." } }, "description": "Describes how a quota check failed. For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set `service_disabled` to true. Also see RetryInfo and Help types for other details about handling a quota failure.", "id": "QuotaFailure" }, "SpannerSourceConfig": { "id": "SpannerSourceConfig", "description": "Configuration for syncing data from a Spanner source.", "type": "object", "properties": { "spannerRpcPriority": { "enumDescriptions": [ "Unspecified RPC priority.", "Low RPC priority.", "Medium RPC priority.", "High RPC priority." ], "enum": [ "SPANNER_RPC_PRIORITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH" ], "description": "Optional. The RPC priority to use for the stream.", "type": "string" }, "maxConcurrentBackfillTasks": { "description": "Optional. Maximum number of concurrent backfill tasks.", "type": "integer", "format": "int32" }, "changeStreamName": { "description": "Required. Immutable. The change stream name to use for the stream.", "type": "string" }, "fgacRole": { "description": "Optional. The FGAC role to use for the stream.", "type": "string" }, "maxConcurrentCdcTasks": { "description": "Optional. Maximum number of concurrent CDC tasks.", "type": "integer", "format": "int32" }, "excludeObjects": { "description": "Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown.", "$ref": "SpannerDatabase" }, "includeObjects": { "$ref": "SpannerDatabase", "description": "Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown." }, "backfillDataBoostEnabled": { "description": "Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.", "type": "boolean" } } }, "MongodbCollection": { "id": "MongodbCollection", "type": "object", "properties": { "collection": { "description": "The collection name.", "type": "string" }, "fields": { "description": "Fields in the collection.", "type": "array", "items": { "$ref": "MongodbField" } } }, "description": "MongoDB Collection." }, "SourceCatalog": { "id": "SourceCatalog", "description": "Source catalog.", "type": "object", "properties": { "objects": { "description": "Optional. Source objects in the catalog.", "type": "array", "items": { "$ref": "SourceObject" } } } }, "ServiceNowSourceConfig": { "id": "ServiceNowSourceConfig", "type": "object", "properties": { "includeObjects": { "$ref": "SourceCatalog", "description": "Optional. The objects to retrieve from the source." }, "excludeObjects": { "$ref": "SourceCatalog", "description": "Optional. The objects to exclude from the stream." }, "pollingInterval": { "type": "string", "format": "google-duration", "description": "Required. Incremental sync polling interval for all objects. If not set, a default value of `5 minutes` is used. The duration must be from `5 minutes` to `24 hours`, inclusive." } }, "description": "Configuration for syncing data from a ServiceNow source." }, "CancelOperationRequest": { "id": "CancelOperationRequest", "type": "object", "properties": {}, "description": "The request message for Operations.CancelOperation." }, "MysqlSourceConfig": { "id": "MysqlSourceConfig", "description": "Configuration for syncing data from a MySQL source.", "type": "object", "properties": { "excludeObjects": { "description": "The MySQL objects to exclude from the stream.", "$ref": "MysqlRdbms" }, "maxConcurrentCdcTasks": { "type": "integer", "format": "int32", "description": "Maximum number of concurrent CDC tasks. The number should be non negative. If not set (or set to 0), the system's default value will be used." }, "includeObjects": { "$ref": "MysqlRdbms", "description": "The MySQL objects to retrieve from the source." }, "binaryLogPosition": { "$ref": "BinaryLogPosition", "description": "Use Binary log position based replication." }, "gtid": { "description": "Use GTID based replication.", "$ref": "Gtid" }, "maxConcurrentBackfillTasks": { "type": "integer", "format": "int32", "description": "Maximum number of concurrent backfill tasks. The number should be non negative. If not set (or set to 0), the system's default value will be used." } } }, "Location": { "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" } }, "id": "Location" }, "OracleAsmLogFileAccess": { "id": "OracleAsmLogFileAccess", "type": "object", "properties": {}, "description": "Configuration to use Oracle ASM to access the log files." }, "PostgresqlRdbms": { "type": "object", "properties": { "postgresqlSchemas": { "description": "PostgreSQL schemas in the database server.", "type": "array", "items": { "$ref": "PostgresqlSchema" } } }, "description": "PostgreSQL database structure.", "id": "PostgresqlRdbms" }, "ValidationMessage": { "id": "ValidationMessage", "description": "Represent user-facing validation result message.", "type": "object", "properties": { "message": { "type": "string", "description": "The result of the validation." }, "metadata": { "description": "Additional metadata related to the result.", "type": "object", "additionalProperties": { "type": "string" } }, "code": { "description": "A custom code identifying this specific message.", "type": "string" }, "level": { "type": "string", "description": "Message severity level (warning or error).", "enum": [ "LEVEL_UNSPECIFIED", "WARNING", "ERROR" ], "enumDescriptions": [ "Unspecified level.", "Potentially cause issues with the Stream.", "Definitely cause issues with the Stream." ] } } }, "SalesforceSourceConfig": { "id": "SalesforceSourceConfig", "description": "Configuration for syncing data from a Salesforce source.", "type": "object", "properties": { "excludeObjects": { "description": "The Salesforce objects to exclude from the stream.", "$ref": "SalesforceOrg" }, "includeObjects": { "$ref": "SalesforceOrg", "description": "The Salesforce objects to retrieve from the source." }, "pollingInterval": { "description": "Required. Salesforce objects polling interval. The interval at which new changes will be polled for each object. The duration must be from `5 minutes` to `24 hours`, inclusive.", "type": "string", "format": "google-duration" } } }, "Link": { "type": "object", "properties": { "description": { "description": "Describes what the link offers.", "type": "string" }, "url": { "type": "string", "description": "The URL of the link." } }, "description": "Describes a URL link.", "id": "Link" }, "OauthClientCredentials": { "id": "OauthClientCredentials", "type": "object", "properties": { "clientId": { "type": "string", "description": "Required. Client ID for OAuth Client Credentials." }, "clientSecret": { "description": "Required. Client secret for OAuth Client Credentials.", "$ref": "Secret" } }, "description": "OAuth Client Credentials." }, "SqlServerChangeTables": { "description": "Configuration to use Change Tables CDC read method.", "type": "object", "properties": {}, "id": "SqlServerChangeTables" }, "PostgresqlProfile": { "description": "Profile for connecting to a PostgreSQL source.", "type": "object", "properties": { "password": { "description": "Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "port": { "type": "integer", "format": "int32", "description": "Port for the PostgreSQL connection, default value is 5432." }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the PostgreSQL connection password. Mutually exclusive with the `password` field.", "type": "string" }, "username": { "description": "Required. Username for the PostgreSQL connection.", "type": "string" }, "database": { "description": "Required. Database for the PostgreSQL connection.", "type": "string" }, "hostname": { "description": "Required. Hostname for the PostgreSQL connection.", "type": "string" }, "sslConfig": { "$ref": "PostgresqlSslConfig", "description": "Optional. SSL configuration for the PostgreSQL connection. In case PostgresqlSslConfig is not set, the connection will use the default SSL mode, which is `prefer` (i.e. this mode will only use encryption if enabled from database side, otherwise will use unencrypted communication)" } }, "id": "PostgresqlProfile" }, "BackfillAllStrategy": { "type": "object", "properties": { "saasExcludedObjects": { "description": "Source catalog data source objects to avoid backfilling. This is mainly used to represent SaaS applications objects.", "$ref": "SourceCatalog" }, "mysqlExcludedObjects": { "$ref": "MysqlRdbms", "description": "MySQL data source objects to avoid backfilling." }, "sqlServerExcludedObjects": { "$ref": "SqlServerRdbms", "description": "SQLServer data source objects to avoid backfilling" }, "postgresqlExcludedObjects": { "description": "PostgreSQL data source objects to avoid backfilling.", "$ref": "PostgresqlRdbms" }, "mongodbExcludedObjects": { "$ref": "MongodbCluster", "description": "MongoDB data source objects to avoid backfilling" }, "salesforceExcludedObjects": { "$ref": "SalesforceOrg", "description": "Salesforce data source objects to avoid backfilling" }, "oracleExcludedObjects": { "description": "Oracle data source objects to avoid backfilling.", "$ref": "OracleRdbms" }, "spannerExcludedObjects": { "description": "Spanner data source objects to avoid backfilling.", "$ref": "SpannerDatabase" } }, "description": "Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.", "id": "BackfillAllStrategy" }, "MysqlRdbms": { "id": "MysqlRdbms", "type": "object", "properties": { "mysqlDatabases": { "description": "Mysql databases on the server", "type": "array", "items": { "$ref": "MysqlDatabase" } } }, "description": "MySQL database structure" }, "MongodbProfile": { "type": "object", "properties": { "secretManagerStoredPassword": { "type": "string", "description": "Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field." }, "hostAddresses": { "description": "Required. List of host addresses for a MongoDB cluster. For SRV connection format, this list must contain exactly one DNS host without a port. For Standard connection format, this list must contain all the required hosts in the cluster with their respective ports.", "type": "array", "items": { "$ref": "HostAddress" } }, "password": { "type": "string", "description": "Optional. Password for the MongoDB connection. Mutually exclusive with the `secret_manager_stored_password` field." }, "standardConnectionFormat": { "$ref": "StandardConnectionFormat", "description": "Standard connection format." }, "sslConfig": { "description": "Optional. SSL configuration for the MongoDB connection.", "$ref": "MongodbSslConfig" }, "username": { "description": "Required. Username for the MongoDB connection.", "type": "string" }, "srvConnectionFormat": { "description": "Srv connection format.", "$ref": "SrvConnectionFormat" }, "additionalOptions": { "description": "Optional. Specifies additional options for the MongoDB connection. The options should be sent as key-value pairs, for example: `additional_options = {\"serverSelectionTimeoutMS\": \"10000\", \"directConnection\": \"true\"}`. Keys are case-sensitive and should match the official MongoDB connection string options: https://www.mongodb.com/docs/manual/reference/connection-string-options/ The server will not modify the values provided by the user.", "type": "object", "additionalProperties": { "type": "string" } }, "replicaSet": { "description": "Optional. Name of the replica set. Only needed for self hosted replica set type MongoDB cluster. For SRV connection format, this field must be empty. For Standard connection format, this field must be specified.", "type": "string" } }, "description": "Profile for connecting to a MongoDB source.", "id": "MongodbProfile" }, "VpcPeeringConfig": { "type": "object", "properties": { "vpc": { "description": "Required. Fully qualified name of the VPC that Datastream will peer to. Format: `projects/{project}/global/{networks}/{name}`", "type": "string" }, "subnet": { "description": "Required. A free subnet for peering. (CIDR of /29)", "type": "string" } }, "description": "The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.", "id": "VpcPeeringConfig" }, "FieldViolation": { "id": "FieldViolation", "description": "A message type used to describe a single bad request field.", "type": "object", "properties": { "reason": { "type": "string", "description": "The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE." }, "description": { "type": "string", "description": "A description of why the request element is bad." }, "field": { "description": "A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto `field` could take one of the following values: * `full_name` for a violation in the `full_name` value * `email_addresses[0].email` for a violation in the `email` field of the first `email_addresses` message * `email_addresses[2].type[1]` for a violation in the second `type` value in the third `email_addresses` message. In JSON, the same values are represented as: * `fullName` for a violation in the `fullName` value * `emailAddresses[0].email` for a violation in the `email` field of the first `emailAddresses` message * `emailAddresses[2].type[1]` for a violation in the second `type` value in the third `emailAddresses` message.", "type": "string" }, "localizedMessage": { "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer.", "$ref": "LocalizedMessage" } } }, "ListStreamsResponse": { "id": "ListStreamsResponse", "description": "Response message for listing streams.", "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "streams": { "description": "List of streams", "type": "array", "items": { "$ref": "Stream" } }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "MysqlObjectIdentifier": { "description": "Mysql data source object identifier.", "type": "object", "properties": { "table": { "description": "Required. The table name.", "type": "string" }, "database": { "description": "Required. The database name.", "type": "string" } }, "id": "MysqlObjectIdentifier" }, "SqlServerTable": { "type": "object", "properties": { "columns": { "description": "SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.", "type": "array", "items": { "$ref": "SqlServerColumn" } }, "table": { "description": "The table name.", "type": "string" } }, "description": "SQLServer table.", "id": "SqlServerTable" }, "BinaryLogPosition": { "id": "BinaryLogPosition", "type": "object", "properties": {}, "description": "Use Binary log position based replication." }, "BackfillNoneStrategy": { "type": "object", "properties": {}, "description": "Backfill strategy to disable automatic backfill for the Stream's objects.", "id": "BackfillNoneStrategy" }, "PrivateConnectivity": { "type": "object", "properties": { "privateConnection": { "description": "Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}`", "type": "string" } }, "description": "Private Connectivity", "id": "PrivateConnectivity" }, "MongodbCluster": { "description": "MongoDB Cluster structure.", "type": "object", "properties": { "databases": { "type": "array", "items": { "$ref": "MongodbDatabase" }, "description": "MongoDB databases in the cluster." } }, "id": "MongodbCluster" }, "MongodbSourceConfig": { "description": "Configuration for syncing data from a MongoDB source.", "type": "object", "properties": { "excludeObjects": { "$ref": "MongodbCluster", "description": "The MongoDB collections to exclude from the stream." }, "includeObjects": { "$ref": "MongodbCluster", "description": "The MongoDB collections to include in the stream." }, "jsonMode": { "enumDescriptions": [ "Unspecified JSON mode.", "Strict JSON mode.", "Canonical JSON mode." ], "enum": [ "MONGODB_JSON_MODE_UNSPECIFIED", "STRICT", "CANONICAL" ], "description": "Optional. MongoDB JSON mode to use for the stream.", "type": "string" }, "maxConcurrentBackfillTasks": { "description": "Optional. Maximum number of concurrent backfill tasks. The number should be non-negative and less than or equal to 50. If not set (or set to 0), the system's default value is used", "type": "integer", "format": "int32" } }, "id": "MongodbSourceConfig" }, "AvroFileFormat": { "description": "AVRO file format configuration.", "type": "object", "properties": {}, "id": "AvroFileFormat" }, "PreconditionFailure": { "description": "Describes what preconditions have failed. For example, if an RPC failed because it required the Terms of Service to be acknowledged, it could list the terms of service violation in the PreconditionFailure message.", "type": "object", "properties": { "violations": { "description": "Describes all precondition violations.", "type": "array", "items": { "$ref": "PreconditionFailureViolation" } } }, "id": "PreconditionFailure" }, "DatasetTemplate": { "id": "DatasetTemplate", "type": "object", "properties": { "location": { "type": "string", "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations." }, "kmsKeyName": { "description": "Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.", "type": "string" }, "datasetIdPrefix": { "description": "If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _.", "type": "string" } }, "description": "Dataset template used for dynamic dataset creation." }, "RequestInfo": { "id": "RequestInfo", "description": "Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.", "type": "object", "properties": { "requestId": { "type": "string", "description": "An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs." }, "servingData": { "description": "Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.", "type": "string" } } }, "UserCredentials": { "deprecated": true, "properties": { "securityToken": { "type": "string", "description": "Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field." }, "secretManagerStoredSecurityToken": { "type": "string", "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field." }, "username": { "type": "string", "description": "Required. Username for the Salesforce connection." }, "password": { "type": "string", "description": "Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field." }, "secretManagerStoredPassword": { "type": "string", "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field." } }, "description": "Deprecated: Salesforce is retiring Username-Password authentication. Use `Oauth2ClientCredentials` instead.", "id": "UserCredentials", "type": "object" }, "Stream": { "type": "object", "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels." }, "customerManagedEncryptionKey": { "type": "string", "description": "Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS." }, "errors": { "readOnly": true, "description": "Output only. Errors on the Stream.", "type": "array", "items": { "$ref": "Error" } }, "name": { "description": "Output only. Identifier. The stream's name.", "type": "string", "readOnly": true }, "backfillAll": { "description": "Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.", "$ref": "BackfillAllStrategy" }, "satisfiesPzs": { "readOnly": true, "description": "Output only. Reserved for future use.", "type": "boolean" }, "sourceConfig": { "$ref": "SourceConfig", "description": "Required. Source connection profile configuration." }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "ruleSets": { "type": "array", "items": { "$ref": "RuleSet" }, "description": "Optional. Rule sets to apply to the stream." }, "state": { "type": "string", "description": "The state of the stream.", "enum": [ "STATE_UNSPECIFIED", "NOT_STARTED", "RUNNING", "PAUSED", "MAINTENANCE", "FAILED", "FAILED_PERMANENTLY", "STARTING", "DRAINING" ], "enumDescriptions": [ "Unspecified stream state.", "The stream has been created but has not yet started streaming data.", "The stream is running.", "The stream is paused.", "The stream is in maintenance mode. Updates are rejected on the resource in this state.", "The stream is experiencing an error that is preventing data from being streamed.", "The stream has experienced a terminal failure.", "The stream is starting, but not yet running.", "The Stream is no longer reading new events, but still writing events in the buffer." ] }, "backfillNone": { "$ref": "BackfillNoneStrategy", "description": "Do not automatically backfill any objects." }, "lastRecoveryTime": { "description": "Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.", "type": "string", "format": "google-datetime", "readOnly": true }, "displayName": { "description": "Required. Display name.", "type": "string" }, "destinationConfig": { "$ref": "DestinationConfig", "description": "Required. Destination connection profile configuration." }, "createTime": { "description": "Output only. The creation time of the stream.", "type": "string", "format": "google-datetime", "readOnly": true }, "updateTime": { "description": "Output only. The last update time of the stream.", "type": "string", "format": "google-datetime", "readOnly": true } }, "description": "A resource representing streaming data from a source to a destination.", "id": "Stream" }, "PrivateConnection": { "id": "PrivateConnection", "description": "The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.", "type": "object", "properties": { "updateTime": { "description": "Output only. The update time of the resource.", "type": "string", "format": "google-datetime", "readOnly": true }, "state": { "enumDescriptions": [ "Unspecified state.", "The private connection is in creation state - creating resources.", "The private connection has been created with all of its resources.", "The private connection creation has failed.", "The private connection is being deleted.", "Delete request has failed, resource is in invalid state." ], "description": "Output only. The state of the Private Connection.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "FAILED", "DELETING", "FAILED_TO_DELETE" ], "type": "string" }, "error": { "description": "Output only. In case of error, the details of the error in a user-friendly format.", "$ref": "Error", "readOnly": true }, "createTime": { "description": "Output only. The create time of the resource.", "type": "string", "format": "google-datetime", "readOnly": true }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "vpcPeeringConfig": { "description": "VPC Peering Config.", "$ref": "VpcPeeringConfig" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "type": "boolean", "readOnly": true }, "name": { "readOnly": true, "description": "Output only. Identifier. The resource's name.", "type": "string" }, "pscInterfaceConfig": { "description": "PSC Interface Config.", "$ref": "PscInterfaceConfig" }, "displayName": { "type": "string", "description": "Required. Display name." }, "labels": { "description": "Labels.", "type": "object", "additionalProperties": { "type": "string" } } } }, "OracleProfile": { "type": "object", "properties": { "databaseService": { "description": "Required. Database for the Oracle connection.", "type": "string" }, "username": { "type": "string", "description": "Required. Username for the Oracle connection." }, "port": { "type": "integer", "format": "int32", "description": "Port for the Oracle connection, default value is 1521." }, "secretManagerStoredPassword": { "type": "string", "description": "Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field." }, "password": { "description": "Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "oracleSslConfig": { "$ref": "OracleSslConfig", "description": "Optional. SSL configuration for the Oracle connection." }, "connectionAttributes": { "description": "Connection string attributes", "type": "object", "additionalProperties": { "type": "string" } }, "hostname": { "description": "Required. Hostname for the Oracle connection.", "type": "string" }, "oracleAsmConfig": { "$ref": "OracleAsmConfig", "description": "Optional. Configuration for Oracle ASM connection." } }, "description": "Profile for connecting to an Oracle source.", "id": "OracleProfile" }, "BigQueryPartitioning": { "id": "BigQueryPartitioning", "description": "BigQuery partitioning configuration.", "type": "object", "properties": { "timeUnitPartition": { "$ref": "TimeUnitPartition", "description": "Time unit column partitioning." }, "ingestionTimePartition": { "description": "Ingestion time partitioning.", "$ref": "IngestionTimePartition" }, "requirePartitionFilter": { "type": "boolean", "description": "Optional. If true, queries over the table require a partition filter." }, "integerRangePartition": { "$ref": "IntegerRangePartition", "description": "Integer range partitioning." } } }, "DebugInfo": { "id": "DebugInfo", "description": "Describes additional debugging info.", "type": "object", "properties": { "stackEntries": { "description": "The stack trace entries indicating where the error occurred.", "type": "array", "items": { "type": "string" } }, "detail": { "type": "string", "description": "Additional debugging information provided by the server." } } }, "StreamObject": { "id": "StreamObject", "type": "object", "properties": { "customizationRules": { "readOnly": true, "type": "array", "items": { "$ref": "CustomizationRule" }, "description": "Output only. The customization rules for the object. These rules are derived from the parent Stream's `rule_sets` and represent the intended configuration for the object." }, "displayName": { "description": "Required. Display name.", "type": "string" }, "name": { "readOnly": true, "description": "Output only. Identifier. The object resource's name.", "type": "string" }, "updateTime": { "description": "Output only. The last update time of the object.", "type": "string", "format": "google-datetime", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "Error" }, "description": "Output only. Active errors on the object.", "readOnly": true }, "sourceObject": { "description": "The object identifier in the data source.", "$ref": "SourceObjectIdentifier" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The creation time of the object." }, "backfillJob": { "$ref": "BackfillJob", "description": "The latest backfill job that was initiated for the stream object." } }, "description": "A specific stream object (e.g a specific DB table)." }, "SqlServerTransactionLogs": { "description": "Configuration to use Transaction Logs CDC read method.", "type": "object", "properties": {}, "id": "SqlServerTransactionLogs" }, "EventFilter": { "id": "EventFilter", "type": "object", "properties": { "sqlWhereClause": { "type": "string", "description": "An SQL-query Where clause selecting which data should be included, not including the \"WHERE\" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'`" } }, "description": "Represents a filter for included data on a stream object." }, "NextAvailableStartPosition": { "id": "NextAvailableStartPosition", "type": "object", "properties": {}, "description": "CDC strategy to resume replication from the next available position in the source." }, "TimeUnitPartition": { "id": "TimeUnitPartition", "type": "object", "properties": { "column": { "type": "string", "description": "Required. The partitioning column." }, "partitioningTimeGranularity": { "description": "Optional. Partition granularity.", "type": "string", "enumDescriptions": [ "Unspecified partitioing interval.", "Hourly partitioning.", "Daily partitioning.", "Monthly partitioning.", "Yearly partitioning." ], "enum": [ "PARTITIONING_TIME_GRANULARITY_UNSPECIFIED", "PARTITIONING_TIME_GRANULARITY_HOUR", "PARTITIONING_TIME_GRANULARITY_DAY", "PARTITIONING_TIME_GRANULARITY_MONTH", "PARTITIONING_TIME_GRANULARITY_YEAR" ] } }, "description": "Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables" }, "StaticServiceIpConnectivity": { "id": "StaticServiceIpConnectivity", "description": "Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile.", "type": "object", "properties": {} }, "PostgresqlColumn": { "id": "PostgresqlColumn", "description": "PostgreSQL Column.", "type": "object", "properties": { "ordinalPosition": { "description": "The ordinal position of the column in the table.", "type": "integer", "format": "int32" }, "column": { "description": "The column name.", "type": "string" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "dataType": { "type": "string", "description": "The PostgreSQL data type." }, "precision": { "description": "Column precision.", "type": "integer", "format": "int32" }, "scale": { "type": "integer", "format": "int32", "description": "Column scale." }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "length": { "description": "Column length.", "type": "integer", "format": "int32" } } }, "SourceObject": { "description": "Source object.", "type": "object", "properties": { "objectName": { "type": "string", "description": "Required. The object name." }, "properties": { "description": "Optional. Source properties. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.", "type": "array", "items": { "$ref": "SourceProperty" } } }, "id": "SourceObject" }, "SourceProperty": { "id": "SourceProperty", "description": "Source property.", "type": "object", "properties": { "propertyName": { "type": "string", "description": "Required. The property name." }, "properties": { "description": "Optional. Source properties. When specified, it means that the current property contains nested properties of its own. When unspecified as part of include objects, includes everything, when unspecified as part of exclude objects, excludes nothing.", "type": "array", "items": { "$ref": "SourceProperty" } }, "primaryKey": { "type": "boolean", "description": "Optional. Whether or not the property is a primary key." } } }, "MongodbObjectIdentifier": { "id": "MongodbObjectIdentifier", "type": "object", "properties": { "database": { "type": "string", "description": "Required. The database name." }, "collection": { "description": "Required. The collection name.", "type": "string" } }, "description": "MongoDB data source object identifier." }, "MysqlLogPosition": { "id": "MysqlLogPosition", "type": "object", "properties": { "logFile": { "type": "string", "description": "Required. The binary log file name." }, "logPosition": { "description": "Optional. The position within the binary log file. Default is head of file.", "type": "integer", "format": "int32" } }, "description": "MySQL log position" }, "ServerAndClientVerification": { "id": "ServerAndClientVerification", "description": "Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity. ca_certificate, client_certificate and client_key must be set if user selects this option.", "type": "object", "properties": { "caCertificate": { "description": "Required. Input only. PEM-encoded server root CA certificate.", "type": "string" }, "clientCertificate": { "description": "Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate.", "type": "string" }, "clientKey": { "description": "Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream.", "type": "string" }, "serverCertificateHostname": { "description": "Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated.", "type": "string" } } }, "SpannerObjectIdentifier": { "id": "SpannerObjectIdentifier", "type": "object", "properties": { "schema": { "type": "string", "description": "Optional. The schema name." }, "table": { "type": "string", "description": "Required. The table name." } }, "description": "Spanner data source object identifier." }, "SalesforceOrg": { "id": "SalesforceOrg", "description": "Salesforce organization structure.", "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "SalesforceObject" }, "description": "Salesforce objects in the database server." } } }, "SalesforceObjectIdentifier": { "description": "Salesforce data source object identifier.", "type": "object", "properties": { "objectName": { "description": "Required. The object name.", "type": "string" } }, "id": "SalesforceObjectIdentifier" } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerName": "Google", "revision": "20260701", "batchPath": "batch", "fullyEncodeReservedExpansion": true, "parameters": { "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "enum": [ "1", "2" ] }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "alt": { "enum": [ "json", "media", "proto" ], "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "location": "query", "default": "true" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" } }, "endpoints": [ { "endpointUrl": "https://datastream.africa-south1.rep.googleapis.com/", "location": "africa-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-east1.rep.googleapis.com/", "location": "asia-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-east2.rep.googleapis.com/", "location": "asia-east2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-northeast3.rep.googleapis.com/", "location": "asia-northeast3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-south1.rep.googleapis.com/", "location": "asia-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-southeast1.rep.googleapis.com/", "location": "asia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-southeast3.rep.googleapis.com/", "location": "asia-southeast3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-north1.rep.googleapis.com/", "location": "europe-north1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-north2.rep.googleapis.com/", "location": "europe-north2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west1.rep.googleapis.com/", "location": "europe-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west10.rep.googleapis.com/", "location": "europe-west10", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west12.rep.googleapis.com/", "location": "europe-west12", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west15.rep.googleapis.com/", "location": "europe-west15", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west2.rep.googleapis.com/", "location": "europe-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west3.rep.googleapis.com/", "location": "europe-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west6.rep.googleapis.com/", "location": "europe-west6", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west8.rep.googleapis.com/", "location": "europe-west8", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west9.rep.googleapis.com/", "location": "europe-west9", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.me-central1.rep.googleapis.com/", "location": "me-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.me-west1.rep.googleapis.com/", "location": "me-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.northamerica-south1.rep.googleapis.com/", "location": "northamerica-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east1.rep.googleapis.com/", "location": "us-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east4.rep.googleapis.com/", "location": "us-east4", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east7.rep.googleapis.com/", "location": "us-east7", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-south1.rep.googleapis.com/", "location": "us-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west1.rep.googleapis.com/", "location": "us-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west2.rep.googleapis.com/", "location": "us-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west3.rep.googleapis.com/", "location": "us-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" } ], "basePath": "", "servicePath": "", "version_module": true, "mtlsRootUrl": "https://datastream.mtls.googleapis.com/", "canonicalName": "Datastream", "rootUrl": "https://datastream.googleapis.com/", "version": "v1", "description": "" }