openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 86.5 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"https://datastream.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Datastream API","version":"v1","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"google","url":"https://datastream.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"datastream"},"externalDocs":{"url":"https://cloud.google.com/datastream/"},"tags":[{"name":"projects"}],"paths":{"/v1/{name}":{"delete":{"description":"Use this method to delete a stream.","operationId":"datastream.projects.locations.streams.delete","parameters":[{"description":"Required. The name of the stream resource to delete.","in":"path","name":"name","required":true,"schema":{"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).","in":"query","name":"requestId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Use this method to get details about a stream object.","operationId":"datastream.projects.locations.streams.objects.get","parameters":[{"description":"Required. The name of the stream object resource to get.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamObject"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Use this method to update the configuration of a stream.","operationId":"datastream.projects.locations.streams.patch","parameters":[{"description":"Output only. The stream's name.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Optional. Update the stream without validating it.","in":"query","name":"force","schema":{"type":"boolean"}},{"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).","in":"query","name":"requestId","schema":{"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.","in":"query","name":"updateMask","schema":{"type":"string"}},{"description":"Optional. Only validate the stream with the changes, without actually updating it. The default is false.","in":"query","name":"validateOnly","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}/locations":{"get":{"description":"Lists information about the supported locations for this service.","operationId":"datastream.projects.locations.list","parameters":[{"description":"The resource that owns the locations collection, if applicable.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The maximum number of results to return. If not set, the service selects a default.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}/operations":{"get":{"description":"Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.","operationId":"datastream.projects.locations.operations.list","parameters":[{"description":"The name of the operation's parent resource.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOperationsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"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`.","operationId":"datastream.projects.locations.operations.cancel","parameters":[{"description":"The name of the operation resource to be cancelled.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOperationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Empty"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:fetchStaticIps":{"get":{"description":"The FetchStaticIps API call exposes the static IP addresses used by Datastream.","operationId":"datastream.projects.locations.fetchStaticIps","parameters":[{"description":"Required. The resource name for the location for which static IPs should be returned. Must be in the format `projects/*/locations/*`.","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Maximum number of Ips to return, will likely not be specified.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A page token, received from a previous `ListStaticIps` call. will likely not be specified.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchStaticIpsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{name}:run":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental.","operationId":"datastream.projects.locations.streams.run","parameters":[{"description":"Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name}","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunStreamRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{object}:startBackfillJob":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to start a backfill job for the specified stream object.","operationId":"datastream.projects.locations.streams.objects.startBackfillJob","parameters":[{"description":"Required. The name of the stream object resource to start a backfill job for.","in":"path","name":"object","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartBackfillJobRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartBackfillJobResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{object}:stopBackfillJob":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to stop a backfill job for the specified stream object.","operationId":"datastream.projects.locations.streams.objects.stopBackfillJob","parameters":[{"description":"Required. The name of the stream object resource to stop the backfill job for.","in":"path","name":"object","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopBackfillJobRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopBackfillJobResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/connectionProfiles":{"get":{"description":"Use this method to list connection profiles created in a project and location.","operationId":"datastream.projects.locations.connectionProfiles.list","parameters":[{"description":"Required. The parent that owns the collection of connection profiles.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Filter request.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Order by fields for the result.","in":"query","name":"orderBy","schema":{"type":"string"}},{"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.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConnectionProfilesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to create a connection profile in a project and location.","operationId":"datastream.projects.locations.connectionProfiles.create","parameters":[{"description":"Required. The parent that owns the collection of ConnectionProfiles.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The connection profile identifier.","in":"query","name":"connectionProfileId","schema":{"type":"string"}},{"description":"Optional. Create the connection profile without validating it.","in":"query","name":"force","schema":{"type":"boolean"}},{"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).","in":"query","name":"requestId","schema":{"type":"string"}},{"description":"Optional. Only validate the connection profile, but don't create any resources. The default is false.","in":"query","name":"validateOnly","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionProfile"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/connectionProfiles:discover":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that's optionally supplied in the request.","operationId":"datastream.projects.locations.connectionProfiles.discover","parameters":[{"description":"Required. The parent resource of the connection profile type. Must be in the format `projects/*/locations/*`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverConnectionProfileRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiscoverConnectionProfileResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/objects":{"get":{"description":"Use this method to list the objects of a specific stream.","operationId":"datastream.projects.locations.streams.objects.list","parameters":[{"description":"Required. The parent stream that owns the collection of objects.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStreamObjectsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{parent}/objects:lookup":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to look up a stream object by its source object identifier.","operationId":"datastream.projects.locations.streams.objects.lookup","parameters":[{"description":"Required. The parent stream that owns the collection of objects.","in":"path","name":"parent","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LookupStreamObjectRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamObject"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/privateConnections":{"get":{"description":"Use this method to list private connectivity configurations in a project and location.","operationId":"datastream.projects.locations.privateConnections.list","parameters":[{"description":"Required. The parent that owns the collection of private connectivity configurations.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Filter request.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Order by fields for the result.","in":"query","name":"orderBy","schema":{"type":"string"}},{"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.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPrivateConnectionsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to create a private connectivity configuration.","operationId":"datastream.projects.locations.privateConnections.create","parameters":[{"description":"Required. The parent that owns the collection of PrivateConnections.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. If set to true, will skip validations.","in":"query","name":"force","schema":{"type":"boolean"}},{"description":"Required. The private connectivity identifier.","in":"query","name":"privateConnectionId","schema":{"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).","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateConnection"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/routes":{"get":{"description":"Use this method to list routes created for a private connectivity configuration in a project and location.","operationId":"datastream.projects.locations.privateConnections.routes.list","parameters":[{"description":"Required. The parent that owns the collection of Routess.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Filter request.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Order by fields for the result.","in":"query","name":"orderBy","schema":{"type":"string"}},{"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.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRoutesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to create a route for a private connectivity configuration in a project and location.","operationId":"datastream.projects.locations.privateConnections.routes.create","parameters":[{"description":"Required. The parent that owns the collection of Routes.","in":"path","name":"parent","required":true,"schema":{"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).","in":"query","name":"requestId","schema":{"type":"string"}},{"description":"Required. The Route identifier.","in":"query","name":"routeId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Route"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/streams":{"get":{"description":"Use this method to list streams in a project and location.","operationId":"datastream.projects.locations.streams.list","parameters":[{"description":"Required. The parent that owns the collection of streams.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Filter request.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Order by fields for the result.","in":"query","name":"orderBy","schema":{"type":"string"}},{"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.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"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.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStreamsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Use this method to create a stream.","operationId":"datastream.projects.locations.streams.create","parameters":[{"description":"Required. The parent that owns the collection of streams.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Optional. Create the stream without validating it.","in":"query","name":"force","schema":{"type":"boolean"}},{"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).","in":"query","name":"requestId","schema":{"type":"string"}},{"description":"Required. The stream identifier.","in":"query","name":"streamId","schema":{"type":"string"}},{"description":"Optional. Only validate the stream, but don't create any resources. The default is false.","in":"query","name":"validateOnly","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stream"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"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.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"AvroFileFormat":{"description":"AVRO file format configuration.","properties":{},"type":"object"},"BackfillAllStrategy":{"description":"Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.","properties":{"mysqlExcludedObjects":{"$ref":"#/components/schemas/MysqlRdbms","description":"MySQL data source objects to avoid backfilling."},"oracleExcludedObjects":{"$ref":"#/components/schemas/OracleRdbms","description":"Oracle data source objects to avoid backfilling."},"postgresqlExcludedObjects":{"$ref":"#/components/schemas/PostgresqlRdbms","description":"PostgreSQL data source objects to avoid backfilling."},"sqlServerExcludedObjects":{"$ref":"#/components/schemas/SqlServerRdbms","description":"SQLServer data source objects to avoid backfilling"}},"type":"object"},"BackfillJob":{"description":"Represents a backfill job on a specific stream object.","properties":{"errors":{"description":"Output only. Errors which caused the backfill job to fail.","items":{"$ref":"#/components/schemas/Error"},"readOnly":true,"type":"array"},"lastEndTime":{"description":"Output only. Backfill job's end time.","format":"google-datetime","readOnly":true,"type":"string"},"lastStartTime":{"description":"Output only. Backfill job's start time.","format":"google-datetime","readOnly":true,"type":"string"},"state":{"description":"Output only. Backfill job state.","enum":["STATE_UNSPECIFIED","NOT_STARTED","PENDING","ACTIVE","STOPPED","FAILED","COMPLETED","UNSUPPORTED"],"readOnly":true,"type":"string"},"trigger":{"description":"Backfill job's triggering reason.","enum":["TRIGGER_UNSPECIFIED","AUTOMATIC","MANUAL"],"type":"string"}},"type":"object"},"BackfillNoneStrategy":{"description":"Backfill strategy to disable automatic backfill for the Stream's objects.","properties":{},"type":"object"},"BigQueryDestinationConfig":{"description":"BigQuery destination configuration","properties":{"dataFreshness":{"description":"The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost.","format":"google-duration","type":"string"},"singleTargetDataset":{"$ref":"#/components/schemas/SingleTargetDataset","description":"Single destination dataset."},"sourceHierarchyDatasets":{"$ref":"#/components/schemas/SourceHierarchyDatasets","description":"Source hierarchy datasets."}},"type":"object"},"BigQueryProfile":{"description":"BigQuery warehouse profile.","properties":{},"type":"object"},"CancelOperationRequest":{"description":"The request message for Operations.CancelOperation.","properties":{},"type":"object"},"CdcStrategy":{"description":"The strategy that the stream uses for CDC replication.","properties":{"mostRecentStartPosition":{"$ref":"#/components/schemas/MostRecentStartPosition","description":"Optional. Start replicating from the most recent position in the source."},"nextAvailableStartPosition":{"$ref":"#/components/schemas/NextAvailableStartPosition","description":"Optional. Resume replication from the next available position in the source."},"specificStartPosition":{"$ref":"#/components/schemas/SpecificStartPosition","description":"Optional. Start replicating from a specific position in the source."}},"type":"object"},"ConnectionProfile":{"description":"A set of reusable connection configurations to be used as a source or destination for a stream.","properties":{"bigqueryProfile":{"$ref":"#/components/schemas/BigQueryProfile","description":"BigQuery Connection Profile configuration."},"createTime":{"description":"Output only. The create time of the resource.","format":"google-datetime","readOnly":true,"type":"string"},"displayName":{"description":"Required. Display name.","type":"string"},"forwardSshConnectivity":{"$ref":"#/components/schemas/ForwardSshTunnelConnectivity","description":"Forward SSH tunnel connectivity."},"gcsProfile":{"$ref":"#/components/schemas/GcsProfile","description":"Cloud Storage ConnectionProfile configuration."},"labels":{"additionalProperties":{"type":"string"},"description":"Labels.","type":"object"},"mysqlProfile":{"$ref":"#/components/schemas/MysqlProfile","description":"MySQL ConnectionProfile configuration."},"name":{"description":"Output only. The resource's name.","readOnly":true,"type":"string"},"oracleProfile":{"$ref":"#/components/schemas/OracleProfile","description":"Oracle ConnectionProfile configuration."},"postgresqlProfile":{"$ref":"#/components/schemas/PostgresqlProfile","description":"PostgreSQL Connection Profile configuration."},"privateConnectivity":{"$ref":"#/components/schemas/PrivateConnectivity","description":"Private connectivity."},"sqlServerProfile":{"$ref":"#/components/schemas/SqlServerProfile","description":"SQLServer Connection Profile configuration."},"staticServiceIpConnectivity":{"$ref":"#/components/schemas/StaticServiceIpConnectivity","description":"Static Service IP connectivity."},"updateTime":{"description":"Output only. The update time of the resource.","format":"google-datetime","readOnly":true,"type":"string"}},"type":"object"},"DatasetTemplate":{"description":"Dataset template used for dynamic dataset creation.","properties":{"datasetIdPrefix":{"description":"If supplied, every created dataset will have its name prefixed by the provided value. The prefix and name will be separated by an underscore. i.e. _.","type":"string"},"kmsKeyName":{"description":"Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}. See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.","type":"string"},"location":{"description":"Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.","type":"string"}},"type":"object"},"DestinationConfig":{"description":"The configuration of the stream destination.","properties":{"bigqueryDestinationConfig":{"$ref":"#/components/schemas/BigQueryDestinationConfig","description":"BigQuery destination configuration."},"destinationConnectionProfile":{"description":"Required. Destination connection profile resource. Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`","type":"string"},"gcsDestinationConfig":{"$ref":"#/components/schemas/GcsDestinationConfig","description":"A configuration for how data should be loaded to Cloud Storage."}},"type":"object"},"DiscoverConnectionProfileRequest":{"description":"Request message for 'discover' ConnectionProfile request.","properties":{"connectionProfile":{"$ref":"#/components/schemas/ConnectionProfile","description":"An ad-hoc connection profile configuration."},"connectionProfileName":{"description":"A reference to an existing connection profile.","type":"string"},"fullHierarchy":{"description":"Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).","type":"boolean"},"hierarchyDepth":{"description":"The number of hierarchy levels below the current level to be retrieved.","format":"int32","type":"integer"},"mysqlRdbms":{"$ref":"#/components/schemas/MysqlRdbms","description":"MySQL RDBMS to enrich with child data objects and metadata."},"oracleRdbms":{"$ref":"#/components/schemas/OracleRdbms","description":"Oracle RDBMS to enrich with child data objects and metadata."},"postgresqlRdbms":{"$ref":"#/components/schemas/PostgresqlRdbms","description":"PostgreSQL RDBMS to enrich with child data objects and metadata."}},"type":"object"},"DiscoverConnectionProfileResponse":{"description":"Response from a discover request.","properties":{"mysqlRdbms":{"$ref":"#/components/schemas/MysqlRdbms","description":"Enriched MySQL RDBMS object."},"oracleRdbms":{"$ref":"#/components/schemas/OracleRdbms","description":"Enriched Oracle RDBMS object."},"postgresqlRdbms":{"$ref":"#/components/schemas/PostgresqlRdbms","description":"Enriched PostgreSQL RDBMS object."}},"type":"object"},"DropLargeObjects":{"description":"Configuration to drop large object values.","properties":{},"type":"object"},"Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","properties":{},"type":"object"},"Error":{"description":"Represent a user-facing Error.","properties":{"details":{"additionalProperties":{"type":"string"},"description":"Additional information about the error.","type":"object"},"errorTime":{"description":"The time when the error occurred.","format":"google-datetime","type":"string"},"errorUuid":{"description":"A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.","type":"string"},"message":{"description":"A message containing more information about the error that occurred.","type":"string"},"reason":{"description":"A title that explains the reason for the error.","type":"string"}},"type":"object"},"FetchStaticIpsResponse":{"description":"Response message for a 'FetchStaticIps' response.","properties":{"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"},"staticIps":{"description":"list of static ips by account","items":{"type":"string"},"type":"array"}},"type":"object"},"ForwardSshTunnelConnectivity":{"description":"Forward SSH Tunnel connectivity.","properties":{"hostname":{"description":"Required. Hostname for the SSH tunnel.","type":"string"},"password":{"description":"Input only. SSH password.","type":"string"},"port":{"description":"Port for the SSH tunnel, default value is 22.","format":"int32","type":"integer"},"privateKey":{"description":"Input only. SSH private key.","type":"string"},"username":{"description":"Required. Username for the SSH tunnel.","type":"string"}},"type":"object"},"GcsDestinationConfig":{"description":"Google Cloud Storage destination configuration","properties":{"avroFileFormat":{"$ref":"#/components/schemas/AvroFileFormat","description":"AVRO file format configuration."},"fileRotationInterval":{"description":"The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.","format":"google-duration","type":"string"},"fileRotationMb":{"description":"The maximum file size to be saved in the bucket.","format":"int32","type":"integer"},"jsonFileFormat":{"$ref":"#/components/schemas/JsonFileFormat","description":"JSON file format configuration."},"path":{"description":"Path inside the Cloud Storage bucket to write data to.","type":"string"}},"type":"object"},"GcsProfile":{"description":"Cloud Storage bucket profile.","properties":{"bucket":{"description":"Required. The Cloud Storage bucket name.","type":"string"},"rootPath":{"description":"The root path inside the Cloud Storage bucket.","type":"string"}},"type":"object"},"JsonFileFormat":{"description":"JSON file format configuration.","properties":{"compression":{"description":"Compression of the loaded JSON file.","enum":["JSON_COMPRESSION_UNSPECIFIED","NO_COMPRESSION","GZIP"],"type":"string"},"schemaFileFormat":{"description":"The schema file format along JSON data files.","enum":["SCHEMA_FILE_FORMAT_UNSPECIFIED","NO_SCHEMA_FILE","AVRO_SCHEMA_FILE"],"type":"string"}},"type":"object"},"ListConnectionProfilesResponse":{"description":"Response message for listing connection profiles.","properties":{"connectionProfiles":{"description":"List of connection profiles.","items":{"$ref":"#/components/schemas/ConnectionProfile"},"type":"array"},"nextPageToken":{"description":"A token, which can be sent as `page_token` to retrieve the next page. If this field is omitte