Class DatastreamAsyncClient

Datastream service

Inheritance

builtins.object > DatastreamAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DatastreamTransportThe transport used by the client instance.

Methods

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

Parameter
NameDescription
billing_account str

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

Parameter
NameDescription
folder str

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

Parameters
NameDescription
project str
location str

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

Parameter
NameDescription
organization str

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

Parameter
NameDescription
project str

connection_profile_path

connection_profile_path(project: str, location: str, connection_profile: str)

Returns a fully-qualified connection_profile string.

Parameters
NameDescription
project str
location str
connection_profile str

create_connection_profile

create_connection_profile(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.CreateConnectionProfileRequest, dict]] = None, *, parent: Optional[str] = None, connection_profile: Optional[google.cloud.datastream_v1alpha1.types.datastream_resources.ConnectionProfile] = None, connection_profile_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.CreateConnectionProfileRequest, dict]

The request object.

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 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be ConnectionProfile

create_private_connection

create_private_connection(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.CreatePrivateConnectionRequest, dict]] = None, *, parent: Optional[str] = None, private_connection: Optional[google.cloud.datastream_v1alpha1.types.datastream_resources.PrivateConnection] = None, private_connection_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to create a private connectivity configuration.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.CreatePrivateConnectionRequest, dict]

The request object.

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 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be PrivateConnection The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.

create_route

create_route(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.CreateRouteRequest, dict]] = None, *, parent: Optional[str] = None, route: Optional[google.cloud.datastream_v1alpha1.types.datastream_resources.Route] = None, route_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.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 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Route The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.

create_stream

create_stream(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.CreateStreamRequest, dict]] = None, *, parent: Optional[str] = None, stream: Optional[google.cloud.datastream_v1alpha1.types.datastream_resources.Stream] = None, stream_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to create a stream.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.CreateStreamRequest, dict]

The request object.

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 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Stream

delete_connection_profile

delete_connection_profile(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.DeleteConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to delete a connection profile..

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.DeleteConnectionProfileRequest, dict]

The request object.

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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); } The JSON representation for Empty is empty JSON object {}.

delete_private_connection

delete_private_connection(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.DeletePrivateConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to delete a private connectivity configuration.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.DeletePrivateConnectionRequest, dict]

The request object.

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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); } The JSON representation for Empty is empty JSON object {}.

delete_route

delete_route(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.DeleteRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to delete a route.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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); } The JSON representation for Empty is empty JSON object {}.

delete_stream

delete_stream(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.DeleteStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to delete a stream.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.DeleteStreamRequest, dict]

The request object.

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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); } The JSON representation for Empty is empty JSON object {}.

discover_connection_profile

