Datastream¶

async create_private_connection(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreatePrivateConnectionRequest, dict]] = None, *, parent: Optional[str] = None, private_connection: Optional[google.cloud.datastream_v1.types.datastream_resources.PrivateConnection] = None, private_connection_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to create a private connectivity configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_create_private_connection():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    private_connection = datastream_v1.PrivateConnection()
    private_connection.display_name = "display_name_value"

    request = datastream_v1.CreatePrivateConnectionRequest(
        parent="parent_value",
        private_connection_id="private_connection_id_value",
        private_connection=private_connection,
    )

    # Make the request
    operation = client.create_private_connection(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.CreatePrivateConnectionRequest, dict]]) – The request object. Request for creating a private connection.
parent (str) –
Required. The parent that owns the collection of PrivateConnections.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
private_connection (google.cloud.datastream_v1.types.PrivateConnection) –
Required. The Private Connectivity resource to create.

This corresponds to the private_connection field on the request instance; if request is provided, this should not be set.
private_connection_id (str) –
Required. The private connectivity identifier.

This corresponds to the private_connection_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.PrivateConnection The PrivateConnection resource is used to establish private connectivity: between Datastream and a customer’s network.

Return type

async create_route(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreateRouteRequest, dict]] = None, *, parent: Optional[str] = None, route: Optional[google.cloud.datastream_v1.types.datastream_resources.Route] = None, route_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to create a route for a private connectivity configuration in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_create_route():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    route = datastream_v1.Route()
    route.display_name = "display_name_value"
    route.destination_address = "destination_address_value"

    request = datastream_v1.CreateRouteRequest(
        parent="parent_value",
        route_id="route_id_value",
        route=route,
    )

    # Make the request
    operation = client.create_route(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.CreateRouteRequest, dict]]) – The request object. Route creation request.
parent (str) –
Required. The parent that owns the collection of Routes.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
route (google.cloud.datastream_v1.types.Route) –
Required. The Route resource to create.

This corresponds to the route field on the request instance; if request is provided, this should not be set.
route_id (str) – Required. The Route identifier. This corresponds to the route_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.Route The route resource is the child of the private connection resource,: used for defining a route for a private connection.

Return type

async create_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreateStreamRequest, dict]] = None, *, parent: Optional[str] = None, stream: Optional[google.cloud.datastream_v1.types.datastream_resources.Stream] = None, stream_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to create a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_create_stream():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    stream = datastream_v1.Stream()
    stream.display_name = "display_name_value"
    stream.source_config.source_connection_profile = "source_connection_profile_value"
    stream.destination_config.destination_connection_profile = "destination_connection_profile_value"

    request = datastream_v1.CreateStreamRequest(
        parent="parent_value",
        stream_id="stream_id_value",
        stream=stream,
    )

    # Make the request
    operation = client.create_stream(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.CreateStreamRequest, dict]]) – The request object. Request message for creating a stream.
parent (str) –
Required. The parent that owns the collection of streams.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
stream (google.cloud.datastream_v1.types.Stream) –
Required. The stream resource to create.

This corresponds to the stream field on the request instance; if request is provided, this should not be set.
stream_id (str) – Required. The stream identifier. This corresponds to the stream_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.Stream A resource representing streaming data from a source to a destination.

Return type

async delete_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeleteConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to delete a connection profile.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_delete_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.DeleteConnectionProfileRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_connection_profile(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.DeleteConnectionProfileRequest, dict]]) – The request object. Request message for deleting a connection profile.
name (str) –
Required. The name of the connection profile resource to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

async delete_private_connection(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeletePrivateConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to delete a private connectivity configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_delete_private_connection():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.DeletePrivateConnectionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_private_connection(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.DeletePrivateConnectionRequest, dict]]) – The request object. Request to delete a private connection.
name (str) –
Required. The name of the private connectivity configuration to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

async delete_route(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeleteRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to delete a route.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_delete_route():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.DeleteRouteRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_route(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.DeleteRouteRequest, dict]]) – The request object. Route deletion request.
name (str) –
Required. The name of the Route resource to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

