DataStream v1 API - Class DatastreamClientImpl (2.11.0) 

public sealed class DatastreamClientImpl : DatastreamClient

Reference documentation and code samples for the DataStream v1 API class DatastreamClientImpl.

Datastream client wrapper implementation, for convenient use.

Inheritance

object > DatastreamClient > DatastreamClientImpl

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Remarks

Datastream service

Constructors

DatastreamClientImpl(DatastreamClient, DatastreamSettings, ILogger)

public DatastreamClientImpl(Datastream.DatastreamClient grpcClient, DatastreamSettings settings, ILogger logger)

Constructs a client wrapper for the Datastream service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DatastreamDatastreamClient

The underlying gRPC client.
settings DatastreamSettings

The base DatastreamSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateConnectionProfileOperationsClient

public override OperationsClient CreateConnectionProfileOperationsClient { get; }

The long-running operations client for CreateConnectionProfile.

Property Value
Type Description
OperationsClient
Overrides

CreatePrivateConnectionOperationsClient

public override OperationsClient CreatePrivateConnectionOperationsClient { get; }

The long-running operations client for CreatePrivateConnection.

Property Value
Type Description
OperationsClient
Overrides

CreateRouteOperationsClient

public override OperationsClient CreateRouteOperationsClient { get; }

The long-running operations client for CreateRoute.

Property Value
Type Description
OperationsClient
Overrides

CreateStreamOperationsClient

public override OperationsClient CreateStreamOperationsClient { get; }

The long-running operations client for CreateStream.

Property Value
Type Description
OperationsClient
Overrides

DeleteConnectionProfileOperationsClient

public override OperationsClient DeleteConnectionProfileOperationsClient { get; }

The long-running operations client for DeleteConnectionProfile.

Property Value
Type Description
OperationsClient
Overrides

DeletePrivateConnectionOperationsClient

public override OperationsClient DeletePrivateConnectionOperationsClient { get; }

The long-running operations client for DeletePrivateConnection.

Property Value
Type Description
OperationsClient
Overrides

DeleteRouteOperationsClient

public override OperationsClient DeleteRouteOperationsClient { get; }

The long-running operations client for DeleteRoute.

Property Value
Type Description
OperationsClient
Overrides

DeleteStreamOperationsClient

public override OperationsClient DeleteStreamOperationsClient { get; }

The long-running operations client for DeleteStream.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Datastream.DatastreamClient GrpcClient { get; }

The underlying gRPC Datastream client

Property Value
Type Description
DatastreamDatastreamClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RunStreamOperationsClient

public override OperationsClient RunStreamOperationsClient { get; }

The long-running operations client for RunStream.

Property Value
Type Description
OperationsClient
Overrides

UpdateConnectionProfileOperationsClient

public override OperationsClient UpdateConnectionProfileOperationsClient { get; }

The long-running operations client for UpdateConnectionProfile.

Property Value
Type Description
OperationsClient
Overrides

UpdateStreamOperationsClient

public override OperationsClient UpdateStreamOperationsClient { get; }

The long-running operations client for UpdateStream.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateConnectionProfile(CreateConnectionProfileRequest, CallSettings)