discover_connection_profile(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.DiscoverConnectionProfileRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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 under a parent data object that's optionally supplied in the request.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.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.

fetch_errors

fetch_errors(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.FetchErrorsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to fetch any errors associated with a stream.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.FetchErrorsRequest, dict]

The request object. Request message for 'FetchErrors' 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be FetchErrorsResponse Response message for a 'FetchErrors' response.

fetch_static_ips

fetch_static_ips(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.FetchStaticIpsRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

The FetchStaticIps API call exposes the static ips used by Datastream. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.FetchStaticIpsRequest, dict]

The request object. Request message for 'FetchStaticIps' request.

name `str`

Required. The name resource of the Response type. 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
TypeDescription
google.cloud.datastream_v1alpha1.services.datastream.pagers.FetchStaticIpsAsyncPagerResponse message for a 'FetchStaticIps' response. Iterating over this object will yield results and resolve additional pages automatically.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameters
NameDescription
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
TypeDescription
DatastreamAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameters
NameDescription
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
TypeDescription
DatastreamAsyncClientThe constructed client.

from_service_account_json

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

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

Parameters
NameDescription
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
TypeDescription
DatastreamAsyncClientThe constructed client.

get_connection_profile

get_connection_profile(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.GetConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to get details about a connection profile.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.GetConnectionProfileRequest, dict]

The request object.

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.

get_private_connection

get_private_connection(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.GetPrivateConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.GetPrivateConnectionRequest, dict]

The request object.

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
TypeDescription
google.cloud.datastream_v1alpha1.types.PrivateConnectionThe PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.

get_route

get_route(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.GetRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to get details about a route.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.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
TypeDescription
google.cloud.datastream_v1alpha1.types.RouteThe Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.

get_stream

get_stream(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.GetStreamRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to get details about a stream.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.GetStreamRequest, dict]

The request object.

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.

get_transport_class

get_transport_class()

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameter
NameDescription
label str

list_connection_profiles

list_connection_profiles(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.ListConnectionProfilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.ListConnectionProfilesRequest, dict]

The request object.

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
TypeDescription
google.cloud.datastream_v1alpha1.services.datastream.pagers.ListConnectionProfilesAsyncPagerIterating over this object will yield results and resolve additional pages automatically.

list_private_connections

list_private_connections(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.ListPrivateConnectionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.ListPrivateConnectionsRequest, dict]

The request object.

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
TypeDescription
google.cloud.datastream_v1alpha1.services.datastream.pagers.ListPrivateConnectionsAsyncPagerIterating over this object will yield results and resolve additional pages automatically.

list_routes

list_routes(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.ListRoutesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.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
TypeDescription
google.cloud.datastream_v1alpha1.services.datastream.pagers.ListRoutesAsyncPagerroute list response Iterating over this object will yield results and resolve additional pages automatically.

list_streams

list_streams(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.ListStreamsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.ListStreamsRequest, dict]

The request object.

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
TypeDescription
google.cloud.datastream_v1alpha1.services.datastream.pagers.ListStreamsAsyncPagerIterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

Parameter
NameDescription
path str

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

Parameter
NameDescription
path str

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

Parameter
NameDescription
path str

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

Parameter
NameDescription
path str

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

Parameter
NameDescription
path str

parse_connection_profile_path

parse_connection_profile_path(path: str)

Parses a connection_profile path into its component segments.

Parameter
NameDescription
path str

parse_private_connection_path

parse_private_connection_path(path: str)

Parses a private_connection path into its component segments.

Parameter
NameDescription
path str

parse_route_path

parse_route_path(path: str)

Parses a route path into its component segments.

Parameter
NameDescription
path str

parse_stream_path

parse_stream_path(path: str)

Parses a stream path into its component segments.

Parameter
NameDescription
path str

private_connection_path

private_connection_path(project: str, location: str, private_connection: str)

Returns a fully-qualified private_connection string.

Parameters
NameDescription
project str
location str
private_connection str

route_path

route_path(project: str, location: str, private_connection: str, route: str)

Returns a fully-qualified route string.

Parameters
NameDescription
project str
location str
private_connection str
route str

stream_path

stream_path(project: str, location: str, stream: str)

Returns a fully-qualified stream string.

Parameters
NameDescription
project str
location str
stream str

update_connection_profile

update_connection_profile(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.UpdateConnectionProfileRequest, dict]] = None, *, connection_profile: Optional[google.cloud.datastream_v1alpha1.types.datastream_resources.ConnectionProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.UpdateConnectionProfileRequest, dict]

The request object.

connection_profile ConnectionProfile

Required. The ConnectionProfile 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be ConnectionProfile

update_stream

update_stream(request: Optional[Union[google.cloud.datastream_v1alpha1.types.datastream.UpdateStreamRequest, dict]] = None, *, stream: Optional[google.cloud.datastream_v1alpha1.types.datastream_resources.Stream] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Use this method to update the configuration of a stream.

Parameters
NameDescription
request Union[google.cloud.datastream_v1alpha1.types.UpdateStreamRequest, dict]

The request object.

stream 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Stream