async delete_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeleteStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to delete a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_delete_stream():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.DeleteStreamRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_stream(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.DeleteStreamRequest, dict]]) – The request object. Request message for deleting a stream.
name (str) –
Required. The name of the stream resource to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

google.cloud.datastream_v1.types.DiscoverConnectionProfileResponse

async discover_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DiscoverConnectionProfileRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream.DiscoverConnectionProfileResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_discover_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    connection_profile = datastream_v1.ConnectionProfile()
    connection_profile.oracle_profile.hostname = "hostname_value"
    connection_profile.oracle_profile.username = "username_value"
    connection_profile.oracle_profile.password = "password_value"
    connection_profile.oracle_profile.database_service = "database_service_value"
    connection_profile.display_name = "display_name_value"

    request = datastream_v1.DiscoverConnectionProfileRequest(
        connection_profile=connection_profile,
        full_hierarchy=True,
        parent="parent_value",
    )

    # Make the request
    response = await client.discover_connection_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.DiscoverConnectionProfileRequest, dict]]) – The request object. Request message for ‘discover’ ConnectionProfile request.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response from a discover request.

Return type

async fetch_static_ips(request: Optional[Union[google.cloud.datastream_v1.types.datastream.FetchStaticIpsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.FetchStaticIpsAsyncPager[source]¶

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_fetch_static_ips():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.FetchStaticIpsRequest(
        name="name_value",
    )

    # Make the request
    page_result = client.fetch_static_ips(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.FetchStaticIpsRequest, dict]]) – The request object. Request message for ‘FetchStaticIps’ request.
name (str) –
Required. The resource name for the location for which static IPs should be returned. Must be in the format projects/*/locations/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for a ‘FetchStaticIps’ response. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.FetchStaticIpsAsyncPager

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DatastreamAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DatastreamAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DatastreamAsyncClient

async get_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.ConnectionProfile[source]¶

Use this method to get details about a connection profile.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_get_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.GetConnectionProfileRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_connection_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.GetConnectionProfileRequest, dict]]) – The request object. Request message for getting a connection profile.
name (str) –
Required. The name of the connection profile resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A set of reusable connection configurations to be used as a source or destination for a stream.

Return type

google.cloud.datastream_v1.types.ConnectionProfile

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

async get_private_connection(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetPrivateConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.PrivateConnection[source]¶

Use this method to get details about a private connectivity configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_get_private_connection():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.GetPrivateConnectionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_private_connection(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.GetPrivateConnectionRequest, dict]]) – The request object. Request to get a private connection configuration.
name (str) –
Required. The name of the private connectivity configuration to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.datastream_v1.types.PrivateConnection

async get_route(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.Route[source]¶

Use this method to get details about a route.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_get_route():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.GetRouteRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_route(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.GetRouteRequest, dict]]) – The request object. Route get request.
name (str) –
Required. The name of the Route resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The route resource is the child of the private connection resource, used for defining a route for a private connection.

Return type

google.cloud.datastream_v1.types.Route

async get_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.Stream[source]¶

Use this method to get details about a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_get_stream():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.GetStreamRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_stream(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.GetStreamRequest, dict]]) – The request object. Request message for getting a stream.
name (str) –
Required. The name of the stream resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource representing streaming data from a source to a destination.

Return type

google.cloud.datastream_v1.types.Stream

async get_stream_object(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetStreamObjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.StreamObject[source]¶

Use this method to get details about a stream object.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_get_stream_object():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.GetStreamObjectRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_stream_object(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.GetStreamObjectRequest, dict]]) – The request object. Request for fetching a specific stream object.
name (str) –
Required. The name of the stream object resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A specific stream object (e.g a specific DB table).

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListConnectionProfilesAsyncPager

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.datastream_v1.services.datastream.transports.base.DatastreamTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_connection_profiles(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListConnectionProfilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListConnectionProfilesAsyncPager[source]¶

Use this method to list connection profiles created in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_list_connection_profiles():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.ListConnectionProfilesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_connection_profiles(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.ListConnectionProfilesRequest, dict]]) – The request object. Request message for listing connection profiles.
parent (str) –
Required. The parent that owns the collection of connection profiles.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for listing connection profiles. Iterating over this object will yield results and resolve additional pages automatically.

Return type

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_private_connections(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListPrivateConnectionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListPrivateConnectionsAsyncPager[source]¶

Use this method to list private connectivity configurations in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_list_private_connections():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.ListPrivateConnectionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_private_connections(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.ListPrivateConnectionsRequest, dict]]) – The request object. Request for listing private connections.
parent (str) –
Required. The parent that owns the collection of private connectivity configurations.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response containing a list of private connection configurations. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListPrivateConnectionsAsyncPager

async list_routes(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListRoutesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListRoutesAsyncPager[source]¶

Use this method to list routes created for a private connectivity configuration in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_list_routes():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.ListRoutesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_routes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.ListRoutesRequest, dict]]) – The request object. Route list request.
parent (str) –
Required. The parent that owns the collection of Routess.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Route list response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListRoutesAsyncPager

async list_stream_objects(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListStreamObjectsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListStreamObjectsAsyncPager[source]¶

Use this method to list the objects of a specific stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_list_stream_objects():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.ListStreamObjectsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_stream_objects(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.ListStreamObjectsRequest, dict]]) – The request object. Request for listing all objects for a specific stream.
parent (str) –
Required. The parent stream that owns the collection of objects.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response containing the objects for a stream. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListStreamObjectsAsyncPager

async list_streams(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListStreamsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListStreamsAsyncPager[source]¶

Use this method to list streams in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_list_streams():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.ListStreamsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_streams(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.ListStreamsRequest, dict]]) – The request object. Request message for listing streams.
parent (str) –
Required. The parent that owns the collection of streams.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for listing streams.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListStreamsAsyncPager

async lookup_stream_object(request: Optional[Union[google.cloud.datastream_v1.types.datastream.LookupStreamObjectRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.StreamObject[source]¶

Use this method to look up a stream object by its source object identifier.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_lookup_stream_object():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    source_object_identifier = datastream_v1.SourceObjectIdentifier()
    source_object_identifier.oracle_identifier.schema = "schema_value"
    source_object_identifier.oracle_identifier.table = "table_value"

    request = datastream_v1.LookupStreamObjectRequest(
        parent="parent_value",
        source_object_identifier=source_object_identifier,
    )

    # Make the request
    response = await client.lookup_stream_object(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.LookupStreamObjectRequest, dict]]) – The request object. Request for looking up a specific stream object by its source object identifier.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A specific stream object (e.g a specific DB table).

Return type

google.cloud.datastream_v1.types.StartBackfillJobResponse

static networks_path(project: str, network: str) → str¶: Returns a fully-qualified networks string.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_connection_profile_path(path: str) → Dict[str, str]¶: Parses a connection_profile path into its component segments.

static parse_networks_path(path: str) → Dict[str, str]¶: Parses a networks path into its component segments.

static parse_private_connection_path(path: str) → Dict[str, str]¶: Parses a private_connection path into its component segments.

static parse_route_path(path: str) → Dict[str, str]¶: Parses a route path into its component segments.

static parse_stream_object_path(path: str) → Dict[str, str]¶: Parses a stream_object path into its component segments.

static parse_stream_path(path: str) → Dict[str, str]¶: Parses a stream path into its component segments.

static private_connection_path(project: str, location: str, private_connection: str) → str¶: Returns a fully-qualified private_connection string.

static route_path(project: str, location: str, private_connection: str, route: str) → str¶: Returns a fully-qualified route string.

async start_backfill_job(request: Optional[Union[google.cloud.datastream_v1.types.datastream.StartBackfillJobRequest, dict]] = None, *, object_: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream.StartBackfillJobResponse[source]¶

Use this method to start a backfill job for the specified stream object.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_start_backfill_job():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.StartBackfillJobRequest(
        object_="object__value",
    )

    # Make the request
    response = await client.start_backfill_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.StartBackfillJobRequest, dict]]) – The request object. Request for manually initiating a backfill job for a specific stream object.
object (str) –
Required. The name of the stream object resource to start a backfill job for.

This corresponds to the object_ field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for manually initiating a backfill job for a specific stream object.

Return type

async stop_backfill_job(request: Optional[Union[google.cloud.datastream_v1.types.datastream.StopBackfillJobRequest, dict]] = None, *, object_: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream.StopBackfillJobResponse[source]¶

Use this method to stop a backfill job for the specified stream object.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_stop_backfill_job():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    request = datastream_v1.StopBackfillJobRequest(
        object_="object__value",
    )

    # Make the request
    response = await client.stop_backfill_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.StopBackfillJobRequest, dict]]) – The request object. Request for manually stopping a running backfill job for a specific stream object.
object (str) –
Required. The name of the stream object resource to stop the backfill job for.

This corresponds to the object_ field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for manually stop a backfill job for a specific stream object.

Return type

google.cloud.datastream_v1.types.StopBackfillJobResponse

static stream_object_path(project: str, location: str, stream: str, object: str) → str¶: Returns a fully-qualified stream_object string.

static stream_path(project: str, location: str, stream: str) → str¶: Returns a fully-qualified stream string.

property transport: google.cloud.datastream_v1.services.datastream.transports.base.DatastreamTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: DatastreamTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.UpdateConnectionProfileRequest, dict]] = None, *, connection_profile: Optional[google.cloud.datastream_v1.types.datastream_resources.ConnectionProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to update the parameters of a connection profile.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_update_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    connection_profile = datastream_v1.ConnectionProfile()
    connection_profile.oracle_profile.hostname = "hostname_value"
    connection_profile.oracle_profile.username = "username_value"
    connection_profile.oracle_profile.password = "password_value"
    connection_profile.oracle_profile.database_service = "database_service_value"
    connection_profile.display_name = "display_name_value"

    request = datastream_v1.UpdateConnectionProfileRequest(
        connection_profile=connection_profile,
    )

    # Make the request
    operation = client.update_connection_profile(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.UpdateConnectionProfileRequest, dict]]) – The request object. Connection profile update message.
connection_profile (google.cloud.datastream_v1.types.ConnectionProfile) –
Required. The connection profile to update.

This corresponds to the connection_profile field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.ConnectionProfile A set of reusable connection configurations to be used as a source or: destination for a stream.

Return type

async update_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.UpdateStreamRequest, dict]] = None, *, stream: Optional[google.cloud.datastream_v1.types.datastream_resources.Stream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

Use this method to update the configuration of a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

async def sample_update_stream():
    # Create a client
    client = datastream_v1.DatastreamAsyncClient()

    # Initialize request argument(s)
    stream = datastream_v1.Stream()
    stream.display_name = "display_name_value"
    stream.source_config.source_connection_profile = "source_connection_profile_value"
    stream.destination_config.destination_connection_profile = "destination_connection_profile_value"

    request = datastream_v1.UpdateStreamRequest(
        stream=stream,
    )

    # Make the request
    operation = client.update_stream(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.datastream_v1.types.UpdateStreamRequest, dict]]) – The request object. Request message for updating a stream.
stream (google.cloud.datastream_v1.types.Stream) –
Required. The stream resource to update.

This corresponds to the stream field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.Stream A resource representing streaming data from a source to a destination.

Return type

class google.cloud.datastream_v1.services.datastream.DatastreamClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.datastream_v1.services.datastream.transports.base.DatastreamTransport, typing.Callable[[...], google.cloud.datastream_v1.services.datastream.transports.base.DatastreamTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Datastream service

Instantiates the datastream client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,DatastreamTransport,Callable[..., DatastreamTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the DatastreamTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

static connection_profile_path(project: str, location: str, connection_profile: str) → str[source]¶: Returns a fully-qualified connection_profile string.

create_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreateConnectionProfileRequest, dict]] = None, *, parent: Optional[str] = None, connection_profile: Optional[google.cloud.datastream_v1.types.datastream_resources.ConnectionProfile] = None, connection_profile_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to create a connection profile in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_create_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    connection_profile = datastream_v1.ConnectionProfile()
    connection_profile.oracle_profile.hostname = "hostname_value"
    connection_profile.oracle_profile.username = "username_value"
    connection_profile.oracle_profile.password = "password_value"
    connection_profile.oracle_profile.database_service = "database_service_value"
    connection_profile.display_name = "display_name_value"

    request = datastream_v1.CreateConnectionProfileRequest(
        parent="parent_value",
        connection_profile_id="connection_profile_id_value",
        connection_profile=connection_profile,
    )

    # Make the request
    operation = client.create_connection_profile(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.CreateConnectionProfileRequest, dict]) – The request object. Request message for creating a connection profile.
parent (str) –
Required. The parent that owns the collection of ConnectionProfiles.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
connection_profile (google.cloud.datastream_v1.types.ConnectionProfile) –
Required. The connection profile resource to create.

This corresponds to the connection_profile field on the request instance; if request is provided, this should not be set.
connection_profile_id (str) –
Required. The connection profile identifier.

This corresponds to the connection_profile_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.ConnectionProfile A set of reusable connection configurations to be used as a source or: destination for a stream.

Return type

create_private_connection(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreatePrivateConnectionRequest, dict]] = None, *, parent: Optional[str] = None, private_connection: Optional[google.cloud.datastream_v1.types.datastream_resources.PrivateConnection] = None, private_connection_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to create a private connectivity configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_create_private_connection():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    private_connection = datastream_v1.PrivateConnection()
    private_connection.display_name = "display_name_value"

    request = datastream_v1.CreatePrivateConnectionRequest(
        parent="parent_value",
        private_connection_id="private_connection_id_value",
        private_connection=private_connection,
    )

    # Make the request
    operation = client.create_private_connection(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.CreatePrivateConnectionRequest, dict]) – The request object. Request for creating a private connection.
parent (str) –
Required. The parent that owns the collection of PrivateConnections.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
private_connection (google.cloud.datastream_v1.types.PrivateConnection) –
Required. The Private Connectivity resource to create.

This corresponds to the private_connection field on the request instance; if request is provided, this should not be set.
private_connection_id (str) –
Required. The private connectivity identifier.

This corresponds to the private_connection_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.PrivateConnection The PrivateConnection resource is used to establish private connectivity: between Datastream and a customer’s network.

Return type

create_route(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreateRouteRequest, dict]] = None, *, parent: Optional[str] = None, route: Optional[google.cloud.datastream_v1.types.datastream_resources.Route] = None, route_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to create a route for a private connectivity configuration in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_create_route():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    route = datastream_v1.Route()
    route.display_name = "display_name_value"
    route.destination_address = "destination_address_value"

    request = datastream_v1.CreateRouteRequest(
        parent="parent_value",
        route_id="route_id_value",
        route=route,
    )

    # Make the request
    operation = client.create_route(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.CreateRouteRequest, dict]) – The request object. Route creation request.
parent (str) –
Required. The parent that owns the collection of Routes.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
route (google.cloud.datastream_v1.types.Route) –
Required. The Route resource to create.

This corresponds to the route field on the request instance; if request is provided, this should not be set.
route_id (str) – Required. The Route identifier. This corresponds to the route_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.Route The route resource is the child of the private connection resource,: used for defining a route for a private connection.

Return type

create_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.CreateStreamRequest, dict]] = None, *, parent: Optional[str] = None, stream: Optional[google.cloud.datastream_v1.types.datastream_resources.Stream] = None, stream_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to create a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_create_stream():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    stream = datastream_v1.Stream()
    stream.display_name = "display_name_value"
    stream.source_config.source_connection_profile = "source_connection_profile_value"
    stream.destination_config.destination_connection_profile = "destination_connection_profile_value"

    request = datastream_v1.CreateStreamRequest(
        parent="parent_value",
        stream_id="stream_id_value",
        stream=stream,
    )

    # Make the request
    operation = client.create_stream(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.CreateStreamRequest, dict]) – The request object. Request message for creating a stream.
parent (str) –
Required. The parent that owns the collection of streams.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
stream (google.cloud.datastream_v1.types.Stream) –
Required. The stream resource to create.

This corresponds to the stream field on the request instance; if request is provided, this should not be set.
stream_id (str) – Required. The stream identifier. This corresponds to the stream_id field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.Stream A resource representing streaming data from a source to a destination.

Return type

delete_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeleteConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to delete a connection profile.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_delete_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.DeleteConnectionProfileRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_connection_profile(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.DeleteConnectionProfileRequest, dict]) – The request object. Request message for deleting a connection profile.
name (str) –
Required. The name of the connection profile resource to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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.

Parameters

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

delete_private_connection(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeletePrivateConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to delete a private connectivity configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_delete_private_connection():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.DeletePrivateConnectionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_private_connection(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.DeletePrivateConnectionRequest, dict]) – The request object. Request to delete a private connection.
name (str) –
Required. The name of the private connectivity configuration to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

delete_route(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeleteRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to delete a route.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_delete_route():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.DeleteRouteRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_route(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.DeleteRouteRequest, dict]) – The request object. Route deletion request.
name (str) –
Required. The name of the Route resource to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

delete_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DeleteStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to delete a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_delete_stream():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.DeleteStreamRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_stream(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.DeleteStreamRequest, dict]) – The request object. Request message for deleting a stream.
name (str) –
Required. The name of the stream resource to delete.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty 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);

}

Return type

google.cloud.datastream_v1.types.DiscoverConnectionProfileResponse

discover_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.DiscoverConnectionProfileRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream.DiscoverConnectionProfileResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_discover_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    connection_profile = datastream_v1.ConnectionProfile()
    connection_profile.oracle_profile.hostname = "hostname_value"
    connection_profile.oracle_profile.username = "username_value"
    connection_profile.oracle_profile.password = "password_value"
    connection_profile.oracle_profile.database_service = "database_service_value"
    connection_profile.display_name = "display_name_value"

    request = datastream_v1.DiscoverConnectionProfileRequest(
        connection_profile=connection_profile,
        full_hierarchy=True,
        parent="parent_value",
    )

    # Make the request
    response = client.discover_connection_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.DiscoverConnectionProfileRequest, dict]) – The request object. Request message for ‘discover’ ConnectionProfile request.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response from a discover request.

Return type

fetch_static_ips(request: Optional[Union[google.cloud.datastream_v1.types.datastream.FetchStaticIpsRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.FetchStaticIpsPager[source]¶

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_fetch_static_ips():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.FetchStaticIpsRequest(
        name="name_value",
    )

    # Make the request
    page_result = client.fetch_static_ips(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.FetchStaticIpsRequest, dict]) – The request object. Request message for ‘FetchStaticIps’ request.
name (str) –
Required. The resource name for the location for which static IPs should be returned. Must be in the format projects/*/locations/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for a ‘FetchStaticIps’ response. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.FetchStaticIpsPager

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DatastreamClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DatastreamClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DatastreamClient

get_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.ConnectionProfile[source]¶

Use this method to get details about a connection profile.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_get_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.GetConnectionProfileRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_connection_profile(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.GetConnectionProfileRequest, dict]) – The request object. Request message for getting a connection profile.
name (str) –
Required. The name of the connection profile resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A set of reusable connection configurations to be used as a source or destination for a stream.

