{ "canonicalName": "Datastream", "rootUrl": "https://datastream.googleapis.com/", "discoveryVersion": "v1", "version_module": true, "title": "Datastream API", "resources": { "projects": { "resources": { "locations": { "methods": { "fetchStaticIps": { "id": "datastream.projects.locations.fetchStaticIps", "description": "The FetchStaticIps API call exposes the static IP addresses used by Datastream.", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "Maximum number of Ips to return, will likely not be specified.", "location": "query" }, "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The name resource of the Response type. Must be in the format `projects/*/locations/*`.", "location": "path" }, "pageToken": { "type": "string", "description": "A page token, received from a previous `ListStaticIps` call. will likely not be specified.", "location": "query" } }, "deprecated": true, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:fetchStaticIps", "response": { "$ref": "FetchStaticIpsResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:fetchStaticIps", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Location" }, "id": "datastream.projects.locations.get", "description": "Gets information about a location.", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Resource name for the location.", "location": "path" } } }, "list": { "path": "v1alpha1/{+name}/locations", "response": { "$ref": "ListLocationsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32", "type": "integer" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+$" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageToken": { "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query" } }, "id": "datastream.projects.locations.list", "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.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations" } }, "resources": { "streams": { "methods": { "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.streams.get", "description": "Use this method to get details about a stream.", "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "description": "Required. The name of the stream resource to get.", "location": "path" } }, "parameterOrder": [ "name" ], "deprecated": true, "path": "v1alpha1/{+name}", "response": { "$ref": "Stream" } }, "create": { "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent that owns the collection of streams.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "streamId": { "description": "Required. The stream identifier.", "location": "query", "type": "string" }, "force": { "type": "boolean", "description": "Optional. Create the stream without validating it.", "location": "query" }, "validateOnly": { "description": "Optional. Only validate the stream, but do not create any resources. The default is false.", "location": "query", "type": "boolean" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "request": { "$ref": "Stream" }, "id": "datastream.projects.locations.streams.create", "description": "Use this method to create a stream.", "path": "v1alpha1/{+parent}/streams", "response": { "$ref": "Operation" }, "deprecated": true, "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { "deprecated": true, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" }, "id": "datastream.projects.locations.streams.patch", "description": "Use this method to update the configuration of a stream.", "httpMethod": "PATCH", "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query" }, "force": { "type": "boolean", "description": "Optional. Execute the update without validating it.", "location": "query" }, "validateOnly": { "description": "Optional. Only validate the stream with the changes, without actually updating it. The default is false.", "location": "query", "type": "boolean" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "required": true, "description": "Output only. The stream's name.", "location": "path" }, "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" } }, "request": { "$ref": "Stream" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}" }, "list": { "parameterOrder": [ "parent" ], "deprecated": true, "path": "v1alpha1/{+parent}/streams", "response": { "$ref": "ListStreamsResponse" }, "id": "datastream.projects.locations.streams.list", "description": "Use this method to list streams in a project and location.", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent that owns the collection of streams.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "pageSize": { "type": "integer", "format": "int32", "description": "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" }, "orderBy": { "type": "string", "description": "Order by fields for the result.", "location": "query" }, "pageToken": { "description": "Page token received from a previous `ListStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreams` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "description": "Filter request.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams" }, "fetchErrors": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}:fetchErrors", "parameterOrder": [ "stream" ], "deprecated": true, "path": "v1alpha1/{+stream}:fetchErrors", "response": { "$ref": "Operation" }, "id": "datastream.projects.locations.streams.fetchErrors", "description": "Use this method to fetch any errors associated with a stream.", "httpMethod": "POST", "parameters": { "stream": { "description": "Name of the Stream resource for which to fetch any errors.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "type": "string" } }, "request": { "$ref": "FetchErrorsRequest" } }, "delete": { "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "deprecated": true, "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the stream resource to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "type": "string", "required": true }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "id": "datastream.projects.locations.streams.delete", "description": "Use this method to delete a stream.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}" } }, "resources": { "objects": { "methods": { "stopBackfillJob": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:stopBackfillJob", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "object": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$", "required": true, "description": "Required. The name of the stream object resource to stop the backfill job for.", "location": "path" } }, "id": "datastream.projects.locations.streams.objects.stopBackfillJob", "description": "Stops the backfill job for the specified stream object.", "path": "v1alpha1/{+object}:stopBackfillJob", "response": { "$ref": "StopBackfillJobResponse" }, "deprecated": true, "parameterOrder": [ "object" ] }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}", "parameterOrder": [ "name" ], "deprecated": true, "path": "v1alpha1/{+name}", "response": { "$ref": "StreamObject" }, "id": "datastream.projects.locations.streams.objects.get", "description": "Use this method to get details about a stream object.", "httpMethod": "GET", "parameters": { "name": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$", "description": "Required. The name of the stream object resource to get.", "location": "path" } } }, "list": { "deprecated": true, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/objects", "response": { "$ref": "ListStreamObjectsResponse" }, "id": "datastream.projects.locations.streams.objects.list", "description": "Use this method to list the objects of a specific stream.", "httpMethod": "GET", "parameters": { "pageToken": { "type": "string", "description": "Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreamObjectsRequest` must match the call that provided the page token.", "location": "query" }, "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+$", "required": true, "description": "Required. The parent stream that owns the collection of objects.", "location": "path" }, "pageSize": { "format": "int32", "type": "integer", "description": "Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects" }, "startBackfillJob": { "httpMethod": "POST", "parameters": { "object": { "pattern": "^projects/[^/]+/locations/[^/]+/streams/[^/]+/objects/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the stream object resource to start a backfill job for.", "location": "path" } }, "id": "datastream.projects.locations.streams.objects.startBackfillJob", "description": "Starts backfill job for the specified stream object.", "path": "v1alpha1/{+object}:startBackfillJob", "response": { "$ref": "StartBackfillJobResponse" }, "parameterOrder": [ "object" ], "deprecated": true, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/streams/{streamsId}/objects/{objectsId}:startBackfillJob", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "deprecated": true } } }, "connectionProfiles": { "deprecated": true, "methods": { "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.connectionProfiles.get", "description": "Use this method to get details about a connection profile.", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the connection profile resource to get.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", "type": "string" } }, "deprecated": true, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "ConnectionProfile" } }, "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/connectionProfiles", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent that owns the collection of ConnectionProfiles.", "location": "path" }, "connectionProfileId": { "description": "Required. The connection profile identifier.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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" } }, "request": { "$ref": "ConnectionProfile" }, "id": "datastream.projects.locations.connectionProfiles.create", "description": "Use this method to create a connection profile in a project and location.", "path": "v1alpha1/{+parent}/connectionProfiles", "response": { "$ref": "Operation" }, "parameterOrder": [ "parent" ], "deprecated": true }, "discover": { "deprecated": true, "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/connectionProfiles:discover", "response": { "$ref": "DiscoverConnectionProfileResponse" }, "id": "datastream.projects.locations.connectionProfiles.discover", "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 under a parent data object that's optionally supplied in the request.", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent resource of the ConnectionProfile type. Must be in the format `projects/*/locations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true } }, "request": { "$ref": "DiscoverConnectionProfileRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/connectionProfiles:discover" }, "patch": { "id": "datastream.projects.locations.connectionProfiles.patch", "description": "Use this method to update the parameters of a connection profile.", "httpMethod": "PATCH", "parameters": { "name": { "description": "Output only. The resource's name.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "validateOnly": { "type": "boolean", "description": "Optional. Only validate the connection profile, but do not update any resources. The default is false.", "location": "query" } }, "request": { "$ref": "ConnectionProfile" }, "deprecated": true, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" }, "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "path": "v1alpha1/{+parent}/connectionProfiles", "response": { "$ref": "ListConnectionProfilesResponse" }, "parameterOrder": [ "parent" ], "deprecated": true, "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent that owns the collection of connection profiles.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "required": true }, "pageSize": { "description": "Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32", "type": "integer" }, "orderBy": { "type": "string", "description": "Order by fields for the result.", "location": "query" }, "pageToken": { "type": "string", "description": "Page token received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.", "location": "query" }, "filter": { "description": "Filter request.", "location": "query", "type": "string" } }, "id": "datastream.projects.locations.connectionProfiles.list", "description": "Use this method to list connection profiles created in a project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/connectionProfiles" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/connectionProfiles/{connectionProfilesId}", "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" }, "deprecated": true, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the connection profile resource to delete.", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/connectionProfiles/[^/]+$", "type": "string" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" } }, "id": "datastream.projects.locations.connectionProfiles.delete", "description": "Use this method to delete a connection profile.." } } }, "privateConnections": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", "parameterOrder": [ "name" ], "deprecated": true, "path": "v1alpha1/{+name}", "response": { "$ref": "PrivateConnection" }, "id": "datastream.projects.locations.privateConnections.get", "description": "Use this method to get details about a private connectivity configuration.", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "type": "string", "description": "Required. The name of the private connectivity configuration to get.", "location": "path" } } }, "list": { "path": "v1alpha1/{+parent}/privateConnections", "response": { "$ref": "ListPrivateConnectionsResponse" }, "deprecated": true, "parameterOrder": [ "parent" ], "httpMethod": "GET", "parameters": { "filter": { "description": "Filter request.", "location": "query", "type": "string" }, "pageToken": { "description": "Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. The parent that owns the collection of private connectivity configurations.", "location": "path" }, "pageSize": { "type": "integer", "format": "int32", "description": "Maximum number of private connectivity configurations to return. If unspecified, at most 50 private connectivity configurations that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query" }, "orderBy": { "description": "Order by fields for the result.", "location": "query", "type": "string" } }, "id": "datastream.projects.locations.privateConnections.list", "description": "Use this method to list private connectivity configurations in a project and location.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections" }, "create": { "parameterOrder": [ "parent" ], "deprecated": true, "path": "v1alpha1/{+parent}/privateConnections", "response": { "$ref": "Operation" }, "id": "datastream.projects.locations.privateConnections.create", "description": "Use this method to create a private connectivity configuration.", "httpMethod": "POST", "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string", "description": "Required. The parent that owns the collection of PrivateConnections.", "location": "path" }, "privateConnectionId": { "description": "Required. The private connectivity identifier.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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" } }, "request": { "$ref": "PrivateConnection" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections" }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.privateConnections.delete", "description": "Use this method to delete a private connectivity configuration.", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "type": "string", "description": "Required. The name of the private connectivity configuration to delete.", "location": "path" }, "requestId": { "type": "string", "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query" }, "force": { "description": "Optional. If set to true, any child routes that belong to this PrivateConnection will also be deleted.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "deprecated": true, "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" } } }, "resources": { "routes": { "deprecated": true, "methods": { "create": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.privateConnections.routes.create", "description": "Use this method to create a route for a private connectivity in a project and location.", "httpMethod": "POST", "parameters": { "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" }, "routeId": { "type": "string", "description": "Required. The Route identifier.", "location": "query" }, "parent": { "description": "Required. The parent that owns the collection of Routes.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "required": true } }, "request": { "$ref": "Route" }, "parameterOrder": [ "parent" ], "deprecated": true, "path": "v1alpha1/{+parent}/routes", "response": { "$ref": "Operation" } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}", "deprecated": true, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" }, "id": "datastream.projects.locations.privateConnections.routes.delete", "description": "Use this method to delete a route.", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+/routes/[^/]+$", "type": "string", "description": "Required. The name of the Route resource to delete.", "location": "path" }, "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" } } }, "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes/{routesId}", "path": "v1alpha1/{+name}", "response": { "$ref": "Route" }, "deprecated": true, "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+/routes/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the Route resource to get.", "location": "path" } }, "id": "datastream.projects.locations.privateConnections.routes.get", "description": "Use this method to get details about a route." }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/routes", "path": "v1alpha1/{+parent}/routes", "response": { "$ref": "ListRoutesResponse" }, "parameterOrder": [ "parent" ], "deprecated": true, "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent that owns the collection of Routess.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", "required": true }, "pageSize": { "description": "Maximum number of Routes to return. The service may return fewer than this value. If unspecified, at most 50 Routes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "format": "int32", "type": "integer" }, "orderBy": { "type": "string", "description": "Order by fields for the result.", "location": "query" }, "filter": { "description": "Filter request.", "location": "query", "type": "string" }, "pageToken": { "description": "Page token received from a previous `ListRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRoutes` must match the call that provided the page token.", "location": "query", "type": "string" } }, "id": "datastream.projects.locations.privateConnections.routes.list", "description": "Use this method to list routes created for a private connectivity in a project and location." } } } } }, "operations": { "methods": { "get": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.operations.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.", "httpMethod": "GET", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource.", "location": "path" } }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Operation" } }, "list": { "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}/operations", "response": { "$ref": "ListOperationsResponse" }, "id": "datastream.projects.locations.operations.list", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "parameters": { "pageSize": { "format": "int32", "type": "integer", "description": "The standard list page size.", "location": "query" }, "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "The name of the operation's parent resource.", "location": "path" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Empty" }, "id": "datastream.projects.locations.operations.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`.", "httpMethod": "DELETE", "parameters": { "name": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "type": "string", "description": "The name of the operation resource to be deleted.", "location": "path" } } }, "cancel": { "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "datastream.projects.locations.operations.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", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "request": { "$ref": "CancelOperationRequest" }, "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}:cancel", "response": { "$ref": "Empty" } } } } } } } } }, "documentationLink": "https://cloud.google.com/datastream/", "batchPath": "batch", "parameters": { "callback": { "description": "JSONP", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "alt": { "enum": [ "json", "media", "proto" ], "type": "string", "description": "Data format for response.", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "$.xgafv": { "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "enum": [ "1", "2" ] }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" } }, "baseUrl": "https://datastream.googleapis.com/", "kind": "discovery#restDescription", "revision": "20260623", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "version": "v1alpha1", "description": "", "id": "datastream:v1alpha1", "basePath": "", "fullyEncodeReservedExpansion": true, "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." } } } }, "ownerDomain": "google.com", "mtlsRootUrl": "https://datastream.mtls.googleapis.com/", "ownerName": "Google", "endpoints": [ { "endpointUrl": "https://datastream.africa-south1.rep.googleapis.com/", "location": "africa-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-east1.rep.googleapis.com/", "location": "asia-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-east2.rep.googleapis.com/", "location": "asia-east2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-northeast2.rep.googleapis.com/", "location": "asia-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-northeast3.rep.googleapis.com/", "location": "asia-northeast3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-south1.rep.googleapis.com/", "location": "asia-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-south2.rep.googleapis.com/", "location": "asia-south2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-southeast1.rep.googleapis.com/", "location": "asia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.asia-southeast3.rep.googleapis.com/", "location": "asia-southeast3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.australia-southeast2.rep.googleapis.com/", "location": "australia-southeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-central2.rep.googleapis.com/", "location": "europe-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-north1.rep.googleapis.com/", "location": "europe-north1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-north2.rep.googleapis.com/", "location": "europe-north2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west1.rep.googleapis.com/", "location": "europe-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west10.rep.googleapis.com/", "location": "europe-west10", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west12.rep.googleapis.com/", "location": "europe-west12", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west15.rep.googleapis.com/", "location": "europe-west15", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west2.rep.googleapis.com/", "location": "europe-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west3.rep.googleapis.com/", "location": "europe-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west4.rep.googleapis.com/", "location": "europe-west4", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west6.rep.googleapis.com/", "location": "europe-west6", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west8.rep.googleapis.com/", "location": "europe-west8", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.europe-west9.rep.googleapis.com/", "location": "europe-west9", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.me-central1.rep.googleapis.com/", "location": "me-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.me-central2.rep.googleapis.com/", "location": "me-central2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.me-west1.rep.googleapis.com/", "location": "me-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.northamerica-south1.rep.googleapis.com/", "location": "northamerica-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-central1.rep.googleapis.com/", "location": "us-central1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east1.rep.googleapis.com/", "location": "us-east1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east4.rep.googleapis.com/", "location": "us-east4", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east5.rep.googleapis.com/", "location": "us-east5", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-east7.rep.googleapis.com/", "location": "us-east7", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-south1.rep.googleapis.com/", "location": "us-south1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west1.rep.googleapis.com/", "location": "us-west1", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west2.rep.googleapis.com/", "location": "us-west2", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west3.rep.googleapis.com/", "location": "us-west3", "description": "Regional Endpoint" }, { "endpointUrl": "https://datastream.us-west4.rep.googleapis.com/", "location": "us-west4", "description": "Regional Endpoint" } ], "schemas": { "MysqlSourceConfig": { "properties": { "allowlist": { "description": "MySQL objects to retrieve from the source.", "$ref": "MysqlRdbms" }, "rejectlist": { "$ref": "MysqlRdbms", "description": "MySQL objects to exclude from the stream." } }, "type": "object", "id": "MysqlSourceConfig", "description": "MySQL source configuration" }, "ConnectionProfile": { "properties": { "mysqlProfile": { "$ref": "MysqlProfile", "description": "MySQL ConnectionProfile configuration." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The create time of the resource.", "readOnly": true }, "labels": { "description": "Labels.", "type": "object", "additionalProperties": { "type": "string" } }, "noConnectivity": { "$ref": "NoConnectivitySettings", "description": "No connectivity option chosen." }, "forwardSshConnectivity": { "description": "Forward SSH tunnel connectivity.", "$ref": "ForwardSshTunnelConnectivity" }, "updateTime": { "readOnly": true, "description": "Output only. The update time of the resource.", "format": "google-datetime", "type": "string" }, "name": { "type": "string", "description": "Output only. The resource's name.", "readOnly": true }, "staticServiceIpConnectivity": { "$ref": "StaticServiceIpConnectivity", "description": "Static Service IP connectivity." }, "oracleProfile": { "description": "Oracle ConnectionProfile configuration.", "$ref": "OracleProfile" }, "displayName": { "description": "Required. Display name.", "type": "string" }, "privateConnectivity": { "$ref": "PrivateConnectivity", "description": "Private connectivity." }, "gcsProfile": { "description": "Cloud Storage ConnectionProfile configuration.", "$ref": "GcsProfile" } }, "type": "object", "id": "ConnectionProfile" }, "PrivateConnection": { "type": "object", "properties": { "updateTime": { "description": "Output only. The update time of the resource.", "readOnly": true, "type": "string", "format": "google-datetime" }, "state": { "description": "Output only. The state of the Private Connection.", "enumDescriptions": [ "", "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." ], "type": "string", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "CREATING", "CREATED", "FAILED", "DELETING", "FAILED_TO_DELETE" ] }, "displayName": { "description": "Required. Display name.", "type": "string" }, "vpcPeeringConfig": { "description": "VPC Peering Config", "$ref": "VpcPeeringConfig" }, "labels": { "description": "Labels.", "type": "object", "additionalProperties": { "type": "string" } }, "name": { "description": "Output only. The resource's name.", "readOnly": true, "type": "string" }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The create time of the resource." }, "error": { "$ref": "Error", "readOnly": true, "description": "Output only. In case of error, the details of the error in a user-friendly format." } }, "id": "PrivateConnection", "description": "The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network." }, "RetryInfo": { "type": "object", "properties": { "retryDelay": { "description": "Clients should wait at least this long between retrying the same request.", "type": "string", "format": "google-duration" } }, "id": "RetryInfo", "description": "Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses. It's always recommended that clients should use exponential backoff when retrying. Clients should wait until `retry_delay` amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on `retry_delay`, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached." }, "OracleObjectIdentifier": { "type": "object", "properties": { "schema": { "description": "Required. The schema name.", "type": "string" }, "table": { "description": "Required. The table name.", "type": "string" } }, "id": "OracleObjectIdentifier", "description": "Oracle data source object identifier." }, "ListOperationsResponse": { "properties": { "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "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.", "type": "array" } }, "type": "object", "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations." }, "MysqlTable": { "type": "object", "properties": { "tableName": { "description": "Table name.", "type": "string" }, "mysqlColumns": { "items": { "$ref": "MysqlColumn" }, "description": "MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.", "type": "array" } }, "id": "MysqlTable", "description": "MySQL table." }, "ListRoutesResponse": { "id": "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" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "routes": { "type": "array", "items": { "$ref": "Route" }, "description": "List of Routes." } }, "type": "object" }, "Help": { "properties": { "links": { "items": { "$ref": "Link" }, "description": "URL(s) pointing to additional information on handling the current error.", "type": "array" } }, "type": "object", "id": "Help", "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." }, "ListConnectionProfilesResponse": { "type": "object", "properties": { "connectionProfiles": { "description": "List of connection profiles.", "items": { "$ref": "ConnectionProfile" }, "type": "array" }, "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", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "id": "ListConnectionProfilesResponse" }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "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" }, "response": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "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" } } }, "RequestInfo": { "type": "object", "properties": { "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" }, "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" } }, "id": "RequestInfo", "description": "Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback." }, "MysqlColumn": { "id": "MysqlColumn", "description": "MySQL Column.", "type": "object", "properties": { "columnName": { "description": "Column name.", "type": "string" }, "length": { "description": "Column length.", "format": "int32", "type": "integer" }, "collation": { "description": "Column collation.", "type": "string" }, "ordinalPosition": { "type": "integer", "format": "int32", "description": "The ordinal position of the column in the table." }, "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" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" } } }, "DebugInfo": { "properties": { "detail": { "description": "Additional debugging information provided by the server.", "type": "string" }, "stackEntries": { "type": "array", "items": { "type": "string" }, "description": "The stack trace entries indicating where the error occurred." } }, "type": "object", "id": "DebugInfo", "description": "Describes additional debugging info." }, "PreconditionFailureViolation": { "id": "PreconditionFailureViolation", "description": "A message type used to describe a single precondition failure.", "properties": { "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" }, "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" }, "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" } }, "type": "object" }, "NoConnectivitySettings": { "type": "object", "properties": {}, "id": "NoConnectivitySettings", "description": "No connectivity settings." }, "MysqlSslConfig": { "id": "MysqlSslConfig", "description": "MySQL SSL configuration information.", "type": "object", "properties": { "caCertificate": { "description": "Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.", "type": "string" }, "clientCertificateSet": { "type": "boolean", "description": "Output only. Indicates whether the client_certificate field is set.", "readOnly": true }, "clientCertificate": { "description": "Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.", "type": "string" }, "caCertificateSet": { "type": "boolean", "description": "Output only. Indicates whether the ca_certificate field is set.", "readOnly": true }, "clientKey": { "description": "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" }, "clientKeySet": { "type": "boolean", "description": "Output only. Indicates whether the client_key field is set.", "readOnly": true } } }, "GcsProfile": { "id": "GcsProfile", "description": "Cloud Storage bucket profile.", "type": "object", "properties": { "bucketName": { "description": "Required. The full project and resource path for Cloud Storage bucket including the name.", "type": "string" }, "rootPath": { "description": "The root path inside the Cloud Storage bucket.", "type": "string" } } }, "OracleTable": { "id": "OracleTable", "description": "Oracle table.", "type": "object", "properties": { "oracleColumns": { "type": "array", "items": { "$ref": "OracleColumn" }, "description": "Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything." }, "tableName": { "description": "Table name.", "type": "string" } } }, "StreamObject": { "id": "StreamObject", "description": "A specific stream object (e.g a specific DB table).", "properties": { "errors": { "description": "Output only. Active errors on the object.", "readOnly": true, "items": { "$ref": "Error" }, "type": "array" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The last update time of the object.", "readOnly": true }, "sourceObject": { "$ref": "SourceObjectIdentifier", "description": "The object identifier in the data source." }, "backfillJob": { "description": "The latest backfill job that was initiated for the stream object.", "$ref": "BackfillJob" }, "displayName": { "description": "Required. Display name.", "type": "string" }, "name": { "description": "Output only. The object's name.", "readOnly": true, "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The creation time of the object.", "readOnly": true } }, "type": "object" }, "FetchErrorsResponse": { "properties": { "errors": { "type": "array", "items": { "$ref": "Error" }, "description": "The list of errors on the Stream." } }, "type": "object", "id": "FetchErrorsResponse", "description": "Response message for a 'FetchErrors' response." }, "ErrorInfo": { "type": "object", "properties": { "reason": { "description": "The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.", "type": "string" }, "metadata": { "description": "Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{\"instanceLimit\": \"100/request\"}`, should be returned as, `{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of instances that can be created in a single (batch) request.", "type": "object", "additionalProperties": { "type": "string" } }, "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" } }, "id": "ErrorInfo", "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\" } }" }, "BackfillNoneStrategy": { "properties": {}, "type": "object", "id": "BackfillNoneStrategy", "description": "Backfill strategy to disable automatic backfill for the Stream's objects." }, "Stream": { "type": "object", "properties": { "displayName": { "description": "Required. Display name.", "type": "string" }, "state": { "description": "The state of the stream.", "enumDescriptions": [ "Unspecified stream state.", "The stream has been created.", "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." ], "enum": [ "STATE_UNSPECIFIED", "CREATED", "RUNNING", "PAUSED", "MAINTENANCE", "FAILED", "FAILED_PERMANENTLY", "STARTING", "DRAINING" ], "type": "string" }, "backfillAll": { "$ref": "BackfillAllStrategy", "description": "Automatically backfill objects included in the stream source configuration. Specific objects can be excluded." }, "name": { "readOnly": true, "description": "Output only. The stream's name.", "type": "string" }, "sourceConfig": { "description": "Required. Source connection profile configuration.", "$ref": "SourceConfig" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels." }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "Error" }, "description": "Output only. Errors on the Stream." }, "updateTime": { "readOnly": true, "description": "Output only. The last update time of the stream.", "format": "google-datetime", "type": "string" }, "destinationConfig": { "$ref": "DestinationConfig", "description": "Required. Destination connection profile configuration." }, "backfillNone": { "$ref": "BackfillNoneStrategy", "description": "Do not automatically backfill any objects." }, "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" }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The creation time of the stream." } }, "id": "Stream" }, "FetchErrorsRequest": { "type": "object", "properties": {}, "id": "FetchErrorsRequest", "description": "Request message for 'FetchErrors' request." }, "DropLargeObjects": { "id": "DropLargeObjects", "description": "Configuration to drop large object values.", "properties": {}, "type": "object" }, "Validation": { "type": "object", "properties": { "message": { "type": "array", "description": "Messages reflecting the validation results.", "items": { "$ref": "ValidationMessage" } }, "code": { "description": "A custom code identifying this validation.", "type": "string" }, "status": { "description": "Validation execution status.", "enumDescriptions": [ "Unspecified status.", "Validation did not execute.", "Validation failed.", "Validation passed." ], "enum": [ "STATUS_UNSPECIFIED", "NOT_EXECUTED", "FAILED", "PASSED" ], "type": "string" }, "description": { "description": "A short description of the validation.", "type": "string" } }, "id": "Validation" }, "ValidationResult": { "id": "ValidationResult", "description": "Contains the current validation results.", "properties": { "validations": { "description": "A list of validations (includes both executed as well as not executed validations).", "items": { "$ref": "Validation" }, "type": "array" } }, "type": "object" }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "properties": {}, "type": "object" }, "VpcPeeringConfig": { "id": "VpcPeeringConfig", "description": "The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.", "type": "object", "properties": { "vpcName": { "description": "Required. fully qualified name of the VPC Datastream will peer to.", "type": "string" }, "subnet": { "description": "Required. A free subnet for peering. (CIDR of /29)", "type": "string" } } }, "DiscoverConnectionProfileRequest": { "properties": { "connectionProfile": { "description": "An ad-hoc ConnectionProfile configuration.", "$ref": "ConnectionProfile" }, "oracleRdbms": { "description": "Oracle RDBMS to enrich with child data objects and metadata.", "$ref": "OracleRdbms" }, "mysqlRdbms": { "description": "MySQL RDBMS to enrich with child data objects and metadata.", "$ref": "MysqlRdbms" }, "connectionProfileName": { "description": "A reference to an existing ConnectionProfile.", "type": "string" }, "recursive": { "description": "Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).", "type": "boolean" }, "recursionDepth": { "description": "The number of hierarchy levels below the current level to be retrieved.", "format": "int32", "type": "integer" } }, "type": "object", "id": "DiscoverConnectionProfileRequest", "description": "Request message for 'discover' ConnectionProfile request." }, "Error": { "id": "Error", "description": "Represent a user-facing Error.", "properties": { "reason": { "description": "A title that explains the reason for the error.", "type": "string" }, "details": { "description": "Additional information about the error.", "type": "object", "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" }, "errorTime": { "format": "google-datetime", "type": "string", "description": "The time when the error occurred." }, "message": { "description": "A message containing more information about the error that occurred.", "type": "string" } }, "type": "object" }, "MysqlProfile": { "properties": { "hostname": { "description": "Required. Hostname for the MySQL connection.", "type": "string" }, "username": { "description": "Required. Username for the MySQL connection.", "type": "string" }, "sslConfig": { "$ref": "MysqlSslConfig", "description": "SSL configuration for the MySQL connection." }, "port": { "format": "int32", "type": "integer", "description": "Port for the MySQL connection, default value is 3306." }, "password": { "description": "Required. Input only. Password for the MySQL connection.", "type": "string" } }, "type": "object", "id": "MysqlProfile", "description": "MySQL database profile." }, "StartBackfillJobResponse": { "id": "StartBackfillJobResponse", "description": "Response for manually initiating a backfill job for a specific stream object.", "properties": { "object": { "description": "The stream object resource a backfill job was started for.", "$ref": "StreamObject" } }, "type": "object" }, "OracleColumn": { "id": "OracleColumn", "description": "Oracle Column.", "type": "object", "properties": { "encoding": { "description": "Column encoding.", "type": "string" }, "ordinalPosition": { "description": "The ordinal position of the column in the table.", "format": "int32", "type": "integer" }, "columnName": { "description": "Column name.", "type": "string" }, "length": { "description": "Column length.", "type": "integer", "format": "int32" }, "scale": { "type": "integer", "format": "int32", "description": "Column scale." }, "primaryKey": { "description": "Whether or not the column represents a primary key.", "type": "boolean" }, "dataType": { "description": "The Oracle data type.", "type": "string" }, "nullable": { "description": "Whether or not the column can accept a null value.", "type": "boolean" }, "precision": { "description": "Column precision.", "format": "int32", "type": "integer" } } }, "ListStreamsResponse": { "id": "ListStreamsResponse", "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "items": { "type": "string" }, "type": "array" }, "streams": { "description": "List of streams", "items": { "$ref": "Stream" }, "type": "array" } } }, "Route": { "id": "Route", "description": "The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.", "properties": { "destinationAddress": { "description": "Required. Destination address for connection", "type": "string" }, "name": { "type": "string", "readOnly": true, "description": "Output only. The resource's name." }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The create time of the resource." }, "labels": { "description": "Labels.", "type": "object", "additionalProperties": { "type": "string" } }, "destinationPort": { "format": "int32", "type": "integer", "description": "Destination port for connection" }, "displayName": { "description": "Required. Display name.", "type": "string" }, "updateTime": { "description": "Output only. The update time of the resource.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object" }, "OracleSourceConfig": { "id": "OracleSourceConfig", "description": "Oracle data source configuration", "properties": { "rejectlist": { "$ref": "OracleRdbms", "description": "Oracle objects to exclude from the stream." }, "dropLargeObjects": { "$ref": "DropLargeObjects", "description": "Drop large object values." }, "allowlist": { "description": "Oracle objects to include in the stream.", "$ref": "OracleRdbms" } }, "type": "object" }, "ListLocationsResponse": { "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" }, "type": "array" }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "type": "object", "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations." }, "QuotaFailure": { "id": "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.", "type": "object", "properties": { "violations": { "type": "array", "description": "Describes all quota violations.", "items": { "$ref": "QuotaFailureViolation" } } } }, "DestinationConfig": { "type": "object", "properties": { "destinationConnectionProfileName": { "description": "Required. Destination connection profile identifier.", "type": "string" }, "gcsDestinationConfig": { "$ref": "GcsDestinationConfig", "description": "GCS destination configuration." } }, "id": "DestinationConfig", "description": "The configuration of the stream destination." }, "MysqlObjectIdentifier": { "type": "object", "properties": { "table": { "description": "Required. The table name.", "type": "string" }, "database": { "description": "Required. The database name.", "type": "string" } }, "id": "MysqlObjectIdentifier", "description": "Mysql data source object identifier." }, "MysqlDatabase": { "id": "MysqlDatabase", "description": "MySQL database.", "type": "object", "properties": { "databaseName": { "description": "Database name.", "type": "string" }, "mysqlTables": { "type": "array", "items": { "$ref": "MysqlTable" }, "description": "Tables in the database." } } }, "PrivateConnectivity": { "type": "object", "properties": { "privateConnectionName": { "type": "string" } }, "id": "PrivateConnectivity", "description": "Private Connectivity" }, "ValidationMessage": { "type": "object", "properties": { "message": { "description": "The result of the validation.", "type": "string" }, "level": { "type": "string", "description": "Message severity level (warning or error).", "enumDescriptions": [ "Unspecified level.", "Potentially cause issues with the Stream.", "Definitely cause issues with the Stream." ], "enum": [ "LEVEL_UNSPECIFIED", "WARNING", "ERROR" ] }, "code": { "description": "A custom code identifying this specific message.", "type": "string" }, "metadata": { "description": "Additional metadata related to the result.", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "ValidationMessage", "description": "Represent user-facing validation result message." }, "LocalizedMessage": { "type": "object", "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", "description": "Provides a localized error message that is safe to return to the user which can be attached to an RPC error." }, "OracleSchema": { "type": "object", "properties": { "oracleTables": { "items": { "$ref": "OracleTable" }, "description": "Tables in the schema.", "type": "array" }, "schemaName": { "description": "Schema name.", "type": "string" } }, "id": "OracleSchema", "description": "Oracle schema." }, "FetchStaticIpsResponse": { "id": "FetchStaticIpsResponse", "description": "Response message for a 'FetchStaticIps' response.", "type": "object", "properties": { "staticIps": { "type": "array", "items": { "type": "string" }, "description": "list of static ips by account" }, "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" } } }, "OracleRdbms": { "id": "OracleRdbms", "description": "Oracle database structure.", "type": "object", "properties": { "oracleSchemas": { "type": "array", "description": "Oracle schemas/databases in the database server.", "items": { "$ref": "OracleSchema" } } } }, "ListPrivateConnectionsResponse": { "id": "ListPrivateConnectionsResponse", "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." }, "privateConnections": { "items": { "$ref": "PrivateConnection" }, "description": "List of private connectivity configurations.", "type": "array" } }, "type": "object" }, "OracleProfile": { "properties": { "databaseService": { "description": "Required. Database for the Oracle connection.", "type": "string" }, "hostname": { "description": "Required. Hostname for the Oracle connection.", "type": "string" }, "username": { "description": "Required. Username for the Oracle connection.", "type": "string" }, "connectionAttributes": { "description": "Connection string attributes", "type": "object", "additionalProperties": { "type": "string" } }, "port": { "description": "Port for the Oracle connection, default value is 1521.", "format": "int32", "type": "integer" }, "password": { "description": "Required. Password for the Oracle connection.", "type": "string" } }, "type": "object", "id": "OracleProfile", "description": "Oracle database profile." }, "ForwardSshTunnelConnectivity": { "id": "ForwardSshTunnelConnectivity", "description": "Forward SSH Tunnel connectivity.", "properties": { "port": { "description": "Port for the SSH tunnel, default value is 22.", "type": "integer", "format": "int32" }, "password": { "description": "Input only. SSH password.", "type": "string" }, "privateKey": { "description": "Input only. SSH private key.", "type": "string" }, "hostname": { "description": "Required. Hostname for the SSH tunnel.", "type": "string" }, "username": { "description": "Required. Username for the SSH tunnel.", "type": "string" } }, "type": "object" }, "DiscoverConnectionProfileResponse": { "id": "DiscoverConnectionProfileResponse", "type": "object", "properties": { "oracleRdbms": { "$ref": "OracleRdbms", "description": "Enriched Oracle RDBMS object." }, "mysqlRdbms": { "$ref": "MysqlRdbms", "description": "Enriched MySQL RDBMS object." } } }, "Empty": { "properties": {}, "type": "object", "id": "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); }" }, "PreconditionFailure": { "id": "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.", "items": { "$ref": "PreconditionFailureViolation" }, "type": "array" } }, "type": "object" }, "QuotaFailureViolation": { "id": "QuotaFailureViolation", "description": "A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.", "type": "object", "properties": { "apiService": { "description": "The API Service from which the `QuotaFailure.Violation` originates. In some cases, Quota issues originate from an API Service other than the one that was called. In other words, a dependency of the called API Service could be the cause of the `QuotaFailure`, and this field would have the dependency API service name. For example, if the called API is Kubernetes Engine API (container.googleapis.com), and a quota violation occurs in the Kubernetes Engine API itself, this field would be \"container.googleapis.com\". On the other hand, if the quota violation occurs when the Kubernetes Engine API creates VMs in the Compute Engine API (compute.googleapis.com), this field would be \"compute.googleapis.com\".", "type": "string" }, "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" }, "subject": { "description": "The subject on which the quota check failed. For example, \"clientip:\" or \"project:\".", "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.", "type": "object", "additionalProperties": { "type": "string" } }, "futureQuotaValue": { "description": "The new quota value being rolled out at the time of the violation. At the completion of the rollout, this value will be enforced in place of quota_value. If no rollout is in progress at the time of the violation, this field is not set. For example, if at the time of the violation a rollout is in progress changing the number of CPUs quota from 10 to 20, 20 would be the value of this field.", "format": "int64", "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" }, "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" }, "quotaValue": { "format": "int64", "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." } } }, "OperationMetadata": { "properties": { "target": { "type": "string", "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation was created." }, "endTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running." }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "requestedCancellation": { "type": "boolean", "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 }, "apiVersion": { "type": "string", "description": "Output only. API version used to start the operation.", "readOnly": true }, "validationResult": { "description": "Output only. Results of executed validations if there are any.", "readOnly": true, "$ref": "ValidationResult" }, "statusMessage": { "type": "string", "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true } }, "type": "object", "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation." }, "BadRequest": { "properties": { "fieldViolations": { "type": "array", "description": "Describes all violations in a client request.", "items": { "$ref": "FieldViolation" } } }, "type": "object", "id": "BadRequest", "description": "Describes violations in a client request. This error type focuses on the syntactic aspects of the request." }, "SourceObjectIdentifier": { "id": "SourceObjectIdentifier", "description": "Represents an identifier of an object in the data source.", "properties": { "mysqlIdentifier": { "description": "Mysql data source object identifier.", "$ref": "MysqlObjectIdentifier" }, "oracleIdentifier": { "description": "Oracle data source object identifier.", "$ref": "OracleObjectIdentifier" } }, "type": "object" }, "Status": { "type": "object", "properties": { "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" }, "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "id": "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)." }, "GcsDestinationConfig": { "id": "GcsDestinationConfig", "description": "Google Cloud Storage destination configuration", "type": "object", "properties": { "avroFileFormat": { "description": "AVRO file format configuration.", "$ref": "AvroFileFormat" }, "path": { "description": "Path inside the Cloud Storage bucket to write data to.", "type": "string" }, "gcsFileFormat": { "description": "File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.", "enumDescriptions": [ "Unspecified Cloud Storage file format.", "Avro file format" ], "enum": [ "GCS_FILE_FORMAT_UNSPECIFIED", "AVRO" ], "deprecated": true, "type": "string" }, "fileRotationInterval": { "description": "The maximum duration for which new events are added before a file is closed and a new file is created.", "format": "google-duration", "type": "string" }, "jsonFileFormat": { "description": "JSON file format configuration.", "$ref": "JsonFileFormat" }, "fileRotationMb": { "format": "int32", "type": "integer", "description": "The maximum file size to be saved in the bucket." } } }, "Link": { "id": "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" } }, "type": "object" }, "Location": { "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" } }, "id": "Location", "description": "A resource that represents a Google Cloud location." }, "ResourceInfo": { "type": "object", "properties": { "owner": { "description": "The owner of the resource (optional). For example, \"user:\" or \"project:\".", "type": "string" }, "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" }, "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", "description": "Describes the resource that is being accessed." }, "JsonFileFormat": { "type": "object", "properties": { "compression": { "description": "Compression of the loaded JSON file.", "enumDescriptions": [ "Unspecified json file compression.", "Do not compress JSON file.", "Gzip compression." ], "enum": [ "JSON_COMPRESSION_UNSPECIFIED", "NO_COMPRESSION", "GZIP" ], "type": "string" }, "schemaFileFormat": { "type": "string", "description": "The schema file format along JSON data files.", "enumDescriptions": [ "Unspecified schema file format.", "Do not attach schema file.", "Avro schema format." ], "enum": [ "SCHEMA_FILE_FORMAT_UNSPECIFIED", "NO_SCHEMA_FILE", "AVRO_SCHEMA_FILE" ] } }, "id": "JsonFileFormat", "description": "JSON file format configuration." }, "BackfillJob": { "id": "BackfillJob", "description": "Represents a backfill job on a specific stream object.", "properties": { "lastStartTime": { "type": "string", "format": "google-datetime", "description": "Output only. Backfill job's start time.", "readOnly": true }, "state": { "description": "Backfill job state.", "enumDescriptions": [ "Default value.", "Backfill job was never started for the stream object (stream has backfill strategy defined as manual or object was explicitly excluded from automatic backfill).", "Backfill job will start pending available resources.", "Backfill job is running.", "Backfill job stopped (next job run will start from beginning).", "Backfill job failed (due to an error).", "Backfill completed successfully.", "Backfill job failed since the table structure is currently unsupported for backfill." ], "enum": [ "STATE_UNSPECIFIED", "NOT_STARTED", "PENDING", "ACTIVE", "STOPPED", "FAILED", "COMPLETED", "UNSUPPORTED" ], "type": "string" }, "trigger": { "type": "string", "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." ], "enum": [ "TRIGGER_UNSPECIFIED", "AUTOMATIC", "MANUAL" ] }, "errors": { "type": "array", "readOnly": true, "items": { "$ref": "Error" }, "description": "Output only. Errors which caused the backfill job to fail." }, "lastEndTime": { "description": "Output only. Backfill job's end time.", "readOnly": true, "type": "string", "format": "google-datetime" } }, "type": "object" }, "MysqlRdbms": { "id": "MysqlRdbms", "description": "MySQL database structure", "type": "object", "properties": { "mysqlDatabases": { "type": "array", "items": { "$ref": "MysqlDatabase" }, "description": "Mysql databases on the server" } } }, "SourceConfig": { "id": "SourceConfig", "description": "The configuration of the stream source.", "properties": { "sourceConnectionProfileName": { "description": "Required. Source connection profile identifier.", "type": "string" }, "oracleSourceConfig": { "description": "Oracle data source configuration", "$ref": "OracleSourceConfig" }, "mysqlSourceConfig": { "$ref": "MysqlSourceConfig", "description": "MySQL data source configuration" } }, "type": "object" }, "ListStreamObjectsResponse": { "type": "object", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page.", "type": "string" }, "streamObjects": { "description": "List of stream objects.", "items": { "$ref": "StreamObject" }, "type": "array" } }, "id": "ListStreamObjectsResponse", "description": "Response containing the objects for a stream." }, "StaticServiceIpConnectivity": { "id": "StaticServiceIpConnectivity", "description": "Static IP address connectivity.", "properties": {}, "type": "object" }, "BackfillAllStrategy": { "properties": { "oracleExcludedObjects": { "$ref": "OracleRdbms", "description": "Oracle data source objects to avoid backfilling." }, "mysqlExcludedObjects": { "description": "MySQL data source objects to avoid backfilling.", "$ref": "MysqlRdbms" } }, "type": "object", "id": "BackfillAllStrategy", "description": "Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded." }, "AvroFileFormat": { "id": "AvroFileFormat", "description": "AVRO file format configuration.", "type": "object", "properties": {} }, "StopBackfillJobResponse": { "type": "object", "properties": { "object": { "$ref": "StreamObject", "description": "The stream object resource the backfill job was stopped for." } }, "id": "StopBackfillJobResponse", "description": "Response for manually stop a backfill job for a specific stream object." }, "FieldViolation": { "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": { "$ref": "LocalizedMessage", "description": "Provides a localized error message for field-level errors that is safe to return to the API consumer." } }, "type": "object", "id": "FieldViolation", "description": "A message type used to describe a single bad request field." } }, "name": "datastream", "servicePath": "", "protocol": "rest" }