Package types (0.1.3)

API documentation for datastream_v1alpha1.types package.

Classes

AvroFileFormat

AVRO file format configuration.

ConnectionProfile

CreateConnectionProfileRequest

CreatePrivateConnectionRequest

CreateRouteRequest

route creation request .. attribute:: parent

Required. The parent that owns the collection of Routes.

:type: str

CreateStreamRequest

DeleteConnectionProfileRequest

DeletePrivateConnectionRequest

DeleteRouteRequest

route deletion request .. attribute:: name

Required. The name of the Route resource to delete.

:type: str

DeleteStreamRequest

DestinationConfig

The configuration of the stream destination. .. attribute:: destination_connection_profile_name

Required. Destination connection profile identifier.

:type: str

DiscoverConnectionProfileRequest

Request message for 'discover' ConnectionProfile request. .. attribute:: parent

Required. The parent resource of the ConnectionProfile type. Must be in the format projects/*/locations/*.

:type: str

DiscoverConnectionProfileResponse

Error

Represent a user-facing Error. .. attribute:: reason

A title that explains the reason for the error.

:type: str

FetchErrorsRequest

Request message for 'FetchErrors' request. .. attribute:: stream

Name of the Stream resource for which to fetch any errors.

:type: str

FetchErrorsResponse

Response message for a 'FetchErrors' response. .. attribute:: errors

The list of errors on the Stream.

:type: Sequence[google.cloud.datastream_v1alpha1.types.Error]

FetchStaticIpsRequest

Request message for 'FetchStaticIps' request. .. attribute:: name

Required. The name resource of the Response type. Must be in the format projects/*/locations/*.

:type: str

FetchStaticIpsResponse

Response message for a 'FetchStaticIps' response. .. attribute:: static_ips

list of static ips by account

:type: Sequence[str]

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity. .. attribute:: hostname

Required. Hostname for the SSH tunnel.

:type: str

GcsDestinationConfig

Google Cloud Storage destination configuration .. attribute:: path

Path inside the Cloud Storage bucket to write data to.

:type: str

GcsFileFormat

File format in Cloud Storage.

GcsProfile

Cloud Storage bucket profile. .. attribute:: bucket_name

Required. The full project and resource path for Cloud Storage bucket including the name.

:type: str

GetConnectionProfileRequest

GetPrivateConnectionRequest

GetRouteRequest

route get request .. attribute:: name

Required. The name of the Route resource to get.

:type: str

GetStreamRequest

JsonFileFormat

JSON file format configuration. .. attribute:: schema_file_format

The schema file format along JSON data files.

:type: google.cloud.datastream_v1alpha1.types.SchemaFileFormat

ListConnectionProfilesRequest

ListConnectionProfilesResponse

ListPrivateConnectionsRequest

ListPrivateConnectionsResponse

ListRoutesRequest

route list request .. attribute:: parent

Required. The parent that owns the collection of Routess.

:type: str

ListRoutesResponse

route list response .. attribute:: routes

List of Routes.

:type: Sequence[google.cloud.datastream_v1alpha1.types.Route]

ListStreamsRequest

ListStreamsResponse

MysqlColumn

MySQL Column. .. attribute:: column_name

Column name.

:type: str

MysqlDatabase

MySQL database. .. attribute:: database_name

Database name.

:type: str

MysqlProfile

MySQL database profile. .. attribute:: hostname

Required. Hostname for the MySQL connection.

:type: str

MysqlRdbms

MySQL database structure .. attribute:: mysql_databases

Mysql databases on the server

:type: Sequence[google.cloud.datastream_v1alpha1.types.MysqlDatabase]

MysqlSourceConfig

MySQL source configuration .. attribute:: allowlist

MySQL objects to retrieve from the source.

:type: google.cloud.datastream_v1alpha1.types.MysqlRdbms

MysqlSslConfig

MySQL SSL configuration information. .. attribute:: 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: str

MysqlTable

MySQL table. .. attribute:: table_name

Table name.

:type: str

NoConnectivitySettings

No connectivity settings.

OperationMetadata

Represents the metadata of the long-running operation. .. attribute:: create_time

Output only. The time the operation was created.

:type: google.protobuf.timestamp_pb2.Timestamp

OracleColumn

Oracle Column. .. attribute:: column_name

Column name.

:type: str

OracleProfile

Oracle database profile. .. attribute:: hostname

Required. Hostname for the Oracle connection.

:type: str

OracleRdbms

Oracle database structure. .. attribute:: oracle_schemas

Oracle schemas/databases in the database server.

:type: Sequence[google.cloud.datastream_v1alpha1.types.OracleSchema]

OracleSchema

Oracle schema. .. attribute:: schema_name

Schema name.

:type: str

OracleSourceConfig

Oracle data source configuration .. attribute:: allowlist

Oracle objects to include in the stream.

:type: google.cloud.datastream_v1alpha1.types.OracleRdbms

OracleTable

Oracle table. .. attribute:: table_name

Table name.

:type: str

PrivateConnection

The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.

PrivateConnectivity

Private Connectivity .. attribute:: private_connection_name

:type: str

Route

The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.

SchemaFileFormat

Schema file format.

SourceConfig

The configuration of the stream source. .. attribute:: source_connection_profile_name

Required. Source connection profile identifier.

:type: str

StaticServiceIpConnectivity

Static IP address connectivity.

Stream

UpdateConnectionProfileRequest

UpdateStreamRequest

Validation

ValidationMessage

Represent user-facing validation result message. .. attribute:: message

The result of the validation.

:type: str

ValidationResult

Contains the current validation results. .. attribute:: validations

A list of validations (includes both executed as well as not executed validations).

:type: Sequence[google.cloud.datastream_v1alpha1.types.Validation]

VpcPeeringConfig

The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.