public override Operation<ConnectionProfile, OperationMetadata> CreateConnectionProfile(CreateConnectionProfileRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConnectionProfileOperationMetadata

The RPC response.
Overrides

CreateConnectionProfileAsync(CreateConnectionProfileRequest, CallSettings)

public override Task<Operation<ConnectionProfile, OperationMetadata>> CreateConnectionProfileAsync(CreateConnectionProfileRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConnectionProfileOperationMetadata

A Task containing the RPC response.
Overrides

CreatePrivateConnection(CreatePrivateConnectionRequest, CallSettings)

public override Operation<PrivateConnection, OperationMetadata> CreatePrivateConnection(CreatePrivateConnectionRequest request, CallSettings callSettings = null)

Use this method to create a private connectivity configuration.

Parameters
Name Description
request CreatePrivateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationPrivateConnectionOperationMetadata

The RPC response.
Overrides

CreatePrivateConnectionAsync(CreatePrivateConnectionRequest, CallSettings)

public override Task<Operation<PrivateConnection, OperationMetadata>> CreatePrivateConnectionAsync(CreatePrivateConnectionRequest request, CallSettings callSettings = null)

Use this method to create a private connectivity configuration.

Parameters
Name Description
request CreatePrivateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationPrivateConnectionOperationMetadata

A Task containing the RPC response.
Overrides

CreateRoute(CreateRouteRequest, CallSettings)

public override Operation<Route, OperationMetadata> CreateRoute(CreateRouteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateRouteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRouteOperationMetadata

The RPC response.
Overrides

CreateRouteAsync(CreateRouteRequest, CallSettings)

public override Task<Operation<Route, OperationMetadata>> CreateRouteAsync(CreateRouteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateRouteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRouteOperationMetadata

A Task containing the RPC response.
Overrides

CreateStream(CreateStreamRequest, CallSettings)

public override Operation<Stream, OperationMetadata> CreateStream(CreateStreamRequest request, CallSettings callSettings = null)

Use this method to create a stream.

Parameters
Name Description
request CreateStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationStreamOperationMetadata

The RPC response.
Overrides

CreateStreamAsync(CreateStreamRequest, CallSettings)

public override Task<Operation<Stream, OperationMetadata>> CreateStreamAsync(CreateStreamRequest request, CallSettings callSettings = null)

Use this method to create a stream.

Parameters
Name Description
request CreateStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationStreamOperationMetadata

A Task containing the RPC response.
Overrides

DeleteConnectionProfile(DeleteConnectionProfileRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteConnectionProfile(DeleteConnectionProfileRequest request, CallSettings callSettings = null)

Use this method to delete a connection profile.

Parameters
Name Description
request DeleteConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteConnectionProfileAsync(DeleteConnectionProfileRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteConnectionProfileAsync(DeleteConnectionProfileRequest request, CallSettings callSettings = null)

Use this method to delete a connection profile.

Parameters
Name Description
request DeleteConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeletePrivateConnection(DeletePrivateConnectionRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeletePrivateConnection(DeletePrivateConnectionRequest request, CallSettings callSettings = null)

Use this method to delete a private connectivity configuration.

Parameters
Name Description
request DeletePrivateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeletePrivateConnectionAsync(DeletePrivateConnectionRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeletePrivateConnectionAsync(DeletePrivateConnectionRequest request, CallSettings callSettings = null)

Use this method to delete a private connectivity configuration.

Parameters
Name Description
request DeletePrivateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteRoute(DeleteRouteRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteRoute(DeleteRouteRequest request, CallSettings callSettings = null)

Use this method to delete a route.

Parameters
Name Description
request DeleteRouteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteRouteAsync(DeleteRouteRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteRouteAsync(DeleteRouteRequest request, CallSettings callSettings = null)

Use this method to delete a route.

Parameters
Name Description
request DeleteRouteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteStream(DeleteStreamRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteStream(DeleteStreamRequest request, CallSettings callSettings = null)

Use this method to delete a stream.

Parameters
Name Description
request DeleteStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteStreamAsync(DeleteStreamRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteStreamAsync(DeleteStreamRequest request, CallSettings callSettings = null)

Use this method to delete a stream.

Parameters
Name Description
request DeleteStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DiscoverConnectionProfile(DiscoverConnectionProfileRequest, CallSettings)

public override DiscoverConnectionProfileResponse DiscoverConnectionProfile(DiscoverConnectionProfileRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DiscoverConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
DiscoverConnectionProfileResponse

The RPC response.
Overrides

DiscoverConnectionProfileAsync(DiscoverConnectionProfileRequest, CallSettings)

public override Task<DiscoverConnectionProfileResponse> DiscoverConnectionProfileAsync(DiscoverConnectionProfileRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request DiscoverConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDiscoverConnectionProfileResponse

A Task containing the RPC response.
Overrides

FetchStaticIps(FetchStaticIpsRequest, CallSettings)

public override PagedEnumerable<FetchStaticIpsResponse, string> FetchStaticIps(FetchStaticIpsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request FetchStaticIpsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableFetchStaticIpsResponsestring

A pageable sequence of string resources.
Overrides

FetchStaticIpsAsync(FetchStaticIpsRequest, CallSettings)

public override PagedAsyncEnumerable<FetchStaticIpsResponse, string> FetchStaticIpsAsync(FetchStaticIpsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request FetchStaticIpsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableFetchStaticIpsResponsestring

A pageable asynchronous sequence of string resources.
Overrides

GetConnectionProfile(GetConnectionProfileRequest, CallSettings)

public override ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, CallSettings callSettings = null)

Use this method to get details about a connection profile.

Parameters
Name Description
request GetConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConnectionProfile

The RPC response.
Overrides

GetConnectionProfileAsync(GetConnectionProfileRequest, CallSettings)

public override Task<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, CallSettings callSettings = null)

Use this method to get details about a connection profile.

Parameters
Name Description
request GetConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConnectionProfile

A Task containing the RPC response.
Overrides

GetPrivateConnection(GetPrivateConnectionRequest, CallSettings)

public override PrivateConnection GetPrivateConnection(GetPrivateConnectionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetPrivateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PrivateConnection

The RPC response.
Overrides

GetPrivateConnectionAsync(GetPrivateConnectionRequest, CallSettings)

public override Task<PrivateConnection> GetPrivateConnectionAsync(GetPrivateConnectionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetPrivateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskPrivateConnection

A Task containing the RPC response.
Overrides

GetRoute(GetRouteRequest, CallSettings)

public override Route GetRoute(GetRouteRequest request, CallSettings callSettings = null)

Use this method to get details about a route.

Parameters
Name Description
request GetRouteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Route

The RPC response.
Overrides

GetRouteAsync(GetRouteRequest, CallSettings)

public override Task<Route> GetRouteAsync(GetRouteRequest request, CallSettings callSettings = null)

Use this method to get details about a route.

Parameters
Name Description
request GetRouteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRoute

A Task containing the RPC response.
Overrides

GetStream(GetStreamRequest, CallSettings)

public override Stream GetStream(GetStreamRequest request, CallSettings callSettings = null)

Use this method to get details about a stream.

Parameters
Name Description
request GetStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Stream

The RPC response.
Overrides

GetStreamAsync(GetStreamRequest, CallSettings)

public override Task<Stream> GetStreamAsync(GetStreamRequest request, CallSettings callSettings = null)

Use this method to get details about a stream.

Parameters
Name Description
request GetStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStream

A Task containing the RPC response.
Overrides

GetStreamObject(GetStreamObjectRequest, CallSettings)

public override StreamObject GetStreamObject(GetStreamObjectRequest request, CallSettings callSettings = null)

Use this method to get details about a stream object.

Parameters
Name Description
request GetStreamObjectRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
StreamObject

The RPC response.
Overrides

GetStreamObjectAsync(GetStreamObjectRequest, CallSettings)

public override Task<StreamObject> GetStreamObjectAsync(GetStreamObjectRequest request, CallSettings callSettings = null)

Use this method to get details about a stream object.

Parameters
Name Description
request GetStreamObjectRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStreamObject

A Task containing the RPC response.
Overrides

ListConnectionProfiles(ListConnectionProfilesRequest, CallSettings)

public override PagedEnumerable<ListConnectionProfilesResponse, ConnectionProfile> ListConnectionProfiles(ListConnectionProfilesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListConnectionProfilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConnectionProfilesResponseConnectionProfile

A pageable sequence of ConnectionProfile resources.
Overrides

ListConnectionProfilesAsync(ListConnectionProfilesRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectionProfilesResponse, ConnectionProfile> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListConnectionProfilesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConnectionProfilesResponseConnectionProfile

A pageable asynchronous sequence of ConnectionProfile resources.
Overrides

ListPrivateConnections(ListPrivateConnectionsRequest, CallSettings)

public override PagedEnumerable<ListPrivateConnectionsResponse, PrivateConnection> ListPrivateConnections(ListPrivateConnectionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListPrivateConnectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListPrivateConnectionsResponsePrivateConnection

A pageable sequence of PrivateConnection resources.
Overrides

ListPrivateConnectionsAsync(ListPrivateConnectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPrivateConnectionsResponse, PrivateConnection> ListPrivateConnectionsAsync(ListPrivateConnectionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListPrivateConnectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListPrivateConnectionsResponsePrivateConnection

A pageable asynchronous sequence of PrivateConnection resources.
Overrides

ListRoutes(ListRoutesRequest, CallSettings)

public override PagedEnumerable<ListRoutesResponse, Route> ListRoutes(ListRoutesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListRoutesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListRoutesResponseRoute

A pageable sequence of Route resources.
Overrides

ListRoutesAsync(ListRoutesRequest, CallSettings)

public override PagedAsyncEnumerable<ListRoutesResponse, Route> ListRoutesAsync(ListRoutesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListRoutesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListRoutesResponseRoute

A pageable asynchronous sequence of Route resources.
Overrides

ListStreamObjects(ListStreamObjectsRequest, CallSettings)

public override PagedEnumerable<ListStreamObjectsResponse, StreamObject> ListStreamObjects(ListStreamObjectsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListStreamObjectsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListStreamObjectsResponseStreamObject

A pageable sequence of StreamObject resources.
Overrides

ListStreamObjectsAsync(ListStreamObjectsRequest, CallSettings)

public override PagedAsyncEnumerable<ListStreamObjectsResponse, StreamObject> ListStreamObjectsAsync(ListStreamObjectsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListStreamObjectsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListStreamObjectsResponseStreamObject

A pageable asynchronous sequence of StreamObject resources.
Overrides

ListStreams(ListStreamsRequest, CallSettings)

public override PagedEnumerable<ListStreamsResponse, Stream> ListStreams(ListStreamsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListStreamsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListStreamsResponseStream

A pageable sequence of Stream resources.
Overrides

ListStreamsAsync(ListStreamsRequest, CallSettings)

public override PagedAsyncEnumerable<ListStreamsResponse, Stream> ListStreamsAsync(ListStreamsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListStreamsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListStreamsResponseStream

A pageable asynchronous sequence of Stream resources.
Overrides

LookupStreamObject(LookupStreamObjectRequest, CallSettings)

public override StreamObject LookupStreamObject(LookupStreamObjectRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LookupStreamObjectRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
StreamObject

The RPC response.
Overrides

LookupStreamObjectAsync(LookupStreamObjectRequest, CallSettings)

public override Task<StreamObject> LookupStreamObjectAsync(LookupStreamObjectRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request LookupStreamObjectRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStreamObject

A Task containing the RPC response.
Overrides

RunStream(RunStreamRequest, CallSettings)

public override Operation<Stream, OperationMetadata> RunStream(RunStreamRequest request, CallSettings callSettings = null)

Use this method to start, resume or recover a stream with a non default CDC strategy.

Parameters
Name Description
request RunStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationStreamOperationMetadata

The RPC response.
Overrides

RunStreamAsync(RunStreamRequest, CallSettings)

public override Task<Operation<Stream, OperationMetadata>> RunStreamAsync(RunStreamRequest request, CallSettings callSettings = null)

Use this method to start, resume or recover a stream with a non default CDC strategy.

Parameters
Name Description
request RunStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationStreamOperationMetadata

A Task containing the RPC response.
Overrides

StartBackfillJob(StartBackfillJobRequest, CallSettings)

public override StartBackfillJobResponse StartBackfillJob(StartBackfillJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StartBackfillJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
StartBackfillJobResponse

The RPC response.
Overrides

StartBackfillJobAsync(StartBackfillJobRequest, CallSettings)

public override Task<StartBackfillJobResponse> StartBackfillJobAsync(StartBackfillJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StartBackfillJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStartBackfillJobResponse

A Task containing the RPC response.
Overrides

StopBackfillJob(StopBackfillJobRequest, CallSettings)

public override StopBackfillJobResponse StopBackfillJob(StopBackfillJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StopBackfillJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
StopBackfillJobResponse

The RPC response.
Overrides

StopBackfillJobAsync(StopBackfillJobRequest, CallSettings)

public override Task<StopBackfillJobResponse> StopBackfillJobAsync(StopBackfillJobRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request StopBackfillJobRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStopBackfillJobResponse

A Task containing the RPC response.
Overrides

UpdateConnectionProfile(UpdateConnectionProfileRequest, CallSettings)

public override Operation<ConnectionProfile, OperationMetadata> UpdateConnectionProfile(UpdateConnectionProfileRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConnectionProfileOperationMetadata

The RPC response.
Overrides

UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, CallSettings)

public override Task<Operation<ConnectionProfile, OperationMetadata>> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateConnectionProfileRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConnectionProfileOperationMetadata

A Task containing the RPC response.
Overrides

UpdateStream(UpdateStreamRequest, CallSettings)

public override Operation<Stream, OperationMetadata> UpdateStream(UpdateStreamRequest request, CallSettings callSettings = null)

Use this method to update the configuration of a stream.

Parameters
Name Description
request UpdateStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationStreamOperationMetadata

The RPC response.
Overrides

UpdateStreamAsync(UpdateStreamRequest, CallSettings)

public override Task<Operation<Stream, OperationMetadata>> UpdateStreamAsync(UpdateStreamRequest request, CallSettings callSettings = null)

Use this method to update the configuration of a stream.

Parameters
Name Description
request UpdateStreamRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationStreamOperationMetadata

A Task containing the RPC response.
Overrides