Types for Google Cloud Datastream v1alpha1 API¶
- class google.cloud.datastream_v1alpha1.types.AvroFileFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAVRO file format configuration.
- class google.cloud.datastream_v1alpha1.types.ConnectionProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis 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.
- 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_v1alpha1.types.CreateConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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
- class google.cloud.datastream_v1alpha1.types.CreatePrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.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_v1alpha1.types.CreateStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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 do not create any resources. The default is false.
- Type
- class google.cloud.datastream_v1alpha1.types.DeleteConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.types.DeletePrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.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_v1alpha1.types.DeleteStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.types.DestinationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration of the stream destination.
- class google.cloud.datastream_v1alpha1.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 ConnectionProfile type. Must be in the format
projects/*/locations/*.- Type
- connection_profile¶
An ad-hoc ConnectionProfile configuration.
This field is a member of oneof
target.
- connection_profile_name¶
A reference to an existing ConnectionProfile.
This field is a member of oneof
target.- Type
- recursive¶
Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).
This field is a member of oneof
depth.- Type
- recursion_depth¶
The number of hierarchy levels below the current level to be retrieved.
This field is a member of oneof
depth.- Type
- oracle_rdbms¶
Oracle RDBMS to enrich with child data objects and metadata.
This field is a member of oneof
data_object.
- class google.cloud.datastream_v1alpha1.types.DiscoverConnectionProfileResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis 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_v1alpha1.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_v1alpha1.types.FetchErrorsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘FetchErrors’ request.
- class google.cloud.datastream_v1alpha1.types.FetchErrorsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for a ‘FetchErrors’ response.
- errors¶
The list of errors on the Stream.
- Type
MutableSequence[google.cloud.datastream_v1alpha1.types.Error]
- class google.cloud.datastream_v1alpha1.types.FetchStaticIpsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest message for ‘FetchStaticIps’ request.
- name¶
Required. The name resource of the Response type. Must be in the format
projects/*/locations/*.- Type
- class google.cloud.datastream_v1alpha1.types.FetchStaticIpsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageResponse message for a ‘FetchStaticIps’ response.
- class google.cloud.datastream_v1alpha1.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_v1alpha1.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.
- gcs_file_format¶
File format that data should be written in. Deprecated field - use file_format instead.
- file_rotation_interval¶
The maximum duration for which new events are added before a file is closed and a new file is created.
- class google.cloud.datastream_v1alpha1.types.GcsFileFormat(value)[source]¶
Bases:
proto.enums.EnumFile format in Cloud Storage.
- Values:
- GCS_FILE_FORMAT_UNSPECIFIED (0):
Unspecified Cloud Storage file format.
- AVRO (1):
Avro file format
- class google.cloud.datastream_v1alpha1.types.GcsProfile(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageCloud Storage bucket profile.
- bucket_name¶
Required. The full project and resource path for Cloud Storage bucket including the name.
- Type
- class google.cloud.datastream_v1alpha1.types.GetConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1alpha1.types.GetPrivateConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1alpha1.types.GetRouteRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Messageroute get request
- class google.cloud.datastream_v1alpha1.types.GetStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
- class google.cloud.datastream_v1alpha1.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 google.cloud.datastream_v1alpha1.types.ListConnectionProfilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.types.ListConnectionProfilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- connection_profiles¶
List of connection profiles.
- Type
MutableSequence[google.cloud.datastream_v1alpha1.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_v1alpha1.types.ListPrivateConnectionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.types.ListPrivateConnectionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- private_connections¶
List of private connectivity configurations.
- Type
MutableSequence[google.cloud.datastream_v1alpha1.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_v1alpha1.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_v1alpha1.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_v1alpha1.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_v1alpha1.types.ListStreamsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.types.ListStreamsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- streams¶
List of streams
- Type
MutableSequence[google.cloud.datastream_v1alpha1.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_v1alpha1.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_v1alpha1.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_v1alpha1.types.MysqlTable]
- class google.cloud.datastream_v1alpha1.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_v1alpha1.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_v1alpha1.types.MysqlDatabase]
- class google.cloud.datastream_v1alpha1.types.MysqlSourceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMySQL source configuration
- allowlist¶
MySQL objects to retrieve from the source.
- rejectlist¶
MySQL objects to exclude from the stream.
- class google.cloud.datastream_v1alpha1.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_v1alpha1.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 lists, includes/excludes everything.
- Type
MutableSequence[google.cloud.datastream_v1alpha1.types.MysqlColumn]
- class google.cloud.datastream_v1alpha1.types.NoConnectivitySettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNo connectivity settings.
- class google.cloud.datastream_v1alpha1.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_v1alpha1.types.OracleColumn(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle Column.
- class google.cloud.datastream_v1alpha1.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_v1alpha1.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_v1alpha1.types.OracleSchema]
- class google.cloud.datastream_v1alpha1.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_v1alpha1.types.OracleTable]
- class google.cloud.datastream_v1alpha1.types.OracleSourceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOracle data source configuration
- allowlist¶
Oracle objects to include in the stream.
- rejectlist¶
Oracle objects to exclude from the stream.
- class google.cloud.datastream_v1alpha1.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 inclue/exclude lists, includes/excludes everything.
- Type
MutableSequence[google.cloud.datastream_v1alpha1.types.OracleColumn]
- class google.cloud.datastream_v1alpha1.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):
No description available.
- CREATING (1):
The private connection is in creation state - creating resources.
- CREATED (2):
The private connection has been created with all of it’s resources.
- FAILED (3):
The private connection creation has failed.
- class google.cloud.datastream_v1alpha1.types.PrivateConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessagePrivate Connectivity
- class google.cloud.datastream_v1alpha1.types.Route(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.
- 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_v1alpha1.types.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_v1alpha1.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.
- oracle_source_config¶
Oracle data source configuration
This field is a member of oneof
source_stream_config.
- class google.cloud.datastream_v1alpha1.types.StaticServiceIpConnectivity(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageStatic IP address connectivity.
- class google.cloud.datastream_v1alpha1.types.Stream(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThis 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_v1alpha1.types.Error]
- 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.
- 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.
- CREATED (1):
The stream has been created.
- 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_v1alpha1.types.UpdateConnectionProfileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.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 ConnectionProfile 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
- class google.cloud.datastream_v1alpha1.types.UpdateStreamRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- 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_v1alpha1.types.Validation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message- status¶
Validation execution status.
- message¶
Messages reflecting the validation results.
- Type
MutableSequence[google.cloud.datastream_v1alpha1.types.ValidationMessage]
- class Status(value)[source]¶
Bases:
proto.enums.EnumValidation execution status.
- Values:
- STATUS_UNSPECIFIED (0):
Unspecified status.
- NOT_EXECUTED (1):
Validation did not execute.
- FAILED (2):
Validation failed.
- PASSED (3):
Validation passed.
- class google.cloud.datastream_v1alpha1.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_v1alpha1.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_v1alpha1.types.Validation]
- class google.cloud.datastream_v1alpha1.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.
