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