Return type

google.cloud.datastream_v1.types.ConnectionProfile

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

get_private_connection(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetPrivateConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.PrivateConnection[source]¶

Use this method to get details about a private connectivity configuration.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_get_private_connection():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.GetPrivateConnectionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_private_connection(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.GetPrivateConnectionRequest, dict]) – The request object. Request to get a private connection configuration.
name (str) –
Required. The name of the private connectivity configuration to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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

Return type

google.cloud.datastream_v1.types.PrivateConnection

get_route(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.Route[source]¶

Use this method to get details about a route.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_get_route():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.GetRouteRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_route(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.GetRouteRequest, dict]) – The request object. Route get request.
name (str) –
Required. The name of the Route resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The route resource is the child of the private connection resource, used for defining a route for a private connection.

Return type

google.cloud.datastream_v1.types.Route

get_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.Stream[source]¶

Use this method to get details about a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_get_stream():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.GetStreamRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_stream(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.GetStreamRequest, dict]) – The request object. Request message for getting a stream.
name (str) –
Required. The name of the stream resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A resource representing streaming data from a source to a destination.

Return type

google.cloud.datastream_v1.types.Stream

get_stream_object(request: Optional[Union[google.cloud.datastream_v1.types.datastream.GetStreamObjectRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.StreamObject[source]¶

Use this method to get details about a stream object.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_get_stream_object():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.GetStreamObjectRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_stream_object(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.GetStreamObjectRequest, dict]) – The request object. Request for fetching a specific stream object.
name (str) –
Required. The name of the stream object resource to get.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A specific stream object (e.g a specific DB table).

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListConnectionProfilesPager

list_connection_profiles(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListConnectionProfilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListConnectionProfilesPager[source]¶

Use this method to list connection profiles created in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_list_connection_profiles():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.ListConnectionProfilesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_connection_profiles(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.ListConnectionProfilesRequest, dict]) – The request object. Request message for listing connection profiles.
parent (str) –
Required. The parent that owns the collection of connection profiles.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for listing connection profiles. Iterating over this object will yield results and resolve additional pages automatically.

Return type

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

list_private_connections(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListPrivateConnectionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListPrivateConnectionsPager[source]¶

Use this method to list private connectivity configurations in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_list_private_connections():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.ListPrivateConnectionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_private_connections(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.ListPrivateConnectionsRequest, dict]) – The request object. Request for listing private connections.
parent (str) –
Required. The parent that owns the collection of private connectivity configurations.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response containing a list of private connection configurations. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListPrivateConnectionsPager

list_routes(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListRoutesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListRoutesPager[source]¶

Use this method to list routes created for a private connectivity configuration in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_list_routes():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.ListRoutesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_routes(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.ListRoutesRequest, dict]) – The request object. Route list request.
parent (str) –
Required. The parent that owns the collection of Routess.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Route list response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListRoutesPager

list_stream_objects(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListStreamObjectsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListStreamObjectsPager[source]¶

Use this method to list the objects of a specific stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_list_stream_objects():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.ListStreamObjectsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_stream_objects(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.ListStreamObjectsRequest, dict]) – The request object. Request for listing all objects for a specific stream.
parent (str) –
Required. The parent stream that owns the collection of objects.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response containing the objects for a stream. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListStreamObjectsPager

list_streams(request: Optional[Union[google.cloud.datastream_v1.types.datastream.ListStreamsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.services.datastream.pagers.ListStreamsPager[source]¶

Use this method to list streams in a project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_list_streams():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.ListStreamsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_streams(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.ListStreamsRequest, dict]) – The request object. Request message for listing streams.
parent (str) –
Required. The parent that owns the collection of streams.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for listing streams.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.datastream_v1.services.datastream.pagers.ListStreamsPager

lookup_stream_object(request: Optional[Union[google.cloud.datastream_v1.types.datastream.LookupStreamObjectRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream_resources.StreamObject[source]¶

Use this method to look up a stream object by its source object identifier.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_lookup_stream_object():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    source_object_identifier = datastream_v1.SourceObjectIdentifier()
    source_object_identifier.oracle_identifier.schema = "schema_value"
    source_object_identifier.oracle_identifier.table = "table_value"

    request = datastream_v1.LookupStreamObjectRequest(
        parent="parent_value",
        source_object_identifier=source_object_identifier,
    )

    # Make the request
    response = client.lookup_stream_object(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.LookupStreamObjectRequest, dict]) – The request object. Request for looking up a specific stream object by its source object identifier.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A specific stream object (e.g a specific DB table).

Return type

google.cloud.datastream_v1.types.StartBackfillJobResponse

static networks_path(project: str, network: str) → str[source]¶: Returns a fully-qualified networks string.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_connection_profile_path(path: str) → Dict[str, str][source]¶: Parses a connection_profile path into its component segments.

static parse_networks_path(path: str) → Dict[str, str][source]¶: Parses a networks path into its component segments.

static parse_private_connection_path(path: str) → Dict[str, str][source]¶: Parses a private_connection path into its component segments.

static parse_route_path(path: str) → Dict[str, str][source]¶: Parses a route path into its component segments.

static parse_stream_object_path(path: str) → Dict[str, str][source]¶: Parses a stream_object path into its component segments.

static parse_stream_path(path: str) → Dict[str, str][source]¶: Parses a stream path into its component segments.

static private_connection_path(project: str, location: str, private_connection: str) → str[source]¶: Returns a fully-qualified private_connection string.

static route_path(project: str, location: str, private_connection: str, route: str) → str[source]¶: Returns a fully-qualified route string.

start_backfill_job(request: Optional[Union[google.cloud.datastream_v1.types.datastream.StartBackfillJobRequest, dict]] = None, *, object_: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream.StartBackfillJobResponse[source]¶

Use this method to start a backfill job for the specified stream object.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_start_backfill_job():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.StartBackfillJobRequest(
        object_="object__value",
    )

    # Make the request
    response = client.start_backfill_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.StartBackfillJobRequest, dict]) – The request object. Request for manually initiating a backfill job for a specific stream object.
object (str) –
Required. The name of the stream object resource to start a backfill job for.

This corresponds to the object_ field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for manually initiating a backfill job for a specific stream object.

Return type

stop_backfill_job(request: Optional[Union[google.cloud.datastream_v1.types.datastream.StopBackfillJobRequest, dict]] = None, *, object_: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.datastream_v1.types.datastream.StopBackfillJobResponse[source]¶

Use this method to stop a backfill job for the specified stream object.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_stop_backfill_job():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    request = datastream_v1.StopBackfillJobRequest(
        object_="object__value",
    )

    # Make the request
    response = client.stop_backfill_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.StopBackfillJobRequest, dict]) – The request object. Request for manually stopping a running backfill job for a specific stream object.
object (str) –
Required. The name of the stream object resource to stop the backfill job for.

This corresponds to the object_ field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response for manually stop a backfill job for a specific stream object.

Return type

google.cloud.datastream_v1.types.StopBackfillJobResponse

static stream_object_path(project: str, location: str, stream: str, object: str) → str[source]¶: Returns a fully-qualified stream_object string.

static stream_path(project: str, location: str, stream: str) → str[source]¶: Returns a fully-qualified stream string.

property transport: google.cloud.datastream_v1.services.datastream.transports.base.DatastreamTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

DatastreamTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_connection_profile(request: Optional[Union[google.cloud.datastream_v1.types.datastream.UpdateConnectionProfileRequest, dict]] = None, *, connection_profile: Optional[google.cloud.datastream_v1.types.datastream_resources.ConnectionProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to update the parameters of a connection profile.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_update_connection_profile():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    connection_profile = datastream_v1.ConnectionProfile()
    connection_profile.oracle_profile.hostname = "hostname_value"
    connection_profile.oracle_profile.username = "username_value"
    connection_profile.oracle_profile.password = "password_value"
    connection_profile.oracle_profile.database_service = "database_service_value"
    connection_profile.display_name = "display_name_value"

    request = datastream_v1.UpdateConnectionProfileRequest(
        connection_profile=connection_profile,
    )

    # Make the request
    operation = client.update_connection_profile(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.UpdateConnectionProfileRequest, dict]) – The request object. Connection profile update message.
connection_profile (google.cloud.datastream_v1.types.ConnectionProfile) –
Required. The connection profile to update.

This corresponds to the connection_profile field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.ConnectionProfile A set of reusable connection configurations to be used as a source or: destination for a stream.

Return type

update_stream(request: Optional[Union[google.cloud.datastream_v1.types.datastream.UpdateStreamRequest, dict]] = None, *, stream: Optional[google.cloud.datastream_v1.types.datastream_resources.Stream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

Use this method to update the configuration of a stream.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import datastream_v1

def sample_update_stream():
    # Create a client
    client = datastream_v1.DatastreamClient()

    # Initialize request argument(s)
    stream = datastream_v1.Stream()
    stream.display_name = "display_name_value"
    stream.source_config.source_connection_profile = "source_connection_profile_value"
    stream.destination_config.destination_connection_profile = "destination_connection_profile_value"

    request = datastream_v1.UpdateStreamRequest(
        stream=stream,
    )

    # Make the request
    operation = client.update_stream(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.datastream_v1.types.UpdateStreamRequest, dict]) – The request object. Request message for updating a stream.
stream (google.cloud.datastream_v1.types.Stream) –
Required. The stream resource to update.

This corresponds to the stream field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
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.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.datastream_v1.types.Stream A resource representing streaming data from a source to a destination.

Return type