{ "baseUrl": "https://datastream.googleapis.com/", "basePath": "", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "parameters": { "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "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" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "alt": { "type": "string", "description": "Data format for response.", "location": "query", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "quotaUser": { "type": "string", "location": "query", "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." }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "callback": { "location": "query", "type": "string", "description": "JSONP" } }, "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "response": { "$ref": "Location" }, "httpMethod": "GET", "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "id": "datastream.projects.locations.get", "parameters": { "name": { "type": "string", "description": "Resource name for the location.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "fetchStaticIps": { "httpMethod": "GET", "response": { "$ref": "FetchStaticIpsResponse" }, "description": "The FetchStaticIps API call exposes the static IP addresses used by Datastream.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:fetchStaticIps", "id": "datastream.projects.locations.fetchStaticIps", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name for the location for which static IPs should be returned. Must be in the format `projects/*/locations/*`.", "type": "string" }, "pageToken": { "type": "string", "location": "query", "description": "Optional. A page token, received from a previous `ListStaticIps` call. will likely not be specified." }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. Maximum number of Ips to return, will likely not be specified.", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}:fetchStaticIps" }, "list": { "id": "datastream.projects.locations.list", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true }, "extraLocationTypes": { "location": "query", "type": "string", "repeated": true, "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage." }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "type": "string", "location": "query" }, "filter": { "type": "string", "location": "query", "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)." }, "pageSize": { "type": "integer", "location": "query", "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}/locations", "httpMethod": "GET", "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.", "flatPath": "v1/projects/{projectsId}/locations" } }, "resources": { "connectionProfiles": { "methods": { "get": { "id": "datastream.projects.locations.connectionProfiles.get", "parameters": { "name": { "type": "string", "description": "Required. The name of the connection profile resource to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "ConnectionProfile" }, "httpMethod": "GET", "description": "Use this method to get details about a connection profile.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}" }, "discover": { "id": "datastream.projects.locations.connectionProfiles.discover", "path": "v1/{+parent}/connectionProfiles:discover", "parameterOrder": [ "parent" ], "request": { "$ref": "DiscoverConnectionProfileRequest" }, "parameters": { "parent": { "type": "string", "description": "Required. The parent resource of the connection profile type. Must be in the format `projects/*/locations/*`.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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.", "httpMethod": "POST", "response": { "$ref": "DiscoverConnectionProfileResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles:discover" }, "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "ConnectionProfile" }, "parameters": { "updateMask": { "location": "query", "type": "string", "format": "google-fieldmask", "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." }, "validateOnly": { "type": "boolean", "location": "query", "description": "Optional. Only validate the connection profile, but don't update any resources. The default is false." }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", "location": "path", "required": true, "description": "Output only. Identifier. The resource's name.", "type": "string" }, "requestId": { "location": "query", "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)." }, "force": { "location": "query", "type": "boolean", "description": "Optional. Update the connection profile without validating it." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "datastream.projects.locations.connectionProfiles.patch", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "description": "Use this method to update the parameters of a connection profile." }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles", "description": "Use this method to list connection profiles created in a project and location.", "httpMethod": "GET", "response": { "$ref": "ListConnectionProfilesResponse" }, "path": "v1/{+parent}/connectionProfiles", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent that owns the collection of connection profiles.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "pageSize": { "type": "integer", "location": "query", "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.", "format": "int32" }, "pageToken": { "location": "query", "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." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Order by fields for the result." }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter request." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.connectionProfiles.list" }, "create": { "id": "datastream.projects.locations.connectionProfiles.create", "parameters": { "connectionProfileId": { "description": "Required. The connection profile identifier.", "location": "query", "type": "string" }, "validateOnly": { "description": "Optional. Only validate the connection profile, but don't create any resources. The default is false.", "type": "boolean", "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": { "description": "Optional. Create the connection profile without validating it.", "location": "query", "type": "boolean" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent that owns the collection of ConnectionProfiles." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "ConnectionProfile" }, "path": "v1/{+parent}/connectionProfiles", "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Use this method to create a connection profile in a project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles" }, "delete": { "description": "Use this method to delete a connection profile.", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "id": "datastream.projects.locations.connectionProfiles.delete", "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", "type": "string", "description": "Required. The name of the connection profile resource to delete." }, "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" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "privateConnections": { "resources": { "routes": { "methods": { "create": { "httpMethod": "POST", "response": { "$ref": "Operation" }, "description": "Use this method to create a route for a private connectivity configuration in a project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes", "id": "datastream.projects.locations.privateConnections.routes.create", "parameterOrder": [ "parent" ], "request": { "$ref": "Route" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "location": "path", "required": true, "description": "Required. The parent that owns the collection of Routes.", "type": "string" }, "routeId": { "description": "Required. The Route identifier.", "type": "string", "location": "query" }, "requestId": { "type": "string", "location": "query", "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)." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/routes" }, "list": { "id": "datastream.projects.locations.privateConnections.routes.list", "path": "v1/{+parent}/routes", "parameterOrder": [ "parent" ], "parameters": { "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.", "type": "string", "location": "query" }, "orderBy": { "type": "string", "location": "query", "description": "Optional. Order by fields for the result." }, "filter": { "description": "Optional. Filter request.", "location": "query", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent that owns the collection of Routess.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$" }, "pageSize": { "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.", "format": "int32", "type": "integer", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Use this method to list routes created for a private connectivity configuration in a project and location.", "httpMethod": "GET", "response": { "$ref": "ListRoutesResponse" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes" }, "get": { "id": "datastream.projects.locations.privateConnections.routes.get", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+/routes/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the Route resource to get.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "GET", "response": { "$ref": "Route" }, "description": "Use this method to get details about a route.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}" }, "delete": { "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+/routes/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the Route resource to delete.", "type": "string" }, "requestId": { "type": "string", "location": "query", "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)." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.privateConnections.routes.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}", "description": "Use this method to delete a route.", "httpMethod": "DELETE", "response": { "$ref": "Operation" } } } } }, "methods": { "create": { "httpMethod": "POST", "response": { "$ref": "Operation" }, "description": "Use this method to create a private connectivity configuration.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", "id": "datastream.projects.locations.privateConnections.create", "parameterOrder": [ "parent" ], "request": { "$ref": "PrivateConnection" }, "parameters": { "validateOnly": { "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", "type": "boolean" }, "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent that owns the collection of PrivateConnections." }, "privateConnectionId": { "type": "string", "location": "query", "description": "Required. The private connectivity identifier." }, "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, will skip validations." }, "requestId": { "type": "string", "location": "query", "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)." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/privateConnections" }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", "description": "Use this method to list private connectivity configurations in a project and location.", "response": { "$ref": "ListPrivateConnectionsResponse" }, "httpMethod": "GET", "path": "v1/{+parent}/privateConnections", "parameters": { "filter": { "description": "Optional. Filter request.", "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.", "type": "string", "location": "query" }, "orderBy": { "description": "Optional. Order by fields for the result.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "description": "Required. The parent that owns the collection of private connectivity configurations.", "type": "string" }, "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.", "format": "int32", "type": "integer", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "datastream.projects.locations.privateConnections.list" }, "get": { "response": { "$ref": "PrivateConnection" }, "httpMethod": "GET", "description": "Use this method to get details about a private connectivity configuration.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", "id": "datastream.projects.locations.privateConnections.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the private connectivity configuration to get.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "delete": { "id": "datastream.projects.locations.privateConnections.delete", "path": "v1/{+name}", "parameters": { "requestId": { "type": "string", "location": "query", "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)." }, "name": { "description": "Required. The name of the private connectivity configuration to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "location": "path", "required": true }, "force": { "description": "Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.", "location": "query", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "description": "Use this method to delete a private connectivity configuration.", "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}" } } }, "operations": { "methods": { "list": { "response": { "$ref": "ListOperationsResponse" }, "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "id": "datastream.projects.locations.operations.list", "parameters": { "returnPartialSuccess": { "location": "query", "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." }, "name": { "type": "string", "description": "The name of the operation's parent resource.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "description": "The standard list page size.", "format": "int32", "type": "integer", "location": "query" }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}/operations" }, "cancel": { "path": "v1/{+name}:cancel", "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.operations.cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "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`.", "httpMethod": "POST", "response": { "$ref": "Empty" } }, "get": { "id": "datastream.projects.locations.operations.get", "parameters": { "name": { "type": "string", "description": "The name of the operation resource.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Operation" }, "httpMethod": "GET", "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" }, "delete": { "id": "datastream.projects.locations.operations.delete", "parameters": { "name": { "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "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`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}" } } }, "streams": { "methods": { "get": { "response": { "$ref": "Stream" }, "httpMethod": "GET", "description": "Use this method to get details about a stream.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}", "id": "datastream.projects.locations.streams.get", "parameters": { "name": { "description": "Required. The name of the stream resource to get.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1/{+name}" }, "run": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}:run", "response": { "$ref": "Operation" }, "httpMethod": "POST", "description": "Use this method to start, resume or recover a stream with a non default CDC strategy.", "parameters": { "name": { "description": "Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name}", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "RunStreamRequest" }, "path": "v1/{+name}:run", "id": "datastream.projects.locations.streams.run" }, "delete": { "parameterOrder": [ "name" ], "parameters": { "requestId": { "type": "string", "location": "query", "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)." }, "name": { "description": "Required. The name of the stream resource to delete.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "id": "datastream.projects.locations.streams.delete", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "description": "Use this method to delete a stream." }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams", "description": "Use this method to list streams in a project and location.", "httpMethod": "GET", "response": { "$ref": "ListStreamsResponse" }, "path": "v1/{+parent}/streams", "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent that owns the collection of streams." }, "pageSize": { "format": "int32", "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" }, "filter": { "type": "string", "location": "query", "description": "Optional. Filter request." }, "pageToken": { "type": "string", "location": "query", "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." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Order by fields for the result." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.streams.list" }, "create": { "id": "datastream.projects.locations.streams.create", "parameterOrder": [ "parent" ], "request": { "$ref": "Stream" }, "parameters": { "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. Only validate the stream, but don't create any resources. The default is false." }, "streamId": { "description": "Required. The stream identifier.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent that owns the collection of streams.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "requestId": { "type": "string", "location": "query", "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)." }, "force": { "description": "Optional. Create the stream without validating it.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/streams", "httpMethod": "POST", "response": { "$ref": "Operation" }, "description": "Use this method to create a stream.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams" }, "patch": { "id": "datastream.projects.locations.streams.patch", "parameterOrder": [ "name" ], "request": { "$ref": "Stream" }, "parameters": { "force": { "description": "Optional. Update the stream without validating it.", "location": "query", "type": "boolean" }, "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).", "type": "string", "location": "query" }, "name": { "description": "Output only. Identifier. The stream's name.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "location": "path", "required": true }, "updateMask": { "type": "string", "location": "query", "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.", "format": "google-fieldmask" }, "validateOnly": { "description": "Optional. Only validate the stream with the changes, without actually updating it. The default is false.", "type": "boolean", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+name}", "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "description": "Use this method to update the configuration of a stream.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}" } }, "resources": { "objects": { "methods": { "lookup": { "path": "v1/{+parent}/objects:lookup", "parameterOrder": [ "parent" ], "request": { "$ref": "LookupStreamObjectRequest" }, "parameters": { "parent": { "description": "Required. The parent stream that owns the collection of objects.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "location": "path", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.streams.objects.lookup", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects:lookup", "description": "Use this method to look up a stream object by its source object identifier.", "httpMethod": "POST", "response": { "$ref": "StreamObject" } }, "list": { "httpMethod": "GET", "response": { "$ref": "ListStreamObjectsResponse" }, "description": "Use this method to list the objects of a specific stream.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects", "id": "datastream.projects.locations.streams.objects.list", "parameterOrder": [ "parent" ], "parameters": { "parent": { "type": "string", "description": "Required. The parent stream that owns the collection of objects.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$" }, "pageSize": { "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", "type": "integer" }, "pageToken": { "location": "query", "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." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+parent}/objects" }, "stopBackfillJob": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:stopBackfillJob", "httpMethod": "POST", "response": { "$ref": "StopBackfillJobResponse" }, "description": "Use this method to stop a backfill job for the specified stream object.", "parameterOrder": [ "object" ], "request": { "$ref": "StopBackfillJobRequest" }, "parameters": { "object": { "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$", "location": "path", "required": true, "description": "Required. The name of the stream object resource to stop the backfill job for.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1/{+object}:stopBackfillJob", "id": "datastream.projects.locations.streams.objects.stopBackfillJob" }, "get": { "description": "Use this method to get details about a stream object.", "httpMethod": "GET", "response": { "$ref": "StreamObject" }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}", "id": "datastream.projects.locations.streams.objects.get", "path": "v1/{+name}", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the stream object resource to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "startBackfillJob": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:startBackfillJob", "response": { "$ref": "StartBackfillJobResponse" }, "httpMethod": "POST", "description": "Use this method to start a backfill job for the specified stream object.", "parameters": { "object": { "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$", "type": "string", "description": "Required. The name of the stream object resource to start a backfill job for." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "object" ], "request": { "$ref": "StartBackfillJobRequest" }, "path": "v1/{+object}:startBackfillJob", "id": "datastream.projects.locations.streams.objects.startBackfillJob" } } } } } } } } } }, "mtlsRootUrl": "https://datastream.mtls.googleapis.com/", "kind": "discovery#restDescription", "revision": "20260321", "id": "datastream:v1", "canonicalName": "Datastream", "documentationLink": "https://cloud.google.com/datastream/", "title": "Datastream API", "description": "", "servicePath": "", "version_module": true, "version": "v1", "rootUrl": "https://datastream.googleapis.com/", "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." } } } }, "ownerName": "Google", "endpoints": [ { "description": "Regional Endpoint", "location": "africa-south1", "endpointUrl": "https://datastream.africa-south1.rep.googleapis.com/" }, { "location": "asia-east1", "endpointUrl": "https://datastream.asia-east1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "asia-east2", "endpointUrl": "https://datastream.asia-east2.rep.googleapis.com/" }, { "location": "asia-northeast1", "endpointUrl": "https://datastream.asia-northeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "asia-northeast2", "endpointUrl": "https://datastream.asia-northeast2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "asia-northeast3", "endpointUrl": "https://datastream.asia-northeast3.rep.googleapis.com/" }, { "location": "asia-south1", "endpointUrl": "https://datastream.asia-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.asia-south2.rep.googleapis.com/", "location": "asia-south2" }, { "location": "asia-southeast1", "endpointUrl": "https://datastream.asia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "asia-southeast2", "endpointUrl": "https://datastream.asia-southeast2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.asia-southeast3.rep.googleapis.com/", "location": "asia-southeast3" }, { "location": "australia-southeast1", "endpointUrl": "https://datastream.australia-southeast1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.europe-central2.rep.googleapis.com/", "location": "europe-central2" }, { "description": "Regional Endpoint", "location": "europe-north1", "endpointUrl": "https://datastream.europe-north1.rep.googleapis.com/" }, { "location": "europe-north2", "endpointUrl": "https://datastream.europe-north2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-southwest1", "endpointUrl": "https://datastream.europe-southwest1.rep.googleapis.com/" }, { "location": "europe-west1", "endpointUrl": "https://datastream.europe-west1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.europe-west10.rep.googleapis.com/", "location": "europe-west10" }, { "endpointUrl": "https://datastream.europe-west12.rep.googleapis.com/", "location": "europe-west12", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.europe-west15.rep.googleapis.com/", "location": "europe-west15" }, { "location": "europe-west2", "endpointUrl": "https://datastream.europe-west2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-west3", "endpointUrl": "https://datastream.europe-west3.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.europe-west4.rep.googleapis.com/", "location": "europe-west4" }, { "location": "europe-west6", "endpointUrl": "https://datastream.europe-west6.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "europe-west8", "endpointUrl": "https://datastream.europe-west8.rep.googleapis.com/" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, { "endpointUrl": "https://datastream.me-central1.rep.googleapis.com/", "location": "me-central1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.me-central2.rep.googleapis.com/", "location": "me-central2" }, { "description": "Regional Endpoint", "location": "me-west1", "endpointUrl": "https://datastream.me-west1.rep.googleapis.com/" }, { "endpointUrl": "https://datastream.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "northamerica-northeast2", "endpointUrl": "https://datastream.northamerica-northeast2.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "northamerica-south1", "endpointUrl": "https://datastream.northamerica-south1.rep.googleapis.com/" }, { "description": "Regional Endpoint", "location": "southamerica-east1", "endpointUrl": "https://datastream.southamerica-east1.rep.googleapis.com/" }, { "endpointUrl": "https://datastream.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "endpointUrl": "https://datastream.us-central1.rep.googleapis.com/", "location": "us-central1" }, { "location": "us-central2", "endpointUrl": "https://datastream.us-central2.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-east1", "endpointUrl": "https://datastream.us-east1.rep.googleapis.com/", "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" }, { "location": "us-east7", "endpointUrl": "https://datastream.us-east7.rep.googleapis.com/", "description": "Regional Endpoint" }, { "location": "us-south1", "endpointUrl": "https://datastream.us-south1.rep.googleapis.com/", "description": "Regional Endpoint" }, { "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" }, { "location": "us-west3", "endpointUrl": "https://datastream.us-west3.rep.googleapis.com/", "description": "Regional Endpoint" }, { "description": "Regional Endpoint", "location": "us-west4", "endpointUrl": "https://datastream.us-west4.rep.googleapis.com/" }, { "endpointUrl": "https://datastream.us-west8.rep.googleapis.com/", "location": "us-west8", "description": "Regional Endpoint" } ], "discoveryVersion": "v1", "schemas": { "PostgresqlObjectIdentifier": { "id": "PostgresqlObjectIdentifier", "type": "object", "description": "PostgreSQL data source object identifier.", "properties": { "schema": { "description": "Required. The schema name.", "type": "string" }, "table": { "description": "Required. The table name.", "type": "string" } } }, "SalesforceOrg": { "id": "SalesforceOrg", "type": "object", "description": "Salesforce organization structure.", "properties": { "objects": { "description": "Salesforce objects in the database server.", "type": "array", "items": { "$ref": "SalesforceObject" } } } }, "MysqlRdbms": { "id": "MysqlRdbms", "type": "object", "description": "MySQL database structure", "properties": { "mysqlDatabases": { "description": "Mysql databases on the server", "type": "array", "items": { "$ref": "MysqlDatabase" } } } }, "PrivateConnectivity": { "id": "PrivateConnectivity", "type": "object", "description": "Private Connectivity", "properties": { "privateConnection": { "description": "Required. A reference to a private connection resource. Format: `projects/{project}/locations/{location}/privateConnections/{name}`", "type": "string" } } }, "BackfillJob": { "id": "BackfillJob", "type": "object", "description": "Represents a backfill job on a specific stream object.", "properties": { "state": { "type": "string", "description": "Output only. Backfill job state.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "NOT_STARTED", "PENDING", "ACTIVE", "STOPPED", "FAILED", "COMPLETED", "UNSUPPORTED" ], "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." ] }, "trigger": { "type": "string", "enum": [ "TRIGGER_UNSPECIFIED", "AUTOMATIC", "MANUAL" ], "description": "Backfill job's triggering reason.", "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": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Backfill job's start time." }, "lastEndTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Backfill job's end time." }, "errors": { "description": "Output only. Errors which caused the backfill job to fail.", "readOnly": true, "type": "array", "items": { "$ref": "Error" } } } }, "MongodbDatabase": { "id": "MongodbDatabase", "type": "object", "description": "MongoDB Database.", "properties": { "collections": { "description": "Collections in the database.", "type": "array", "items": { "$ref": "MongodbCollection" } }, "database": { "description": "The database name.", "type": "string" } } }, "SqlServerRdbms": { "description": "SQLServer database structure.", "properties": { "schemas": { "description": "SQLServer schemas in the database server.", "type": "array", "items": { "$ref": "SqlServerSchema" } } }, "id": "SqlServerRdbms", "type": "object" }, "Merge": { "id": "Merge", "type": "object", "description": "Merge mode defines that all changes to a table will be merged at the destination table.", "properties": {} }, "SqlServerSourceConfig": { "description": "Configuration for syncing data from a SQLServer source.", "properties": { "maxConcurrentBackfillTasks": { "type": "integer", "format": "int32", "description": "Max concurrent backfill tasks." }, "changeTables": { "description": "CDC reader reads from change tables.", "$ref": "SqlServerChangeTables" }, "transactionLogs": { "$ref": "SqlServerTransactionLogs", "description": "CDC reader reads from transaction logs." }, "includeObjects": { "description": "The SQLServer objects to include in the stream.", "$ref": "SqlServerRdbms" }, "excludeObjects": { "description": "The SQLServer objects to exclude from the stream.", "$ref": "SqlServerRdbms" }, "maxConcurrentCdcTasks": { "format": "int32", "description": "Max concurrent CDC tasks.", "type": "integer" } }, "id": "SqlServerSourceConfig", "type": "object" }, "ResourceInfo": { "description": "Describes the resource that is being accessed.", "properties": { "resourceType": { "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\".", "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": { "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" } }, "id": "ResourceInfo", "type": "object" }, "Validation": { "id": "Validation", "type": "object", "description": "A validation to perform on a stream.", "properties": { "code": { "description": "A custom code identifying this validation.", "type": "string" }, "description": { "description": "A short description of the validation.", "type": "string" }, "state": { "enumDescriptions": [ "Unspecified state.", "Validation did not execute.", "Validation failed.", "Validation passed.", "Validation executed with warnings." ], "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "NOT_EXECUTED", "FAILED", "PASSED", "WARNING" ], "description": "Output only. Validation execution status.", "type": "string" }, "message": { "description": "Messages reflecting the validation results.", "type": "array", "items": { "$ref": "ValidationMessage" } } } }, "CustomizationRule": { "id": "CustomizationRule", "type": "object", "description": "A customization rule to apply to a set of objects.", "properties": { "bigqueryClustering": { "description": "BigQuery clustering rule.", "$ref": "BigQueryClustering" }, "bigqueryPartitioning": { "description": "BigQuery partitioning rule.", "$ref": "BigQueryPartitioning" } } }, "Help": { "id": "Help", "type": "object", "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.", "properties": { "links": { "type": "array", "items": { "$ref": "Link" }, "description": "URL(s) pointing to additional information on handling the current error." } } }, "Route": { "description": "The route resource is the child of the private connection resource, used for defining a route for a private connection.", "properties": { "destinationPort": { "type": "integer", "format": "int32", "description": "Destination port for connection" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The update time of the resource." }, "labels": { "description": "Labels.", "additionalProperties": { "type": "string" }, "type": "object" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The create time of the resource.", "format": "google-datetime" }, "destinationAddress": { "description": "Required. Destination address for connection", "type": "string" }, "displayName": { "description": "Required. Display name.", "type": "string" }, "name": { "description": "Output only. Identifier. The resource's name.", "readOnly": true, "type": "string" } }, "id": "Route", "type": "object" }, "PostgresqlSourceConfig": { "id": "PostgresqlSourceConfig", "type": "object", "description": "Configuration for syncing data from a PostgreSQL source.", "properties": { "maxConcurrentBackfillTasks": { "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.", "type": "integer" }, "includeObjects": { "$ref": "PostgresqlRdbms", "description": "The PostgreSQL objects to include in the stream." }, "excludeObjects": { "$ref": "PostgresqlRdbms", "description": "The PostgreSQL objects to exclude from the stream." }, "replicationSlot": { "description": "Required. Immutable. The name of the logical replication slot that's configured with the pgoutput plugin.", "type": "string" }, "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" } } }, "AppendOnly": { "description": "AppendOnly mode defines that all changes to a table will be written to the destination table.", "properties": {}, "id": "AppendOnly", "type": "object" }, "PostgresqlRdbms": { "description": "PostgreSQL database structure.", "properties": { "postgresqlSchemas": { "type": "array", "items": { "$ref": "PostgresqlSchema" }, "description": "PostgreSQL schemas in the database server." } }, "id": "PostgresqlRdbms", "type": "object" }, "RunStreamRequest": { "description": "Request message for running a stream.", "properties": { "cdcStrategy": { "description": "Optional. The CDC strategy of the stream. If not set, the system's default value will be used.", "$ref": "CdcStrategy" }, "force": { "description": "Optional. Update the stream without validating it.", "type": "boolean" } }, "id": "RunStreamRequest", "type": "object" }, "SpannerColumn": { "description": "Spanner column.", "properties": { "dataType": { "description": "Optional. Spanner data type.", "type": "string" }, "column": { "description": "Required. The column name.", "type": "string" }, "ordinalPosition": { "description": "Optional. The ordinal position of the column in the table.", "format": "int64", "type": "string" }, "isPrimaryKey": { "description": "Optional. Whether or not the column is a primary key.", "type": "boolean" } }, "id": "SpannerColumn", "type": "object" }, "DatasetTemplate": { "id": "DatasetTemplate", "type": "object", "description": "Dataset template used for dynamic dataset creation.", "properties": { "location": { "description": "Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", "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" }, "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" } } }, "ListPrivateConnectionsResponse": { "id": "ListPrivateConnectionsResponse", "type": "object", "description": "Response containing a list of private connection configurations.", "properties": { "privateConnections": { "type": "array", "items": { "$ref": "PrivateConnection" }, "description": "List of private connectivity configurations." }, "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" } } }, "ListRoutesResponse": { "description": "Route list response.", "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" }, "routes": { "description": "List of Routes.", "type": "array", "items": { "$ref": "Route" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "id": "ListRoutesResponse", "type": "object" }, "OracleProfile": { "description": "Profile for connecting to an Oracle source.", "properties": { "connectionAttributes": { "description": "Connection string attributes", "additionalProperties": { "type": "string" }, "type": "object" }, "hostname": { "description": "Required. Hostname for the Oracle connection.", "type": "string" }, "oracleAsmConfig": { "$ref": "OracleAsmConfig", "description": "Optional. Configuration for Oracle ASM connection." }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field.", "type": "string" }, "port": { "description": "Port for the Oracle connection, default value is 1521.", "format": "int32", "type": "integer" }, "password": { "description": "Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "username": { "description": "Required. Username for the Oracle connection.", "type": "string" }, "databaseService": { "description": "Required. Database for the Oracle connection.", "type": "string" }, "oracleSslConfig": { "$ref": "OracleSslConfig", "description": "Optional. SSL configuration for the Oracle connection." } }, "id": "OracleProfile", "type": "object" }, "MongodbCluster": { "description": "MongoDB Cluster structure.", "properties": { "databases": { "type": "array", "items": { "$ref": "MongodbDatabase" }, "description": "MongoDB databases in the cluster." } }, "id": "MongodbCluster", "type": "object" }, "MysqlGtidPosition": { "description": "MySQL GTID position", "properties": { "gtidSet": { "description": "Required. The gtid set to start replication from.", "type": "string" } }, "id": "MysqlGtidPosition", "type": "object" }, "PrivateConnection": { "id": "PrivateConnection", "type": "object", "description": "The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.", "properties": { "displayName": { "description": "Required. Display name.", "type": "string" }, "createTime": { "description": "Output only. The create time of the resource.", "format": "google-datetime", "readOnly": true, "type": "string" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "vpcPeeringConfig": { "description": "VPC Peering Config.", "$ref": "VpcPeeringConfig" }, "labels": { "type": "object", "description": "Labels.", "additionalProperties": { "type": "string" } }, "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The resource's name." }, "error": { "$ref": "Error", "readOnly": true, "description": "Output only. In case of error, the details of the error in a user-friendly format." }, "updateTime": { "description": "Output only. The update time of the resource.", "format": "google-datetime", "readOnly": true, "type": "string" }, "state": { "type": "string", "description": "Output only. The state of the Private Connection.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "FAILED", "DELETING", "FAILED_TO_DELETE" ], "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." ] }, "pscInterfaceConfig": { "description": "PSC Interface Config.", "$ref": "PscInterfaceConfig" }, "satisfiesPzs": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "locations": { "type": "array", "items": { "$ref": "Location" }, "description": "A list of locations that matches the specified filter in the request." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "SpannerProfile": { "id": "SpannerProfile", "type": "object", "description": "Profile for connecting to a Spanner source.", "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" } } }, "ForwardSshTunnelConnectivity": { "id": "ForwardSshTunnelConnectivity", "type": "object", "description": "Forward SSH Tunnel connectivity.", "properties": { "hostname": { "description": "Required. Hostname for the SSH tunnel.", "type": "string" }, "username": { "description": "Required. Username for the SSH tunnel.", "type": "string" }, "port": { "type": "integer", "description": "Port for the SSH tunnel, default value is 22.", "format": "int32" }, "password": { "description": "Input only. SSH password.", "type": "string" }, "privateKey": { "description": "Input only. SSH private key.", "type": "string" } } }, "SrvConnectionFormat": { "description": "Srv connection format.", "properties": {}, "id": "SrvConnectionFormat", "type": "object" }, "MostRecentStartPosition": { "description": "CDC strategy to start replicating from the most recent position in the source.", "properties": {}, "id": "MostRecentStartPosition", "type": "object" }, "OracleAsmLogFileAccess": { "id": "OracleAsmLogFileAccess", "type": "object", "description": "Configuration to use Oracle ASM to access the log files.", "properties": {} }, "MongodbSslConfig": { "id": "MongodbSslConfig", "type": "object", "description": "MongoDB SSL configuration information.", "properties": { "clientKey": { "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.", "type": "string" }, "clientCertificateSet": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the client_certificate field is set." }, "caCertificateSet": { "description": "Output only. Indicates whether the ca_certificate field is set.", "readOnly": true, "type": "boolean" }, "caCertificate": { "description": "Optional. Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.", "type": "string" }, "clientKeySet": { "description": "Output only. Indicates whether the client_key field is set.", "readOnly": true, "type": "boolean" }, "secretManagerStoredClientKey": { "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.", "type": "string" }, "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" } } }, "SourceConfig": { "description": "The configuration of the stream source.", "properties": { "oracleSourceConfig": { "description": "Oracle data source configuration.", "$ref": "OracleSourceConfig" }, "spannerSourceConfig": { "description": "Spanner data source configuration.", "$ref": "SpannerSourceConfig" }, "sourceConnectionProfile": { "description": "Required. Source connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`", "type": "string" }, "mysqlSourceConfig": { "$ref": "MysqlSourceConfig", "description": "MySQL data source configuration." }, "salesforceSourceConfig": { "$ref": "SalesforceSourceConfig", "description": "Salesforce data source configuration." }, "postgresqlSourceConfig": { "$ref": "PostgresqlSourceConfig", "description": "PostgreSQL data source configuration." }, "sqlServerSourceConfig": { "$ref": "SqlServerSourceConfig", "description": "SQLServer data source configuration." }, "mongodbSourceConfig": { "$ref": "MongodbSourceConfig", "description": "MongoDB data source configuration." } }, "id": "SourceConfig", "type": "object" }, "SqlServerColumn": { "description": "SQLServer Column.", "properties": { "precision": { "type": "integer", "format": "int32", "description": "Column precision." }, "ordinalPosition": { "type": "integer", "description": "The ordinal position of the column in the table.", "format": "int32" }, "dataType": { "description": "The SQLServer data type.", "type": "string" }, "length": { "format": "int32", "description": "Column length.", "type": "integer" }, "scale": { "description": "Column scale.", "format": "int32", "type": "integer" }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "column": { "description": "The column name.", "type": "string" } }, "id": "SqlServerColumn", "type": "object" }, "ErrorInfo": { "id": "ErrorInfo", "type": "object", "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\" } }", "properties": { "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "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" }, "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" } } }, "ServerVerification": { "id": "ServerVerification", "type": "object", "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.", "properties": { "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" }, "caCertificate": { "description": "Required. Input only. PEM-encoded server root CA certificate.", "type": "string" } } }, "MongodbChangeStreamPosition": { "description": "MongoDB change stream position", "properties": { "startTime": { "format": "google-datetime", "description": "Required. The timestamp to start change stream from.", "type": "string" } }, "id": "MongodbChangeStreamPosition", "type": "object" }, "SourceObjectIdentifier": { "id": "SourceObjectIdentifier", "type": "object", "description": "Represents an identifier of an object in the data source.", "properties": { "postgresqlIdentifier": { "$ref": "PostgresqlObjectIdentifier", "description": "PostgreSQL data source object identifier." }, "sqlServerIdentifier": { "description": "SQLServer data source object identifier.", "$ref": "SqlServerObjectIdentifier" }, "mongodbIdentifier": { "description": "MongoDB data source object identifier.", "$ref": "MongodbObjectIdentifier" }, "oracleIdentifier": { "description": "Oracle data source object identifier.", "$ref": "OracleObjectIdentifier" }, "salesforceIdentifier": { "description": "Salesforce data source object identifier.", "$ref": "SalesforceObjectIdentifier" }, "mysqlIdentifier": { "$ref": "MysqlObjectIdentifier", "description": "Mysql data source object identifier." }, "spannerIdentifier": { "$ref": "SpannerObjectIdentifier", "description": "Spanner data source object identifier." } } }, "Oauth2ClientCredentials": { "id": "Oauth2ClientCredentials", "type": "object", "description": "OAuth2 Client Credentials.", "properties": { "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" }, "clientSecret": { "description": "Optional. Client secret for Salesforce OAuth2 Client Credentials. Mutually exclusive with the `secret_manager_stored_client_secret` field.", "type": "string" } } }, "BadRequest": { "id": "BadRequest", "type": "object", "description": "Describes violations in a client request. This error type focuses on the syntactic aspects of the request.", "properties": { "fieldViolations": { "description": "Describes all violations in a client request.", "type": "array", "items": { "$ref": "FieldViolation" } } } }, "StaticServiceIpConnectivity": { "id": "StaticServiceIpConnectivity", "type": "object", "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.", "properties": {} }, "MongodbCollection": { "id": "MongodbCollection", "type": "object", "description": "MongoDB Collection.", "properties": { "fields": { "description": "Fields in the collection.", "type": "array", "items": { "$ref": "MongodbField" } }, "collection": { "description": "The collection name.", "type": "string" } } }, "MongodbSourceConfig": { "id": "MongodbSourceConfig", "type": "object", "description": "Configuration for syncing data from a MongoDB source.", "properties": { "maxConcurrentBackfillTasks": { "type": "integer", "format": "int32", "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" }, "includeObjects": { "description": "The MongoDB collections to include in the stream.", "$ref": "MongodbCluster" }, "excludeObjects": { "description": "The MongoDB collections to exclude from the stream.", "$ref": "MongodbCluster" }, "jsonMode": { "type": "string", "enum": [ "MONGODB_JSON_MODE_UNSPECIFIED", "STRICT", "CANONICAL" ], "description": "Optional. MongoDB JSON mode to use for the stream.", "enumDescriptions": [ "Unspecified JSON mode.", "Strict JSON mode.", "Canonical JSON mode." ] } } }, "NextAvailableStartPosition": { "description": "CDC strategy to resume replication from the next available position in the source.", "properties": {}, "id": "NextAvailableStartPosition", "type": "object" }, "OracleColumn": { "id": "OracleColumn", "type": "object", "description": "Oracle Column.", "properties": { "scale": { "format": "int32", "description": "Column scale.", "type": "integer" }, "ordinalPosition": { "type": "integer", "description": "The ordinal position of the column in the table.", "format": "int32" }, "precision": { "type": "integer", "format": "int32", "description": "Column precision." }, "dataType": { "description": "The Oracle data type.", "type": "string" }, "length": { "type": "integer", "format": "int32", "description": "Column length." }, "column": { "description": "The column name.", "type": "string" }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "encoding": { "description": "Column encoding.", "type": "string" } } }, "MongodbProfile": { "description": "Profile for connecting to a MongoDB source.", "properties": { "username": { "description": "Required. Username for the MongoDB connection.", "type": "string" }, "password": { "description": "Optional. Password for the MongoDB connection. Mutually exclusive with the `secret_manager_stored_password` field.", "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" }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field.", "type": "string" }, "standardConnectionFormat": { "$ref": "StandardConnectionFormat", "description": "Standard connection format." }, "sslConfig": { "$ref": "MongodbSslConfig", "description": "Optional. SSL configuration for the MongoDB connection." }, "srvConnectionFormat": { "$ref": "SrvConnectionFormat", "description": "Srv connection format." }, "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "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" } } }, "id": "MongodbProfile", "type": "object" }, "PostgresqlTable": { "id": "PostgresqlTable", "type": "object", "description": "PostgreSQL table.", "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." } } }, "HostAddress": { "id": "HostAddress", "type": "object", "description": "A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number.", "properties": { "hostname": { "description": "Required. Hostname for the connection.", "type": "string" }, "port": { "type": "integer", "format": "int32", "description": "Optional. Port for the connection." } } }, "MongodbField": { "id": "MongodbField", "type": "object", "description": "MongoDB Field.", "properties": { "field": { "description": "The field name.", "type": "string" } } }, "MysqlColumn": { "description": "MySQL Column.", "properties": { "scale": { "format": "int32", "description": "Column scale.", "type": "integer" }, "dataType": { "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", "type": "string" }, "length": { "format": "int32", "description": "Column length.", "type": "integer" }, "ordinalPosition": { "type": "integer", "description": "The ordinal position of the column in the table.", "format": "int32" }, "precision": { "format": "int32", "description": "Column precision.", "type": "integer" }, "column": { "description": "The column name.", "type": "string" }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "collation": { "description": "Column collation.", "type": "string" } }, "id": "MysqlColumn", "type": "object" }, "SqlServerChangeTables": { "id": "SqlServerChangeTables", "type": "object", "description": "Configuration to use Change Tables CDC read method.", "properties": {} }, "SqlServerTable": { "description": "SQLServer table.", "properties": { "table": { "description": "The table name.", "type": "string" }, "columns": { "type": "array", "items": { "$ref": "SqlServerColumn" }, "description": "SQLServer columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything." } }, "id": "SqlServerTable", "type": "object" }, "BigQueryClustering": { "id": "BigQueryClustering", "type": "object", "description": "BigQuery clustering configuration.", "properties": { "columns": { "description": "Required. Column names to set as clustering columns.", "type": "array", "items": { "type": "string" } } } }, "OracleAsmConfig": { "description": "Configuration for Oracle Automatic Storage Management (ASM) connection.", "properties": { "hostname": { "description": "Required. Hostname for the Oracle ASM connection.", "type": "string" }, "username": { "description": "Required. Username for the Oracle ASM connection.", "type": "string" }, "oracleSslConfig": { "description": "Optional. SSL configuration for the Oracle connection.", "$ref": "OracleSslConfig" }, "asmService": { "description": "Required. ASM service name for the Oracle ASM connection.", "type": "string" }, "port": { "description": "Required. Port for the Oracle ASM connection.", "format": "int32", "type": "integer" }, "connectionAttributes": { "description": "Optional. Connection string attributes", "additionalProperties": { "type": "string" }, "type": "object" }, "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" }, "password": { "description": "Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" } }, "id": "OracleAsmConfig", "type": "object" }, "GcsProfile": { "description": "Profile for connecting to a Cloud Storage destination.", "properties": { "bucket": { "description": "Required. The Cloud Storage bucket name.", "type": "string" }, "rootPath": { "description": "Optional. The root path inside the Cloud Storage bucket.", "type": "string" } }, "id": "GcsProfile", "type": "object" }, "GcsDestinationConfig": { "description": "Google Cloud Storage destination configuration", "properties": { "avroFileFormat": { "description": "AVRO file format configuration.", "$ref": "AvroFileFormat" }, "jsonFileFormat": { "$ref": "JsonFileFormat", "description": "JSON file format configuration." }, "fileRotationMb": { "type": "integer", "format": "int32", "description": "The maximum file size to be saved in the bucket." }, "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.", "format": "google-duration", "type": "string" }, "path": { "description": "Path inside the Cloud Storage bucket to write data to.", "type": "string" } }, "id": "GcsDestinationConfig", "type": "object" }, "Status": { "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).", "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "message": { "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.", "type": "string" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "id": "Status", "type": "object" }, "StreamLargeObjects": { "description": "Configuration to stream large object values.", "properties": {}, "id": "StreamLargeObjects", "type": "object" }, "SqlServerTransactionLogs": { "description": "Configuration to use Transaction Logs CDC read method.", "properties": {}, "id": "SqlServerTransactionLogs", "type": "object" }, "SpecificStartPosition": { "description": "CDC strategy to start replicating from a specific position in the source.", "properties": { "mongodbChangeStreamPosition": { "$ref": "MongodbChangeStreamPosition", "description": "MongoDB change stream position to start replicating from." }, "mysqlGtidPosition": { "description": "MySQL GTID set to start replicating from.", "$ref": "MysqlGtidPosition" }, "mysqlLogPosition": { "description": "MySQL specific log position to start replicating from.", "$ref": "MysqlLogPosition" }, "oracleScnPosition": { "$ref": "OracleScnPosition", "description": "Oracle SCN to start replicating from." }, "sqlServerLsnPosition": { "description": "SqlServer LSN to start replicating from.", "$ref": "SqlServerLsnPosition" } }, "id": "SpecificStartPosition", "type": "object" }, "MysqlLogPosition": { "description": "MySQL log position", "properties": { "logFile": { "description": "Required. The binary log file name.", "type": "string" }, "logPosition": { "type": "integer", "description": "Optional. The position within the binary log file. Default is head of file.", "format": "int32" } }, "id": "MysqlLogPosition", "type": "object" }, "EncryptionAndServerValidation": { "id": "EncryptionAndServerValidation", "type": "object", "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.", "properties": { "caCertificate": { "description": "Optional. Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.", "type": "string" }, "serverCertificateHostname": { "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.", "type": "string" } } }, "StopBackfillJobResponse": { "description": "Response for manually stop a backfill job for a specific stream object.", "properties": { "object": { "description": "The stream object resource the backfill job was stopped for.", "$ref": "StreamObject" } }, "id": "StopBackfillJobResponse", "type": "object" }, "RuleSet": { "id": "RuleSet", "type": "object", "description": "A set of rules to apply to a set of objects.", "properties": { "customizationRules": { "description": "Required. List of customization rules to apply.", "type": "array", "items": { "$ref": "CustomizationRule" } }, "objectFilter": { "description": "Required. Object filter to apply the customization rules to.", "$ref": "ObjectFilter" } } }, "OracleScnPosition": { "description": "Oracle SCN position", "properties": { "scn": { "description": "Required. SCN number from where Logs will be read", "format": "int64", "type": "string" } }, "id": "OracleScnPosition", "type": "object" }, "QuotaFailure": { "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.", "properties": { "violations": { "description": "Describes all quota violations.", "type": "array", "items": { "$ref": "QuotaFailureViolation" } } }, "id": "QuotaFailure", "type": "object" }, "StopBackfillJobRequest": { "description": "Request for manually stopping a running backfill job for a specific stream object.", "properties": {}, "id": "StopBackfillJobRequest", "type": "object" }, "SourceHierarchyDatasets": { "id": "SourceHierarchyDatasets", "type": "object", "description": "Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy.", "properties": { "datasetTemplate": { "$ref": "DatasetTemplate", "description": "The dataset template to use for dynamic dataset creation." }, "projectId": { "description": "Optional. The project id of the BigQuery dataset. If not specified, the project will be inferred from the stream resource.", "type": "string" } } }, "DebugInfo": { "description": "Describes additional debugging info.", "properties": { "stackEntries": { "type": "array", "items": { "type": "string" }, "description": "The stack trace entries indicating where the error occurred." }, "detail": { "description": "Additional debugging information provided by the server.", "type": "string" } }, "id": "DebugInfo", "type": "object" }, "OracleRdbms": { "id": "OracleRdbms", "type": "object", "description": "Oracle database structure.", "properties": { "oracleSchemas": { "description": "Oracle schemas/databases in the database server.", "type": "array", "items": { "$ref": "OracleSchema" } } } }, "QuotaFailureViolation": { "description": "A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.", "properties": { "quotaValue": { "type": "string", "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.", "format": "int64" }, "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" }, "subject": { "description": "The subject on which the quota check failed. For example, \"clientip:\" or \"project:\".", "type": "string" }, "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" }, "quotaDimensions": { "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.", "additionalProperties": { "type": "string" }, "type": "object" }, "apiService": { "description": "The API Service from which the `QuotaFailure.Violation` orginates. 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" }, "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" }, "futureQuotaValue": { "type": "string", "format": "int64", "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." } }, "id": "QuotaFailureViolation", "type": "object" }, "SalesforceField": { "id": "SalesforceField", "type": "object", "description": "Salesforce field.", "properties": { "nillable": { "description": "Indicates whether the field can accept nil values.", "type": "boolean" }, "dataType": { "description": "The data type.", "type": "string" }, "name": { "description": "The field name.", "type": "string" } } }, "MysqlSslConfig": { "id": "MysqlSslConfig", "type": "object", "description": "MySQL SSL configuration information.", "properties": { "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" }, "caCertificate": { "description": "Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.", "type": "string" }, "clientKeySet": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the client_key field is set." }, "clientKey": { "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.", "type": "string" }, "clientCertificateSet": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the client_certificate field is set." }, "caCertificateSet": { "readOnly": true, "type": "boolean", "description": "Output only. Indicates whether the ca_certificate field is set." } } }, "MysqlObjectIdentifier": { "id": "MysqlObjectIdentifier", "type": "object", "description": "Mysql data source object identifier.", "properties": { "database": { "description": "Required. The database name.", "type": "string" }, "table": { "description": "Required. The table name.", "type": "string" } } }, "SpannerSourceConfig": { "id": "SpannerSourceConfig", "type": "object", "description": "Configuration for syncing data from a Spanner source.", "properties": { "spannerRpcPriority": { "description": "Optional. The RPC priority to use for the stream.", "enumDescriptions": [ "Unspecified RPC priority.", "Low RPC priority.", "Medium RPC priority.", "High RPC priority." ], "type": "string", "enum": [ "SPANNER_RPC_PRIORITY_UNSPECIFIED", "LOW", "MEDIUM", "HIGH" ] }, "includeObjects": { "description": "Optional. The Spanner objects to retrieve from the data source. If some objects are both included and excluded, an error will be thrown.", "$ref": "SpannerDatabase" }, "excludeObjects": { "$ref": "SpannerDatabase", "description": "Optional. The Spanner objects to avoid retrieving. If some objects are both included and excluded, an error will be thrown." }, "maxConcurrentCdcTasks": { "type": "integer", "description": "Optional. Maximum number of concurrent CDC tasks.", "format": "int32" }, "fgacRole": { "description": "Optional. The FGAC role to use for the stream.", "type": "string" }, "backfillDataBoostEnabled": { "description": "Optional. Whether to use Data Boost for Spanner backfills. Defaults to false if not set.", "type": "boolean" }, "changeStreamName": { "description": "Required. Immutable. The change stream name to use for the stream.", "type": "string" }, "maxConcurrentBackfillTasks": { "description": "Optional. Maximum number of concurrent backfill tasks.", "format": "int32", "type": "integer" } } }, "ListConnectionProfilesResponse": { "description": "Response message for listing connection profiles.", "properties": { "connectionProfiles": { "type": "array", "items": { "$ref": "ConnectionProfile" }, "description": "List of connection profiles." }, "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" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "id": "ListConnectionProfilesResponse", "type": "object" }, "FetchStaticIpsResponse": { "description": "Response message for a 'FetchStaticIps' response.", "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", "type": "object" }, "PostgresqlSslConfig": { "description": "PostgreSQL SSL configuration information.", "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": { "$ref": "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." } }, "id": "PostgresqlSslConfig", "type": "object" }, "JsonFileFormat": { "description": "JSON file format configuration.", "properties": { "schemaFileFormat": { "type": "string", "enum": [ "SCHEMA_FILE_FORMAT_UNSPECIFIED", "NO_SCHEMA_FILE", "AVRO_SCHEMA_FILE" ], "description": "The schema file format along JSON data files.", "enumDescriptions": [ "Unspecified schema file format.", "Do not attach schema file.", "Avro schema format." ] }, "compression": { "description": "Compression of the loaded JSON file.", "enumDescriptions": [ "Unspecified json file compression.", "Do not compress JSON file.", "Gzip compression." ], "type": "string", "enum": [ "JSON_COMPRESSION_UNSPECIFIED", "NO_COMPRESSION", "GZIP" ] } }, "id": "JsonFileFormat", "type": "object" }, "LogFileDirectories": { "description": "Configuration to specify the Oracle directories to access the log files.", "properties": { "onlineLogDirectory": { "description": "Required. Oracle directory for online logs.", "type": "string" }, "archivedLogDirectory": { "description": "Required. Oracle directory for archived logs.", "type": "string" } }, "id": "LogFileDirectories", "type": "object" }, "OracleTable": { "description": "Oracle table.", "properties": { "table": { "description": "The table name.", "type": "string" }, "oracleColumns": { "description": "Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.", "type": "array", "items": { "$ref": "OracleColumn" } } }, "id": "OracleTable", "type": "object" }, "IntegerRangePartition": { "description": "Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range", "properties": { "column": { "description": "Required. The partitioning column.", "type": "string" }, "interval": { "type": "string", "format": "int64", "description": "Required. The interval of each range within the partition." }, "start": { "type": "string", "format": "int64", "description": "Required. The starting value for range partitioning (inclusive)." }, "end": { "type": "string", "description": "Required. The ending value for range partitioning (exclusive).", "format": "int64" } }, "id": "IntegerRangePartition", "type": "object" }, "ObjectFilter": { "description": "Object filter to apply the rules to.", "properties": { "sourceObjectIdentifier": { "$ref": "SourceObjectIdentifier", "description": "Specific source object identifier." } }, "id": "ObjectFilter", "type": "object" }, "EventFilter": { "id": "EventFilter", "type": "object", "description": "Represents a filter for included data on a stream object.", "properties": { "sqlWhereClause": { "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'`", "type": "string" } } }, "StartBackfillJobResponse": { "id": "StartBackfillJobResponse", "type": "object", "description": "Response for manually initiating a backfill job for a specific stream object.", "properties": { "object": { "$ref": "StreamObject", "description": "The stream object resource a backfill job was started for." } } }, "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); }", "properties": {}, "id": "Empty", "type": "object" }, "SpannerDatabase": { "id": "SpannerDatabase", "type": "object", "description": "Spanner database structure.", "properties": { "schemas": { "type": "array", "items": { "$ref": "SpannerSchema" }, "description": "Optional. Spanner schemas in the database." } } }, "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.", "properties": { "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" }, "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" }, "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" }, "caCertificate": { "description": "Required. Input only. PEM-encoded server root CA certificate.", "type": "string" } }, "id": "ServerAndClientVerification", "type": "object" }, "SqlServerSslConfig": { "id": "SqlServerSslConfig", "type": "object", "description": "SQL Server SSL configuration information.", "properties": { "encryptionAndServerValidation": { "description": "If set, Datastream will enforce encryption and authenticate server identity.", "$ref": "EncryptionAndServerValidation" }, "encryptionNotEnforced": { "$ref": "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." }, "basicEncryption": { "description": "If set, Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default.", "$ref": "BasicEncryption" } } }, "BlmtConfig": { "description": "The configuration for BLMT.", "properties": { "bucket": { "description": "Required. The Cloud Storage bucket name.", "type": "string" }, "connectionName": { "description": "Required. The bigquery connection. Format: `{project}.{location}.{name}`", "type": "string" }, "tableFormat": { "description": "Required. The table format.", "enumDescriptions": [ "Default value.", "Iceberg table format." ], "type": "string", "enum": [ "TABLE_FORMAT_UNSPECIFIED", "ICEBERG" ] }, "fileFormat": { "type": "string", "enum": [ "FILE_FORMAT_UNSPECIFIED", "PARQUET" ], "description": "Required. The file format.", "enumDescriptions": [ "Default value.", "Parquet file format." ] }, "rootPath": { "description": "The root path inside the Cloud Storage bucket.", "type": "string" } }, "id": "BlmtConfig", "type": "object" }, "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.", "properties": { "retryDelay": { "type": "string", "description": "Clients should wait at least this long between retrying the same request.", "format": "google-duration" } }, "id": "RetryInfo", "type": "object" }, "BackfillAllStrategy": { "description": "Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.", "properties": { "oracleExcludedObjects": { "description": "Oracle data source objects to avoid backfilling.", "$ref": "OracleRdbms" }, "sqlServerExcludedObjects": { "description": "SQLServer data source objects to avoid backfilling", "$ref": "SqlServerRdbms" }, "postgresqlExcludedObjects": { "description": "PostgreSQL data source objects to avoid backfilling.", "$ref": "PostgresqlRdbms" }, "mongodbExcludedObjects": { "$ref": "MongodbCluster", "description": "MongoDB data source objects to avoid backfilling" }, "mysqlExcludedObjects": { "$ref": "MysqlRdbms", "description": "MySQL data source objects to avoid backfilling." }, "salesforceExcludedObjects": { "$ref": "SalesforceOrg", "description": "Salesforce data source objects to avoid backfilling" }, "spannerExcludedObjects": { "description": "Spanner data source objects to avoid backfilling.", "$ref": "SpannerDatabase" } }, "id": "BackfillAllStrategy", "type": "object" }, "EncryptionNotEnforced": { "id": "EncryptionNotEnforced", "type": "object", "description": "Message to represent the option where encryption is not enforced. An empty message right now to allow future extensibility.", "properties": {} }, "LocalizedMessage": { "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error.", "properties": { "locale": { "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\"", "type": "string" }, "message": { "description": "The localized error message in the above locale.", "type": "string" } }, "id": "LocalizedMessage", "type": "object" }, "Link": { "description": "Describes a URL link.", "properties": { "description": { "description": "Describes what the link offers.", "type": "string" }, "url": { "description": "The URL of the link.", "type": "string" } }, "id": "Link", "type": "object" }, "SalesforceProfile": { "description": "Profile for connecting to a Salesforce source.", "properties": { "userCredentials": { "description": "User-password authentication.", "$ref": "UserCredentials" }, "oauth2ClientCredentials": { "$ref": "Oauth2ClientCredentials", "description": "Connected app authentication." }, "domain": { "description": "Required. Domain endpoint for the Salesforce connection.", "type": "string" } }, "id": "SalesforceProfile", "type": "object" }, "PostgresqlColumn": { "id": "PostgresqlColumn", "type": "object", "description": "PostgreSQL Column.", "properties": { "column": { "description": "The column name.", "type": "string" }, "scale": { "format": "int32", "description": "Column scale.", "type": "integer" }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "ordinalPosition": { "type": "integer", "description": "The ordinal position of the column in the table.", "format": "int32" }, "precision": { "type": "integer", "format": "int32", "description": "Column precision." }, "dataType": { "description": "The PostgreSQL data type.", "type": "string" }, "length": { "description": "Column length.", "format": "int32", "type": "integer" } } }, "BackfillNoneStrategy": { "id": "BackfillNoneStrategy", "type": "object", "description": "Backfill strategy to disable automatic backfill for the Stream's objects.", "properties": {} }, "SalesforceObject": { "description": "Salesforce object.", "properties": { "objectName": { "description": "The object name.", "type": "string" }, "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." } }, "id": "SalesforceObject", "type": "object" }, "DiscoverConnectionProfileRequest": { "id": "DiscoverConnectionProfileRequest", "type": "object", "description": "Request message for 'discover' ConnectionProfile request.", "properties": { "postgresqlRdbms": { "description": "Optional. PostgreSQL RDBMS to enrich with child data objects and metadata.", "$ref": "PostgresqlRdbms" }, "sqlServerRdbms": { "description": "Optional. SQLServer RDBMS to enrich with child data objects and metadata.", "$ref": "SqlServerRdbms" }, "spannerDatabase": { "description": "Optional. Spanner database to enrich with child data objects and metadata.", "$ref": "SpannerDatabase" }, "connectionProfile": { "$ref": "ConnectionProfile", "description": "Optional. An ad-hoc connection profile configuration." }, "oracleRdbms": { "$ref": "OracleRdbms", "description": "Optional. Oracle RDBMS to enrich with child data objects and metadata." }, "fullHierarchy": { "description": "Optional. Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).", "type": "boolean" }, "connectionProfileName": { "description": "Optional. A reference to an existing connection profile.", "type": "string" }, "mongodbCluster": { "$ref": "MongodbCluster", "description": "Optional. MongoDB cluster to enrich with child data objects and metadata." }, "salesforceOrg": { "$ref": "SalesforceOrg", "description": "Optional. Salesforce organization to enrich with child data objects and metadata." }, "mysqlRdbms": { "description": "Optional. MySQL RDBMS to enrich with child data objects and metadata.", "$ref": "MysqlRdbms" }, "hierarchyDepth": { "type": "integer", "format": "int32", "description": "Optional. The number of hierarchy levels below the current level to be retrieved." } } }, "ValidationResult": { "description": "Contains the current validation results.", "properties": { "validations": { "type": "array", "items": { "$ref": "Validation" }, "description": "A list of validations (includes both executed as well as not executed validations)." } }, "id": "ValidationResult", "type": "object" }, "BigQueryProfile": { "description": "Profile for connecting to a BigQuery destination.", "properties": {}, "id": "BigQueryProfile", "type": "object" }, "PostgresqlProfile": { "id": "PostgresqlProfile", "type": "object", "description": "Profile for connecting to a PostgreSQL source.", "properties": { "hostname": { "description": "Required. Hostname for the PostgreSQL connection.", "type": "string" }, "username": { "description": "Required. Username for the PostgreSQL connection.", "type": "string" }, "password": { "description": "Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "database": { "description": "Required. Database for the PostgreSQL connection.", "type": "string" }, "sslConfig": { "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)", "$ref": "PostgresqlSslConfig" }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the PostgreSQL connection password. Mutually exclusive with the `password` field.", "type": "string" }, "port": { "type": "integer", "format": "int32", "description": "Port for the PostgreSQL connection, default value is 5432." } } }, "BasicEncryption": { "id": "BasicEncryption", "type": "object", "description": "Message to represent the option where Datastream will enforce encryption without authenticating server identity. Server certificates will be trusted by default.", "properties": {} }, "UserCredentials": { "id": "UserCredentials", "type": "object", "description": "Username-password credentials.", "properties": { "username": { "description": "Required. Username for the Salesforce connection.", "type": "string" }, "password": { "description": "Optional. Password for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" }, "secretManagerStoredSecurityToken": { "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's security token. Mutually exclusive with the `security_token` field.", "type": "string" }, "securityToken": { "description": "Optional. Security token for the Salesforce connection. Mutually exclusive with the `secret_manager_stored_security_token` field.", "type": "string" }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the Salesforce connection's password. Mutually exclusive with the `password` field.", "type": "string" } } }, "OracleSourceConfig": { "id": "OracleSourceConfig", "type": "object", "description": "Configuration for syncing data from an Oracle source.", "properties": { "maxConcurrentCdcTasks": { "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.", "format": "int32", "type": "integer" }, "includeObjects": { "description": "The Oracle objects to include in the stream.", "$ref": "OracleRdbms" }, "excludeObjects": { "description": "The Oracle objects to exclude from the stream.", "$ref": "OracleRdbms" }, "dropLargeObjects": { "description": "Drop large object values.", "$ref": "DropLargeObjects" }, "binaryLogParser": { "description": "Use Binary Log Parser.", "$ref": "BinaryLogParser" }, "maxConcurrentBackfillTasks": { "type": "integer", "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.", "format": "int32" }, "streamLargeObjects": { "description": "Stream large object values.", "$ref": "StreamLargeObjects" }, "logMiner": { "description": "Use LogMiner.", "$ref": "LogMiner" } } }, "SqlServerProfile": { "id": "SqlServerProfile", "type": "object", "description": "Profile for connecting to a SQLServer source.", "properties": { "database": { "description": "Required. Database for the SQLServer connection.", "type": "string" }, "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", "description": "Port for the SQLServer connection, default value is 1433.", "format": "int32" }, "secretManagerStoredPassword": { "description": "Optional. A reference to a Secret Manager resource name storing the SQLServer connection password. Mutually exclusive with the `password` field.", "type": "string" }, "hostname": { "description": "Required. Hostname for the SQLServer connection.", "type": "string" }, "username": { "description": "Required. Username for the SQLServer connection.", "type": "string" } } }, "SpannerTable": { "description": "Spanner table.", "properties": { "table": { "description": "Required. The table name.", "type": "string" }, "columns": { "description": "Optional. Spanner columns in the table.", "type": "array", "items": { "$ref": "SpannerColumn" } } }, "id": "SpannerTable", "type": "object" }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "properties": { "createTime": { "format": "google-datetime", "description": "Output only. The time the operation was created.", "readOnly": true, "type": "string" }, "requestedCancellation": { "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`.", "readOnly": true, "type": "boolean" }, "endTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The time the operation finished running." }, "verb": { "readOnly": true, "type": "string", "description": "Output only. Name of the verb executed by the operation." }, "validationResult": { "description": "Output only. Results of executed validations if there are any.", "$ref": "ValidationResult", "readOnly": true }, "target": { "readOnly": true, "type": "string", "description": "Output only. Server-defined resource path for the target of the operation." }, "apiVersion": { "readOnly": true, "type": "string", "description": "Output only. API version used to start the operation." }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." } }, "id": "OperationMetadata", "type": "object" }, "ValidationMessage": { "description": "Represent user-facing validation result message.", "properties": { "metadata": { "description": "Additional metadata related to the result.", "additionalProperties": { "type": "string" }, "type": "object" }, "level": { "type": "string", "enum": [ "LEVEL_UNSPECIFIED", "WARNING", "ERROR" ], "description": "Message severity level (warning or error).", "enumDescriptions": [ "Unspecified level.", "Potentially cause issues with the Stream.", "Definitely cause issues with the Stream." ] }, "code": { "description": "A custom code identifying this specific message.", "type": "string" }, "message": { "description": "The result of the validation.", "type": "string" } }, "id": "ValidationMessage", "type": "object" }, "SalesforceObjectIdentifier": { "description": "Salesforce data source object identifier.", "properties": { "objectName": { "description": "Required. The object name.", "type": "string" } }, "id": "SalesforceObjectIdentifier", "type": "object" }, "OracleSchema": { "description": "Oracle schema.", "properties": { "schema": { "description": "The schema name.", "type": "string" }, "oracleTables": { "description": "Tables in the schema.", "type": "array", "items": { "$ref": "OracleTable" } } }, "id": "OracleSchema", "type": "object" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "unreachable": { "type": "array", "items": { "type": "string" }, "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." }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "ListOperationsResponse", "type": "object" }, "CancelOperationRequest": { "id": "CancelOperationRequest", "type": "object", "description": "The request message for Operations.CancelOperation.", "properties": {} }, "VpcPeeringConfig": { "description": "The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.", "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" } }, "id": "VpcPeeringConfig", "type": "object" }, "SqlServerSchema": { "id": "SqlServerSchema", "type": "object", "description": "SQLServer schema.", "properties": { "schema": { "description": "The schema name.", "type": "string" }, "tables": { "type": "array", "items": { "$ref": "SqlServerTable" }, "description": "Tables in the schema." } } }, "StartBackfillJobRequest": { "id": "StartBackfillJobRequest", "type": "object", "description": "Request for manually initiating a backfill job for a specific stream 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 Server sources." } } }, "AvroFileFormat": { "description": "AVRO file format configuration.", "properties": {}, "id": "AvroFileFormat", "type": "object" }, "PostgresqlSchema": { "description": "PostgreSQL schema.", "properties": { "schema": { "description": "The schema name.", "type": "string" }, "postgresqlTables": { "description": "Tables in the schema.", "type": "array", "items": { "$ref": "PostgresqlTable" } } }, "id": "PostgresqlSchema", "type": "object" }, "FieldViolation": { "id": "FieldViolation", "type": "object", "description": "A message type used to describe a single bad request field.", "properties": { "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" }, "description": { "description": "A description of why the request element is bad.", "type": "string" }, "reason": { "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.", "type": "string" }, "localizedMessage": { "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer.", "$ref": "LocalizedMessage" } } }, "TimeUnitPartition": { "description": "Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables", "properties": { "column": { "description": "Required. The partitioning column.", "type": "string" }, "partitioningTimeGranularity": { "type": "string", "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.", "enumDescriptions": [ "Unspecified partitioing interval.", "Hourly partitioning.", "Daily partitioning.", "Monthly partitioning.", "Yearly partitioning." ] } }, "id": "TimeUnitPartition", "type": "object" }, "MysqlSourceConfig": { "id": "MysqlSourceConfig", "type": "object", "description": "Configuration for syncing data from a MySQL source.", "properties": { "maxConcurrentBackfillTasks": { "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.", "type": "integer" }, "gtid": { "description": "Use GTID based replication.", "$ref": "Gtid" }, "includeObjects": { "$ref": "MysqlRdbms", "description": "The MySQL objects to retrieve from the source." }, "excludeObjects": { "$ref": "MysqlRdbms", "description": "The MySQL objects to exclude from the stream." }, "maxConcurrentCdcTasks": { "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.", "type": "integer" }, "binaryLogPosition": { "$ref": "BinaryLogPosition", "description": "Use Binary log position based replication." } } }, "Error": { "description": "Represent a user-facing Error.", "properties": { "reason": { "description": "A title that explains the reason for the error.", "type": "string" }, "details": { "type": "object", "description": "Additional information about the error.", "additionalProperties": { "type": "string" } }, "errorUuid": { "description": "A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.", "type": "string" }, "message": { "description": "A message containing more information about the error that occurred.", "type": "string" }, "errorTime": { "format": "google-datetime", "description": "The time when the error occurred.", "type": "string" } }, "id": "Error", "type": "object" }, "BigQueryDestinationConfig": { "id": "BigQueryDestinationConfig", "type": "object", "description": "BigQuery destination configuration", "properties": { "merge": { "description": "The standard mode", "$ref": "Merge" }, "singleTargetDataset": { "description": "Single destination dataset.", "$ref": "SingleTargetDataset" }, "blmtConfig": { "$ref": "BlmtConfig", "description": "Optional. Big Lake Managed Tables (BLMT) configuration." }, "appendOnly": { "description": "Append only mode", "$ref": "AppendOnly" }, "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.", "format": "google-duration", "type": "string" }, "sourceHierarchyDatasets": { "$ref": "SourceHierarchyDatasets", "description": "Source hierarchy datasets." } } }, "SpannerObjectIdentifier": { "id": "SpannerObjectIdentifier", "type": "object", "description": "Spanner data source object identifier.", "properties": { "schema": { "description": "Optional. The schema name.", "type": "string" }, "table": { "description": "Required. The table name.", "type": "string" } } }, "SqlServerObjectIdentifier": { "id": "SqlServerObjectIdentifier", "type": "object", "description": "SQLServer data source object identifier.", "properties": { "schema": { "description": "Required. The schema name.", "type": "string" }, "table": { "description": "Required. The table name.", "type": "string" } } }, "PscInterfaceConfig": { "id": "PscInterfaceConfig", "type": "object", "description": "The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer's PSC.", "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" } } }, "Stream": { "description": "A resource representing streaming data from a source to a destination.", "properties": { "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The stream's name." }, "ruleSets": { "type": "array", "items": { "$ref": "RuleSet" }, "description": "Optional. Rule sets to apply to the stream." }, "destinationConfig": { "description": "Required. Destination connection profile configuration.", "$ref": "DestinationConfig" }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" }, "displayName": { "description": "Required. Display name.", "type": "string" }, "createTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The creation time of the stream." }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "sourceConfig": { "$ref": "SourceConfig", "description": "Required. Source connection profile configuration." }, "backfillNone": { "description": "Do not automatically backfill any objects.", "$ref": "BackfillNoneStrategy" }, "errors": { "readOnly": true, "type": "array", "items": { "$ref": "Error" }, "description": "Output only. Errors on the Stream." }, "updateTime": { "format": "google-datetime", "description": "Output only. The last update time of the stream.", "readOnly": true, "type": "string" }, "state": { "type": "string", "enum": [ "STATE_UNSPECIFIED", "NOT_STARTED", "RUNNING", "PAUSED", "MAINTENANCE", "FAILED", "FAILED_PERMANENTLY", "STARTING", "DRAINING" ], "description": "The state of the stream.", "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." ] }, "lastRecoveryTime": { "description": "Output only. If the stream was recovered, the time of the last recovery. Note: This field is currently experimental.", "format": "google-datetime", "readOnly": true, "type": "string" }, "backfillAll": { "description": "Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.", "$ref": "BackfillAllStrategy" }, "labels": { "type": "object", "description": "Labels.", "additionalProperties": { "type": "string" } }, "customerManagedEncryptionKey": { "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.", "type": "string" } }, "id": "Stream", "type": "object" }, "BinaryLogParser": { "id": "BinaryLogParser", "type": "object", "description": "Configuration to use Binary Log Parser CDC technique.", "properties": { "oracleAsmLogFileAccess": { "$ref": "OracleAsmLogFileAccess", "description": "Use Oracle ASM." }, "logFileDirectories": { "description": "Use Oracle directories.", "$ref": "LogFileDirectories" } } }, "Gtid": { "description": "Use GTID based replication.", "properties": {}, "id": "Gtid", "type": "object" }, "ConnectionProfile": { "description": "A set of reusable connection configurations to be used as a source or destination for a stream.", "properties": { "mysqlProfile": { "$ref": "MysqlProfile", "description": "Profile for connecting to a MySQL source." }, "labels": { "type": "object", "description": "Labels.", "additionalProperties": { "type": "string" } }, "mongodbProfile": { "$ref": "MongodbProfile", "description": "Profile for connecting to a MongoDB source." }, "postgresqlProfile": { "description": "Profile for connecting to a PostgreSQL source.", "$ref": "PostgresqlProfile" }, "updateTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. The update time of the resource." }, "bigqueryProfile": { "description": "Profile for connecting to a BigQuery destination.", "$ref": "BigQueryProfile" }, "salesforceProfile": { "$ref": "SalesforceProfile", "description": "Profile for connecting to a Salesforce source." }, "displayName": { "description": "Required. Display name.", "type": "string" }, "oracleProfile": { "description": "Profile for connecting to an Oracle source.", "$ref": "OracleProfile" }, "forwardSshConnectivity": { "$ref": "ForwardSshTunnelConnectivity", "description": "Forward SSH tunnel connectivity." }, "createTime": { "format": "google-datetime", "description": "Output only. The create time of the resource.", "readOnly": true, "type": "string" }, "satisfiesPzi": { "readOnly": true, "type": "boolean", "description": "Output only. Reserved for future use." }, "gcsProfile": { "description": "Profile for connecting to a Cloud Storage destination.", "$ref": "GcsProfile" }, "privateConnectivity": { "$ref": "PrivateConnectivity", "description": "Private connectivity." }, "sqlServerProfile": { "description": "Profile for connecting to a SQLServer source.", "$ref": "SqlServerProfile" }, "name": { "description": "Output only. Identifier. The resource's name.", "readOnly": true, "type": "string" }, "spannerProfile": { "description": "Profile for connecting to a Spanner source.", "$ref": "SpannerProfile" }, "staticServiceIpConnectivity": { "$ref": "StaticServiceIpConnectivity", "description": "Static Service IP connectivity." }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, "type": "boolean" } }, "id": "ConnectionProfile", "type": "object" }, "MysqlTable": { "id": "MysqlTable", "type": "object", "description": "MySQL table.", "properties": { "mysqlColumns": { "description": "MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.", "type": "array", "items": { "$ref": "MysqlColumn" } }, "table": { "description": "The table name.", "type": "string" } } }, "MysqlDatabase": { "id": "MysqlDatabase", "type": "object", "description": "MySQL database.", "properties": { "database": { "description": "The database name.", "type": "string" }, "mysqlTables": { "type": "array", "items": { "$ref": "MysqlTable" }, "description": "Tables in the database." } } }, "ListStreamsResponse": { "id": "ListStreamsResponse", "type": "object", "description": "Response message for listing streams.", "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" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "streams": { "description": "List of streams", "type": "array", "items": { "$ref": "Stream" } } } }, "CdcStrategy": { "description": "The strategy that the stream uses for CDC replication.", "properties": { "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" }, "mostRecentStartPosition": { "description": "Optional. Start replicating from the most recent position in the source.", "$ref": "MostRecentStartPosition" } }, "id": "CdcStrategy", "type": "object" }, "OracleObjectIdentifier": { "id": "OracleObjectIdentifier", "type": "object", "description": "Oracle data source object identifier.", "properties": { "schema": { "description": "Required. The schema name.", "type": "string" }, "table": { "description": "Required. The table name.", "type": "string" } } }, "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.", "properties": { "violations": { "description": "Describes all precondition violations.", "type": "array", "items": { "$ref": "PreconditionFailureViolation" } } }, "id": "PreconditionFailure", "type": "object" }, "MysqlProfile": { "id": "MysqlProfile", "type": "object", "description": "Profile for connecting to a MySQL source.", "properties": { "hostname": { "description": "Required. Hostname for the MySQL connection.", "type": "string" }, "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": { "description": "Optional. A reference to a Secret Manager resource name storing the MySQL connection password. Mutually exclusive with the `password` field.", "type": "string" }, "sslConfig": { "$ref": "MysqlSslConfig", "description": "SSL configuration for the MySQL connection." }, "password": { "description": "Optional. Input only. Password for the MySQL connection. Mutually exclusive with the `secret_manager_stored_password` field.", "type": "string" } } }, "SalesforceSourceConfig": { "description": "Configuration for syncing data from a Salesforce source.", "properties": { "includeObjects": { "$ref": "SalesforceOrg", "description": "The Salesforce objects to retrieve from the source." }, "excludeObjects": { "description": "The Salesforce objects to exclude from the stream.", "$ref": "SalesforceOrg" }, "pollingInterval": { "type": "string", "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.", "format": "google-duration" } }, "id": "SalesforceSourceConfig", "type": "object" }, "BigQueryPartitioning": { "description": "BigQuery partitioning configuration.", "properties": { "integerRangePartition": { "description": "Integer range partitioning.", "$ref": "IntegerRangePartition" }, "timeUnitPartition": { "description": "Time unit column partitioning.", "$ref": "TimeUnitPartition" }, "ingestionTimePartition": { "description": "Ingestion time partitioning.", "$ref": "IngestionTimePartition" }, "requirePartitionFilter": { "description": "Optional. If true, queries over the table require a partition filter.", "type": "boolean" } }, "id": "BigQueryPartitioning", "type": "object" }, "LogMiner": { "description": "Configuration to use LogMiner CDC method.", "properties": {}, "id": "LogMiner", "type": "object" }, "MongodbObjectIdentifier": { "id": "MongodbObjectIdentifier", "type": "object", "description": "MongoDB data source object identifier.", "properties": { "database": { "description": "Required. The database name.", "type": "string" }, "collection": { "description": "Required. The collection name.", "type": "string" } } }, "SpannerSchema": { "description": "Spanner schema.", "properties": { "tables": { "description": "Optional. Spanner tables in the schema.", "type": "array", "items": { "$ref": "SpannerTable" } }, "schema": { "description": "Required. The schema name.", "type": "string" } }, "id": "SpannerSchema", "type": "object" }, "Operation": { "id": "Operation", "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "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" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "type": "object", "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`.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "type": "object", "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.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "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" } } }, "SqlServerLsnPosition": { "id": "SqlServerLsnPosition", "type": "object", "description": "SQL Server LSN position", "properties": { "lsn": { "description": "Required. Log sequence number (LSN) from where Logs will be read", "type": "string" } } }, "Location": { "id": "Location", "type": "object", "description": "A resource that represents a Google Cloud location.", "properties": { "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" }, "type": "object" }, "metadata": { "type": "object", "description": "Service-specific metadata. For example the available capacity at the given location.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" } } }, "DiscoverConnectionProfileResponse": { "id": "DiscoverConnectionProfileResponse", "type": "object", "description": "Response from a discover request.", "properties": { "oracleRdbms": { "description": "Enriched Oracle RDBMS object.", "$ref": "OracleRdbms" }, "salesforceOrg": { "description": "Enriched Salesforce organization.", "$ref": "SalesforceOrg" }, "postgresqlRdbms": { "$ref": "PostgresqlRdbms", "description": "Enriched PostgreSQL RDBMS object." }, "sqlServerRdbms": { "$ref": "SqlServerRdbms", "description": "Enriched SQLServer RDBMS object." }, "spannerDatabase": { "$ref": "SpannerDatabase", "description": "Enriched Spanner database." }, "mongodbCluster": { "$ref": "MongodbCluster", "description": "Enriched MongoDB cluster." }, "mysqlRdbms": { "$ref": "MysqlRdbms", "description": "Enriched MySQL RDBMS object." } } }, "LookupStreamObjectRequest": { "id": "LookupStreamObjectRequest", "type": "object", "description": "Request for looking up a specific stream object by its source object identifier.", "properties": { "sourceObjectIdentifier": { "description": "Required. The source object identifier which maps to the stream object.", "$ref": "SourceObjectIdentifier" } } }, "RequestInfo": { "id": "RequestInfo", "type": "object", "description": "Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.", "properties": { "requestId": { "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.", "type": "string" }, "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" } } }, "DestinationConfig": { "id": "DestinationConfig", "type": "object", "description": "The configuration of the stream destination.", "properties": { "destinationConnectionProfile": { "description": "Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`", "type": "string" }, "gcsDestinationConfig": { "$ref": "GcsDestinationConfig", "description": "A configuration for how data should be loaded to Cloud Storage." }, "bigqueryDestinationConfig": { "$ref": "BigQueryDestinationConfig", "description": "BigQuery destination configuration." } } }, "IngestionTimePartition": { "id": "IngestionTimePartition", "type": "object", "description": "Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time", "properties": { "partitioningTimeGranularity": { "type": "string", "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", "enumDescriptions": [ "Unspecified partitioing interval.", "Hourly partitioning.", "Daily partitioning.", "Monthly partitioning.", "Yearly partitioning." ] } } }, "StandardConnectionFormat": { "description": "Standard connection format.", "properties": { "directConnection": { "deprecated": true, "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." } }, "id": "StandardConnectionFormat", "type": "object" }, "DropLargeObjects": { "id": "DropLargeObjects", "type": "object", "description": "Configuration to drop large object values.", "properties": {} }, "BinaryLogPosition": { "id": "BinaryLogPosition", "type": "object", "description": "Use Binary log position based replication.", "properties": {} }, "StreamObject": { "id": "StreamObject", "type": "object", "description": "A specific stream object (e.g a specific DB table).", "properties": { "updateTime": { "description": "Output only. The last update time of the object.", "format": "google-datetime", "readOnly": true, "type": "string" }, "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" }, "backfillJob": { "description": "The latest backfill job that was initiated for the stream object.", "$ref": "BackfillJob" }, "sourceObject": { "description": "The object identifier in the data source.", "$ref": "SourceObjectIdentifier" }, "name": { "readOnly": true, "type": "string", "description": "Output only. Identifier. The object resource's name." }, "createTime": { "format": "google-datetime", "description": "Output only. The creation time of the object.", "readOnly": true, "type": "string" }, "errors": { "description": "Output only. Active errors on the object.", "readOnly": true, "type": "array", "items": { "$ref": "Error" } } } }, "OracleSslConfig": { "id": "OracleSslConfig", "type": "object", "description": "Oracle SSL configuration information.", "properties": { "serverCertificateDistinguishedName": { "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.", "type": "string" }, "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.", "readOnly": true, "type": "boolean" } } }, "ListStreamObjectsResponse": { "id": "ListStreamObjectsResponse", "type": "object", "description": "Response containing the objects for a stream.", "properties": { "streamObjects": { "type": "array", "items": { "$ref": "StreamObject" }, "description": "List of stream objects." }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.", "type": "string" } } }, "PreconditionFailureViolation": { "id": "PreconditionFailureViolation", "type": "object", "description": "A message type used to describe a single precondition failure.", "properties": { "description": { "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\".", "type": "string" }, "subject": { "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.", "type": "string" }, "type": { "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\".", "type": "string" } } }, "SingleTargetDataset": { "description": "A single target dataset to which all data will be streamed.", "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" } }, "id": "SingleTargetDataset", "type": "object" } }, "batchPath": "batch", "fullyEncodeReservedExpansion": true, "name": "datastream", "ownerDomain": "google.com", "protocol": "rest" }