Types for Google Cloud Datastream v1 API¶
- class google.cloud.datastream_v1.types.AvroFileFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAVRO file format configuration.
- class google.cloud.datastream_v1.types.BackfillJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a backfill job on a specific stream object.
- state¶
Backfill job state.
- trigger¶
Backfill job’s triggering reason.
- last_start_time¶
Output only. Backfill job’s start time.
- last_end_time¶
Output only. Backfill job’s end time.
- errors¶
Output only. Errors which caused the backfill job to fail.
- Type
MutableSequence[google.cloud.datastream_v1.types.Error]
- class State(value)[source]¶
Bases:
proto.enums.EnumState of the stream object’s backfill job.
- Values:
- STATE_UNSPECIFIED (0):
Default value.
- NOT_STARTED (1):
Backfill job was never started for the stream object (stream has backfill strategy defined as manual or object was explicitly excluded from automatic backfill).
- PENDING (2):
Backfill job will start pending available resources.
- ACTIVE (3):
Backfill job is running.
- STOPPED (4):
Backfill job stopped (next job run will start from beginning).
- FAILED (5):
Backfill job failed (due to an error).
- COMPLETED (6):
Backfill completed successfully.
- UNSUPPORTED (7):
Backfill job failed since the table structure is currently unsupported for backfill.
- class Trigger(value)[source]¶
Bases:
proto.enums.EnumTriggering reason for a backfill job.
- Values:
- TRIGGER_UNSPECIFIED (0):
Default value.
- AUTOMATIC (1):
Object backfill job was triggered automatically according to the stream’s backfill strategy.
- MANUAL (2):
Object backfill job was triggered manually using the dedicated API.
- class google.cloud.datastream_v1.types.BigQueryDestinationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBigQuery destination configuration
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- source_hierarchy_datasets¶
Source hierarchy datasets.
This field is a member of oneof
dataset_config.
- data_freshness¶
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.
- class SingleTargetDataset(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA single target dataset to which all data will be streamed.
- class SourceHierarchyDatasets(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDestination datasets are created so that hierarchy of the destination data objects matches the source hierarchy.
- dataset_template¶
The dataset template to use for dynamic dataset creation.
- class DatasetTemplate(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDataset template used for dynamic dataset creation.
- location¶
Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
- Type
- dataset_id_prefix¶
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. _<dataset_name>.
- Type
- kms_key_name¶
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
- class google.cloud.datastream_v1.types.BigQueryProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBigQuery warehouse profile.
- class google.cloud.datastream_v1.types.ConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA set of reusable connection configurations to be used as a source or destination for a stream.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- create_time¶
Output only. The create time of the resource.
- update_time¶
Output only. The update time of the resource.
- gcs_profile¶
Cloud Storage ConnectionProfile configuration.
This field is a member of oneof
profile.
- bigquery_profile¶
BigQuery Connection Profile configuration.
This field is a member of oneof
profile.
- postgresql_profile¶
PostgreSQL Connection Profile configuration.
This field is a member of oneof
profile.
- static_service_ip_connectivity¶
Static Service IP connectivity.
This field is a member of oneof
connectivity.
- forward_ssh_connectivity¶
Forward SSH tunnel connectivity.
This field is a member of oneof
connectivity.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1.types.CreateConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a connection profile.
- connection_profile¶
Required. The connection profile resource to create.
- request_id¶
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- validate_only¶
Optional. Only validate the connection profile, but don’t create any resources. The default is false.
- Type
- class google.cloud.datastream_v1.types.CreatePrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for creating a private connection.
- private_connection¶
Required. The Private Connectivity resource to create.
- request_id¶
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.datastream_v1.types.CreateRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRoute creation request.
- route¶
Required. The Route resource to create.
- request_id¶
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- class google.cloud.datastream_v1.types.CreateStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for creating a stream.
- stream¶
Required. The stream resource to create.
- request_id¶
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- validate_only¶
Optional. Only validate the stream, but don’t create any resources. The default is false.
- Type
- class google.cloud.datastream_v1.types.DeleteConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for deleting a connection profile.
- request_id¶
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).
- Type
- class google.cloud.datastream_v1.types.DeletePrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to delete a private connection.
- request_id¶
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).
- Type
- class google.cloud.datastream_v1.types.DeleteRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRoute deletion request.
- request_id¶
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).
- Type
- class google.cloud.datastream_v1.types.DeleteStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for deleting a stream.
- request_id¶
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).
- Type
- class google.cloud.datastream_v1.types.DestinationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration of the stream destination.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- destination_connection_profile¶
Required. Destination connection profile resource. Format:
projects/{project}/locations/{location}/connectionProfiles/{name}- Type
- gcs_destination_config¶
A configuration for how data should be loaded to Cloud Storage.
This field is a member of oneof
destination_stream_config.
- class google.cloud.datastream_v1.types.DiscoverConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘discover’ ConnectionProfile request.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- parent¶
Required. The parent resource of the connection profile type. Must be in the format
projects/*/locations/*.- Type
- connection_profile¶
An ad-hoc connection profile configuration.
This field is a member of oneof
target.
- connection_profile_name¶
A reference to an existing connection profile.
This field is a member of oneof
target.- Type
- full_hierarchy¶
Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).
This field is a member of oneof
hierarchy.- Type
- hierarchy_depth¶
The number of hierarchy levels below the current level to be retrieved.
This field is a member of oneof
hierarchy.- Type
- oracle_rdbms¶
Oracle RDBMS to enrich with child data objects and metadata.
This field is a member of oneof
data_object.
- mysql_rdbms¶
MySQL RDBMS to enrich with child data objects and metadata.
This field is a member of oneof
data_object.
- class google.cloud.datastream_v1.types.DiscoverConnectionProfileResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse from a discover request.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.datastream_v1.types.Error(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresent a user-facing Error.
- error_uuid¶
A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
- Type
- error_time¶
The time when the error occurred.
- class DetailsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1.types.FetchStaticIpsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘FetchStaticIps’ request.
- name¶
Required. The resource name for the location for which static IPs should be returned. Must be in the format
projects/*/locations/*.- Type
- class google.cloud.datastream_v1.types.FetchStaticIpsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for a ‘FetchStaticIps’ response.
- class google.cloud.datastream_v1.types.ForwardSshTunnelConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageForward SSH Tunnel connectivity.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- class google.cloud.datastream_v1.types.GcsDestinationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageGoogle Cloud Storage destination configuration
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- file_rotation_interval¶
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.
- class google.cloud.datastream_v1.types.GcsProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud Storage bucket profile.
- class google.cloud.datastream_v1.types.GetConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting a connection profile.
- class google.cloud.datastream_v1.types.GetPrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to get a private connection configuration.
- class google.cloud.datastream_v1.types.GetRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRoute get request.
- class google.cloud.datastream_v1.types.GetStreamObjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for fetching a specific stream object.
- class google.cloud.datastream_v1.types.GetStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for getting a stream.
- class google.cloud.datastream_v1.types.JsonFileFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageJSON file format configuration.
- schema_file_format¶
The schema file format along JSON data files.
- compression¶
Compression of the loaded JSON file.
- class JsonCompression(value)[source]¶
Bases:
proto.enums.EnumJson file compression.
- Values:
- JSON_COMPRESSION_UNSPECIFIED (0):
Unspecified json file compression.
- NO_COMPRESSION (1):
Do not compress JSON file.
- GZIP (2):
Gzip compression.
- class SchemaFileFormat(value)[source]¶
Bases:
proto.enums.EnumSchema file format.
- Values:
- SCHEMA_FILE_FORMAT_UNSPECIFIED (0):
Unspecified schema file format.
- NO_SCHEMA_FILE (1):
Do not attach schema file.
- AVRO_SCHEMA_FILE (2):
Avro schema format.
- class google.cloud.datastream_v1.types.ListConnectionProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing connection profiles.
- page_size¶
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.
- Type
- page_token¶
Page token received from a previous
ListConnectionProfilescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListConnectionProfilesmust match the call that provided the page token.- Type
- class google.cloud.datastream_v1.types.ListConnectionProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing connection profiles.
- connection_profiles¶
List of connection profiles.
- Type
MutableSequence[google.cloud.datastream_v1.types.ConnectionProfile]
- next_page_token¶
A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.datastream_v1.types.ListPrivateConnectionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for listing private connections.
- parent¶
Required. The parent that owns the collection of private connectivity configurations.
- Type
- page_size¶
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.
- Type
- page_token¶
Page token received from a previous
ListPrivateConnectionscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListPrivateConnectionsmust match the call that provided the page token.- Type
- class google.cloud.datastream_v1.types.ListPrivateConnectionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse containing a list of private connection configurations.
- private_connections¶
List of private connectivity configurations.
- Type
MutableSequence[google.cloud.datastream_v1.types.PrivateConnection]
- next_page_token¶
A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.datastream_v1.types.ListRoutesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRoute list request.
- page_size¶
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.
- Type
- page_token¶
Page token received from a previous
ListRoutescall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListRoutesmust match the call that provided the page token.- Type
- class google.cloud.datastream_v1.types.ListRoutesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRoute list response.
- routes¶
List of Routes.
- Type
MutableSequence[google.cloud.datastream_v1.types.Route]
- next_page_token¶
A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.datastream_v1.types.ListStreamObjectsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for listing all objects for a specific stream.
- page_size¶
Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
- Type
- class google.cloud.datastream_v1.types.ListStreamObjectsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse containing the objects for a stream.
- stream_objects¶
List of stream objects.
- Type
MutableSequence[google.cloud.datastream_v1.types.StreamObject]
- class google.cloud.datastream_v1.types.ListStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for listing streams.
- page_size¶
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.
- Type
- page_token¶
Page token received from a previous
ListStreamscall. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListStreamsmust match the call that provided the page token.- Type
- class google.cloud.datastream_v1.types.ListStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for listing streams.
- streams¶
List of streams
- Type
MutableSequence[google.cloud.datastream_v1.types.Stream]
- next_page_token¶
A token, which can be sent as
page_tokento retrieve the next page. If this field is omitted, there are no subsequent pages.- Type
- class google.cloud.datastream_v1.types.LookupStreamObjectRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for looking up a specific stream object by its source object identifier.
- source_object_identifier¶
Required. The source object identifier which maps to the stream object.
- class google.cloud.datastream_v1.types.MysqlColumn(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL Column.
- data_type¶
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
- class google.cloud.datastream_v1.types.MysqlDatabase(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL database.
- mysql_tables¶
Tables in the database.
- Type
MutableSequence[google.cloud.datastream_v1.types.MysqlTable]
- class google.cloud.datastream_v1.types.MysqlProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL database profile.
- ssl_config¶
SSL configuration for the MySQL connection.
- class google.cloud.datastream_v1.types.MysqlRdbms(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL database structure
- mysql_databases¶
Mysql databases on the server
- Type
MutableSequence[google.cloud.datastream_v1.types.MysqlDatabase]
- class google.cloud.datastream_v1.types.MysqlSourceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL source configuration
- include_objects¶
MySQL objects to retrieve from the source.
- exclude_objects¶
MySQL objects to exclude from the stream.
- max_concurrent_cdc_tasks¶
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
- class google.cloud.datastream_v1.types.MysqlSslConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL SSL configuration information.
- client_key¶
Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the ‘client_certificate’ and the ‘ca_certificate’ fields are mandatory.
- Type
- client_certificate¶
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
- client_certificate_set¶
Output only. Indicates whether the client_certificate field is set.
- Type
- ca_certificate¶
Input only. PEM-encoded certificate of the CA that signed the source database server’s certificate.
- Type
- class google.cloud.datastream_v1.types.MysqlTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL table.
- mysql_columns¶
MySQL columns in the database. When unspecified as part of include/exclude objects, includes/excludes everything.
- Type
MutableSequence[google.cloud.datastream_v1.types.MysqlColumn]
- class google.cloud.datastream_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- requested_cancellation¶
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- validation_result¶
Output only. Results of executed validations if there are any.
- class google.cloud.datastream_v1.types.OracleColumn(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle Column.
- class google.cloud.datastream_v1.types.OracleProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle database profile.
- class ConnectionAttributesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1.types.OracleRdbms(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle database structure.
- oracle_schemas¶
Oracle schemas/databases in the database server.
- Type
MutableSequence[google.cloud.datastream_v1.types.OracleSchema]
- class google.cloud.datastream_v1.types.OracleSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle schema.
- oracle_tables¶
Tables in the schema.
- Type
MutableSequence[google.cloud.datastream_v1.types.OracleTable]
- class google.cloud.datastream_v1.types.OracleSourceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle data source configuration
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- include_objects¶
Oracle objects to include in the stream.
- exclude_objects¶
Oracle objects to exclude from the stream.
- max_concurrent_cdc_tasks¶
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.
- Type
- max_concurrent_backfill_tasks¶
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
- drop_large_objects¶
Drop large object values.
This field is a member of oneof
large_objects_handling.
- stream_large_objects¶
Stream large object values. NOTE: This feature is currently experimental.
This field is a member of oneof
large_objects_handling.
- class DropLargeObjects(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration to drop large object values.
- class StreamLargeObjects(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConfiguration to stream large object values.
- class google.cloud.datastream_v1.types.OracleTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle table.
- oracle_columns¶
Oracle columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
- Type
MutableSequence[google.cloud.datastream_v1.types.OracleColumn]
- class google.cloud.datastream_v1.types.PostgresqlColumn(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostgreSQL Column.
- class google.cloud.datastream_v1.types.PostgresqlProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostgreSQL database profile.
- class google.cloud.datastream_v1.types.PostgresqlRdbms(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostgreSQL database structure.
- postgresql_schemas¶
PostgreSQL schemas in the database server.
- Type
MutableSequence[google.cloud.datastream_v1.types.PostgresqlSchema]
- class google.cloud.datastream_v1.types.PostgresqlSchema(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostgreSQL schema.
- postgresql_tables¶
Tables in the schema.
- Type
MutableSequence[google.cloud.datastream_v1.types.PostgresqlTable]
- class google.cloud.datastream_v1.types.PostgresqlSourceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostgreSQL data source configuration
- include_objects¶
PostgreSQL objects to include in the stream.
- exclude_objects¶
PostgreSQL objects to exclude from the stream.
- replication_slot¶
Required. Immutable. The name of the logical replication slot that’s configured with the pgoutput plugin.
- Type
- publication¶
Required. The name of the publication that includes the set of all tables that are defined in the stream’s include_objects.
- Type
- class google.cloud.datastream_v1.types.PostgresqlTable(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePostgreSQL table.
- postgresql_columns¶
PostgreSQL columns in the schema. When unspecified as part of include/exclude objects, includes/excludes everything.
- Type
MutableSequence[google.cloud.datastream_v1.types.PostgresqlColumn]
- class google.cloud.datastream_v1.types.PrivateConnection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe PrivateConnection resource is used to establish private connectivity between Datastream and a customer’s network.
- create_time¶
Output only. The create time of the resource.
- update_time¶
Output only. The update time of the resource.
- state¶
Output only. The state of the Private Connection.
- error¶
Output only. In case of error, the details of the error in a user-friendly format.
- vpc_peering_config¶
VPC Peering Config.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumPrivate Connection state.
- Values:
- STATE_UNSPECIFIED (0):
Unspecified state.
- CREATING (1):
The private connection is in creation state - creating resources.
- CREATED (2):
The private connection has been created with all of its resources.
- FAILED (3):
The private connection creation has failed.
- DELETING (4):
The private connection is being deleted.
- FAILED_TO_DELETE (5):
Delete request has failed, resource is in invalid state.
- class google.cloud.datastream_v1.types.PrivateConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePrivate Connectivity
- class google.cloud.datastream_v1.types.Route(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe route resource is the child of the private connection resource, used for defining a route for a private connection.
- create_time¶
Output only. The create time of the resource.
- update_time¶
Output only. The update time of the resource.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1.types.SourceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration of the stream source.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- source_connection_profile¶
Required. Source connection profile resoource. Format:
projects/{project}/locations/{location}/connectionProfiles/{name}- Type
- oracle_source_config¶
Oracle data source configuration.
This field is a member of oneof
source_stream_config.
- mysql_source_config¶
MySQL data source configuration.
This field is a member of oneof
source_stream_config.
- class google.cloud.datastream_v1.types.SourceObjectIdentifier(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents an identifier of an object in the data source.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- oracle_identifier¶
Oracle data source object identifier.
This field is a member of oneof
source_identifier.
- mysql_identifier¶
Mysql data source object identifier.
This field is a member of oneof
source_identifier.
- postgresql_identifier¶
PostgreSQL data source object identifier.
This field is a member of oneof
source_identifier.
- class MysqlObjectIdentifier(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMysql data source object identifier.
- class OracleObjectIdentifier(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle data source object identifier.
- class google.cloud.datastream_v1.types.StartBackfillJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for manually initiating a backfill job for a specific stream object.
- class google.cloud.datastream_v1.types.StartBackfillJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for manually initiating a backfill job for a specific stream object.
- object_¶
The stream object resource a backfill job was started for.
- class google.cloud.datastream_v1.types.StaticServiceIpConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatic 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.
- class google.cloud.datastream_v1.types.StopBackfillJobRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest for manually stopping a running backfill job for a specific stream object.
- class google.cloud.datastream_v1.types.StopBackfillJobResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse for manually stop a backfill job for a specific stream object.
- object_¶
The stream object resource the backfill job was stopped for.
- class google.cloud.datastream_v1.types.Stream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA resource representing streaming data from a source to a destination.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- create_time¶
Output only. The creation time of the stream.
- update_time¶
Output only. The last update time of the stream.
- source_config¶
Required. Source connection profile configuration.
- destination_config¶
Required. Destination connection profile configuration.
- state¶
The state of the stream.
- backfill_all¶
Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.
This field is a member of oneof
backfill_strategy.
- backfill_none¶
Do not automatically backfill any objects.
This field is a member of oneof
backfill_strategy.
- errors¶
Output only. Errors on the Stream.
- Type
MutableSequence[google.cloud.datastream_v1.types.Error]
- customer_managed_encryption_key¶
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.
This field is a member of oneof
_customer_managed_encryption_key.- Type
- class BackfillAllStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBackfill strategy to automatically backfill the Stream’s objects. Specific objects can be excluded.
This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.
- oracle_excluded_objects¶
Oracle data source objects to avoid backfilling.
This field is a member of oneof
excluded_objects.
- mysql_excluded_objects¶
MySQL data source objects to avoid backfilling.
This field is a member of oneof
excluded_objects.
- class BackfillNoneStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageBackfill strategy to disable automatic backfill for the Stream’s objects.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class State(value)[source]¶
Bases:
proto.enums.EnumStream state.
- Values:
- STATE_UNSPECIFIED (0):
Unspecified stream state.
- NOT_STARTED (1):
The stream has been created but has not yet started streaming data.
- RUNNING (2):
The stream is running.
- PAUSED (3):
The stream is paused.
- MAINTENANCE (4):
The stream is in maintenance mode.
Updates are rejected on the resource in this state.
- FAILED (5):
The stream is experiencing an error that is preventing data from being streamed.
- FAILED_PERMANENTLY (6):
The stream has experienced a terminal failure.
- STARTING (7):
The stream is starting, but not yet running.
- DRAINING (8):
The Stream is no longer reading new events, but still writing events in the buffer.
- class google.cloud.datastream_v1.types.StreamObject(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA specific stream object (e.g a specific DB table).
- create_time¶
Output only. The creation time of the object.
- update_time¶
Output only. The last update time of the object.
- errors¶
Output only. Active errors on the object.
- Type
MutableSequence[google.cloud.datastream_v1.types.Error]
- backfill_job¶
The latest backfill job that was initiated for the stream object.
- source_object¶
The object identifier in the data source.
- class google.cloud.datastream_v1.types.UpdateConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageConnection profile update message.
- update_mask¶
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.
- connection_profile¶
Required. The connection profile to update.
- request_id¶
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- validate_only¶
Optional. Only validate the connection profile, but don’t update any resources. The default is false.
- Type
- class google.cloud.datastream_v1.types.UpdateStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for updating a stream.
- update_mask¶
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.
- stream¶
Required. The stream resource to update.
- request_id¶
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
- Type
- validate_only¶
Optional. Only validate the stream with the changes, without actually updating it. The default is false.
- Type
- class google.cloud.datastream_v1.types.Validation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA validation to perform on a stream.
- state¶
Validation execution status.
- message¶
Messages reflecting the validation results.
- Type
MutableSequence[google.cloud.datastream_v1.types.ValidationMessage]
- class State(value)[source]¶
Bases:
proto.enums.EnumValidation execution state.
- Values:
- STATE_UNSPECIFIED (0):
Unspecified state.
- NOT_EXECUTED (1):
Validation did not execute.
- FAILED (2):
Validation failed.
- PASSED (3):
Validation passed.
- class google.cloud.datastream_v1.types.ValidationMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresent user-facing validation result message.
- level¶
Message severity level (warning or error).
- class Level(value)[source]¶
Bases:
proto.enums.EnumValidation message level.
- Values:
- LEVEL_UNSPECIFIED (0):
Unspecified level.
- WARNING (1):
Potentially cause issues with the Stream.
- ERROR (2):
Definitely cause issues with the Stream.
- class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1.types.ValidationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains the current validation results.
- validations¶
A list of validations (includes both executed as well as not executed validations).
- Type
MutableSequence[google.cloud.datastream_v1.types.Validation]
- class google.cloud.datastream_v1.types.VpcPeeringConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe VPC Peering configuration is used to create VPC peering between Datastream and the consumer’s VPC.
- vpc¶
Required. Fully qualified name of the VPC that Datastream will peer to. Format:
projects/{project}/global/{networks}/{name}- Type
