DataStream v1 API - Class Datastream.DatastreamClient (2.7.0)

public class Datastream.DatastreamClient : ClientBase<Datastream.DatastreamClient>

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

Client for Datastream

Inheritance

object > ClientBase > ClientBaseDatastreamDatastreamClient > Datastream.DatastreamClient

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Constructors

DatastreamClient()

protected DatastreamClient()

Protected parameterless constructor to allow creation of test doubles.

DatastreamClient(CallInvoker)

public DatastreamClient(CallInvoker callInvoker)

Creates a new client for Datastream that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

DatastreamClient(ChannelBase)

public DatastreamClient(ChannelBase channel)

Creates a new client for Datastream

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

DatastreamClient(ClientBaseConfiguration)

protected DatastreamClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateConnectionProfile(CreateConnectionProfileRequest, CallOptions)

public virtual Operation CreateConnectionProfile(CreateConnectionProfileRequest request, CallOptions options)

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

Parameters
Name Description
request CreateConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateConnectionProfile(CreateConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateConnectionProfile(CreateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateConnectionProfileAsync(CreateConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateConnectionProfileAsync(CreateConnectionProfileRequest request, CallOptions options)

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

Parameters
Name Description
request CreateConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateConnectionProfileAsync(CreateConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateConnectionProfileAsync(CreateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreatePrivateConnection(CreatePrivateConnectionRequest, CallOptions)

public virtual Operation CreatePrivateConnection(CreatePrivateConnectionRequest request, CallOptions options)

Use this method to create a private connectivity configuration.

Parameters
Name Description
request CreatePrivateConnectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreatePrivateConnection(CreatePrivateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreatePrivateConnection(CreatePrivateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to create a private connectivity configuration.

Parameters
Name Description
request CreatePrivateConnectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreatePrivateConnectionAsync(CreatePrivateConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreatePrivateConnectionAsync(CreatePrivateConnectionRequest request, CallOptions options)

Use this method to create a private connectivity configuration.

Parameters
Name Description
request CreatePrivateConnectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreatePrivateConnectionAsync(CreatePrivateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreatePrivateConnectionAsync(CreatePrivateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to create a private connectivity configuration.

Parameters
Name Description
request CreatePrivateConnectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateRoute(CreateRouteRequest, CallOptions)

public virtual Operation CreateRoute(CreateRouteRequest request, CallOptions options)

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

Parameters
Name Description
request CreateRouteRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateRoute(CreateRouteRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateRoute(CreateRouteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateRouteRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateRouteAsync(CreateRouteRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateRouteAsync(CreateRouteRequest request, CallOptions options)

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

Parameters
Name Description
request CreateRouteRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateRouteAsync(CreateRouteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateRouteAsync(CreateRouteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request CreateRouteRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateStream(CreateStreamRequest, CallOptions)

public virtual Operation CreateStream(CreateStreamRequest request, CallOptions options)

Use this method to create a stream.

Parameters
Name Description
request CreateStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

CreateStream(CreateStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateStream(CreateStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to create a stream.

Parameters
Name Description
request CreateStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

CreateStreamAsync(CreateStreamRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateStreamAsync(CreateStreamRequest request, CallOptions options)

Use this method to create a stream.

Parameters
Name Description
request CreateStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateStreamAsync(CreateStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateStreamAsync(CreateStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to create a stream.

Parameters
Name Description
request CreateStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteConnectionProfile(DeleteConnectionProfileRequest, CallOptions)

public virtual Operation DeleteConnectionProfile(DeleteConnectionProfileRequest request, CallOptions options)

Use this method to delete a connection profile.

Parameters
Name Description
request DeleteConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteConnectionProfile(DeleteConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteConnectionProfile(DeleteConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a connection profile.

Parameters
Name Description
request DeleteConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteConnectionProfileAsync(DeleteConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteConnectionProfileAsync(DeleteConnectionProfileRequest request, CallOptions options)

Use this method to delete a connection profile.

Parameters
Name Description
request DeleteConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteConnectionProfileAsync(DeleteConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteConnectionProfileAsync(DeleteConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a connection profile.

Parameters
Name Description
request DeleteConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeletePrivateConnection(DeletePrivateConnectionRequest, CallOptions)

public virtual Operation DeletePrivateConnection(DeletePrivateConnectionRequest request, CallOptions options)

Use this method to delete a private connectivity configuration.

Parameters
Name Description
request DeletePrivateConnectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeletePrivateConnection(DeletePrivateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeletePrivateConnection(DeletePrivateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a private connectivity configuration.

Parameters
Name Description
request DeletePrivateConnectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeletePrivateConnectionAsync(DeletePrivateConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeletePrivateConnectionAsync(DeletePrivateConnectionRequest request, CallOptions options)

Use this method to delete a private connectivity configuration.

Parameters
Name Description
request DeletePrivateConnectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeletePrivateConnectionAsync(DeletePrivateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeletePrivateConnectionAsync(DeletePrivateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a private connectivity configuration.

Parameters
Name Description
request DeletePrivateConnectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRoute(DeleteRouteRequest, CallOptions)

public virtual Operation DeleteRoute(DeleteRouteRequest request, CallOptions options)

Use this method to delete a route.

Parameters
Name Description
request DeleteRouteRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteRoute(DeleteRouteRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteRoute(DeleteRouteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a route.

Parameters
Name Description
request DeleteRouteRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteRouteAsync(DeleteRouteRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRouteAsync(DeleteRouteRequest request, CallOptions options)

Use this method to delete a route.

Parameters
Name Description
request DeleteRouteRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRouteAsync(DeleteRouteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRouteAsync(DeleteRouteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a route.

Parameters
Name Description
request DeleteRouteRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteStream(DeleteStreamRequest, CallOptions)

public virtual Operation DeleteStream(DeleteStreamRequest request, CallOptions options)

Use this method to delete a stream.

Parameters
Name Description
request DeleteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

DeleteStream(DeleteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteStream(DeleteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a stream.

Parameters
Name Description
request DeleteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

DeleteStreamAsync(DeleteStreamRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteStreamAsync(DeleteStreamRequest request, CallOptions options)

Use this method to delete a stream.

Parameters
Name Description
request DeleteStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteStreamAsync(DeleteStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteStreamAsync(DeleteStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to delete a stream.

Parameters
Name Description
request DeleteStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

DiscoverConnectionProfile(DiscoverConnectionProfileRequest, CallOptions)

public virtual DiscoverConnectionProfileResponse DiscoverConnectionProfile(DiscoverConnectionProfileRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
DiscoverConnectionProfileResponse

The response received from the server.

DiscoverConnectionProfile(DiscoverConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual DiscoverConnectionProfileResponse DiscoverConnectionProfile(DiscoverConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
DiscoverConnectionProfileResponse

The response received from the server.

DiscoverConnectionProfileAsync(DiscoverConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<DiscoverConnectionProfileResponse> DiscoverConnectionProfileAsync(DiscoverConnectionProfileRequest request, CallOptions options)

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 to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallDiscoverConnectionProfileResponse

The call object.

DiscoverConnectionProfileAsync(DiscoverConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DiscoverConnectionProfileResponse> DiscoverConnectionProfileAsync(DiscoverConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallDiscoverConnectionProfileResponse

The call object.

FetchStaticIps(FetchStaticIpsRequest, CallOptions)

public virtual FetchStaticIpsResponse FetchStaticIps(FetchStaticIpsRequest request, CallOptions options)

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

Parameters
Name Description
request FetchStaticIpsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FetchStaticIpsResponse

The response received from the server.

FetchStaticIps(FetchStaticIpsRequest, Metadata, DateTime?, CancellationToken)

public virtual FetchStaticIpsResponse FetchStaticIps(FetchStaticIpsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request FetchStaticIpsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
FetchStaticIpsResponse

The response received from the server.

FetchStaticIpsAsync(FetchStaticIpsRequest, CallOptions)

public virtual AsyncUnaryCall<FetchStaticIpsResponse> FetchStaticIpsAsync(FetchStaticIpsRequest request, CallOptions options)

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

Parameters
Name Description
request FetchStaticIpsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFetchStaticIpsResponse

The call object.

FetchStaticIpsAsync(FetchStaticIpsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FetchStaticIpsResponse> FetchStaticIpsAsync(FetchStaticIpsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request FetchStaticIpsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallFetchStaticIpsResponse

The call object.

GetConnectionProfile(GetConnectionProfileRequest, CallOptions)

public virtual ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, CallOptions options)

Use this method to get details about a connection profile.

Parameters
Name Description
request GetConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ConnectionProfile

The response received from the server.

GetConnectionProfile(GetConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a connection profile.

Parameters
Name Description
request GetConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ConnectionProfile

The response received from the server.

GetConnectionProfileAsync(GetConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, CallOptions options)

Use this method to get details about a connection profile.

Parameters
Name Description
request GetConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallConnectionProfile

The call object.

GetConnectionProfileAsync(GetConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a connection profile.

Parameters
Name Description
request GetConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallConnectionProfile

The call object.

GetPrivateConnection(GetPrivateConnectionRequest, CallOptions)

public virtual PrivateConnection GetPrivateConnection(GetPrivateConnectionRequest request, CallOptions options)

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

Parameters
Name Description
request GetPrivateConnectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
PrivateConnection

The response received from the server.

GetPrivateConnection(GetPrivateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual PrivateConnection GetPrivateConnection(GetPrivateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetPrivateConnectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
PrivateConnection

The response received from the server.

GetPrivateConnectionAsync(GetPrivateConnectionRequest, CallOptions)

public virtual AsyncUnaryCall<PrivateConnection> GetPrivateConnectionAsync(GetPrivateConnectionRequest request, CallOptions options)

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

Parameters
Name Description
request GetPrivateConnectionRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallPrivateConnection

The call object.

GetPrivateConnectionAsync(GetPrivateConnectionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PrivateConnection> GetPrivateConnectionAsync(GetPrivateConnectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request GetPrivateConnectionRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallPrivateConnection

The call object.

GetRoute(GetRouteRequest, CallOptions)

public virtual Route GetRoute(GetRouteRequest request, CallOptions options)

Use this method to get details about a route.

Parameters
Name Description
request GetRouteRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Route

The response received from the server.

GetRoute(GetRouteRequest, Metadata, DateTime?, CancellationToken)

public virtual Route GetRoute(GetRouteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a route.

Parameters
Name Description
request GetRouteRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Route

The response received from the server.

GetRouteAsync(GetRouteRequest, CallOptions)

public virtual AsyncUnaryCall<Route> GetRouteAsync(GetRouteRequest request, CallOptions options)

Use this method to get details about a route.

Parameters
Name Description
request GetRouteRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRoute

The call object.

GetRouteAsync(GetRouteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Route> GetRouteAsync(GetRouteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a route.

Parameters
Name Description
request GetRouteRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallRoute

The call object.

GetStream(GetStreamRequest, CallOptions)

public virtual Stream GetStream(GetStreamRequest request, CallOptions options)

Use this method to get details about a stream.

Parameters
Name Description
request GetStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Stream

The response received from the server.

GetStream(GetStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual Stream GetStream(GetStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a stream.

Parameters
Name Description
request GetStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Stream

The response received from the server.

GetStreamAsync(GetStreamRequest, CallOptions)

public virtual AsyncUnaryCall<Stream> GetStreamAsync(GetStreamRequest request, CallOptions options)

Use this method to get details about a stream.

Parameters
Name Description
request GetStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallStream

The call object.

GetStreamAsync(GetStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Stream> GetStreamAsync(GetStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a stream.

Parameters
Name Description
request GetStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallStream

The call object.

GetStreamObject(GetStreamObjectRequest, CallOptions)

public virtual StreamObject GetStreamObject(GetStreamObjectRequest request, CallOptions options)

Use this method to get details about a stream object.

Parameters
Name Description
request GetStreamObjectRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
StreamObject

The response received from the server.

GetStreamObject(GetStreamObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual StreamObject GetStreamObject(GetStreamObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a stream object.

Parameters
Name Description
request GetStreamObjectRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
StreamObject

The response received from the server.

GetStreamObjectAsync(GetStreamObjectRequest, CallOptions)

public virtual AsyncUnaryCall<StreamObject> GetStreamObjectAsync(GetStreamObjectRequest request, CallOptions options)

Use this method to get details about a stream object.

Parameters
Name Description
request GetStreamObjectRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallStreamObject

The call object.

GetStreamObjectAsync(GetStreamObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StreamObject> GetStreamObjectAsync(GetStreamObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to get details about a stream object.

Parameters
Name Description
request GetStreamObjectRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallStreamObject

The call object.

ListConnectionProfiles(ListConnectionProfilesRequest, CallOptions)

public virtual ListConnectionProfilesResponse ListConnectionProfiles(ListConnectionProfilesRequest request, CallOptions options)

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

Parameters
Name Description
request ListConnectionProfilesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListConnectionProfilesResponse

The response received from the server.

ListConnectionProfiles(ListConnectionProfilesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListConnectionProfilesResponse ListConnectionProfiles(ListConnectionProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListConnectionProfilesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListConnectionProfilesResponse

The response received from the server.

ListConnectionProfilesAsync(ListConnectionProfilesRequest, CallOptions)

public virtual AsyncUnaryCall<ListConnectionProfilesResponse> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, CallOptions options)

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

Parameters
Name Description
request ListConnectionProfilesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListConnectionProfilesResponse

The call object.

ListConnectionProfilesAsync(ListConnectionProfilesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListConnectionProfilesResponse> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListConnectionProfilesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListConnectionProfilesResponse

The call object.

ListPrivateConnections(ListPrivateConnectionsRequest, CallOptions)

public virtual ListPrivateConnectionsResponse ListPrivateConnections(ListPrivateConnectionsRequest request, CallOptions options)

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

Parameters
Name Description
request ListPrivateConnectionsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListPrivateConnectionsResponse

The response received from the server.

ListPrivateConnections(ListPrivateConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListPrivateConnectionsResponse ListPrivateConnections(ListPrivateConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListPrivateConnectionsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListPrivateConnectionsResponse

The response received from the server.

ListPrivateConnectionsAsync(ListPrivateConnectionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListPrivateConnectionsResponse> ListPrivateConnectionsAsync(ListPrivateConnectionsRequest request, CallOptions options)

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

Parameters
Name Description
request ListPrivateConnectionsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListPrivateConnectionsResponse

The call object.

ListPrivateConnectionsAsync(ListPrivateConnectionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListPrivateConnectionsResponse> ListPrivateConnectionsAsync(ListPrivateConnectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListPrivateConnectionsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListPrivateConnectionsResponse

The call object.

ListRoutes(ListRoutesRequest, CallOptions)

public virtual ListRoutesResponse ListRoutes(ListRoutesRequest request, CallOptions options)

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

Parameters
Name Description
request ListRoutesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListRoutesResponse

The response received from the server.

ListRoutes(ListRoutesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRoutesResponse ListRoutes(ListRoutesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListRoutesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListRoutesResponse

The response received from the server.

ListRoutesAsync(ListRoutesRequest, CallOptions)

public virtual AsyncUnaryCall<ListRoutesResponse> ListRoutesAsync(ListRoutesRequest request, CallOptions options)

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

Parameters
Name Description
request ListRoutesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListRoutesResponse

The call object.

ListRoutesAsync(ListRoutesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRoutesResponse> ListRoutesAsync(ListRoutesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListRoutesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListRoutesResponse

The call object.

ListStreamObjects(ListStreamObjectsRequest, CallOptions)

public virtual ListStreamObjectsResponse ListStreamObjects(ListStreamObjectsRequest request, CallOptions options)

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

Parameters
Name Description
request ListStreamObjectsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListStreamObjectsResponse

The response received from the server.

ListStreamObjects(ListStreamObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListStreamObjectsResponse ListStreamObjects(ListStreamObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListStreamObjectsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListStreamObjectsResponse

The response received from the server.

ListStreamObjectsAsync(ListStreamObjectsRequest, CallOptions)

public virtual AsyncUnaryCall<ListStreamObjectsResponse> ListStreamObjectsAsync(ListStreamObjectsRequest request, CallOptions options)

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

Parameters
Name Description
request ListStreamObjectsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListStreamObjectsResponse

The call object.

ListStreamObjectsAsync(ListStreamObjectsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListStreamObjectsResponse> ListStreamObjectsAsync(ListStreamObjectsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListStreamObjectsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListStreamObjectsResponse

The call object.

ListStreams(ListStreamsRequest, CallOptions)

public virtual ListStreamsResponse ListStreams(ListStreamsRequest request, CallOptions options)

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

Parameters
Name Description
request ListStreamsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListStreamsResponse

The response received from the server.

ListStreams(ListStreamsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListStreamsResponse ListStreams(ListStreamsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListStreamsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListStreamsResponse

The response received from the server.

ListStreamsAsync(ListStreamsRequest, CallOptions)

public virtual AsyncUnaryCall<ListStreamsResponse> ListStreamsAsync(ListStreamsRequest request, CallOptions options)

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

Parameters
Name Description
request ListStreamsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListStreamsResponse

The call object.

ListStreamsAsync(ListStreamsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListStreamsResponse> ListStreamsAsync(ListStreamsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListStreamsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListStreamsResponse

The call object.

LookupStreamObject(LookupStreamObjectRequest, CallOptions)

public virtual StreamObject LookupStreamObject(LookupStreamObjectRequest request, CallOptions options)

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

Parameters
Name Description
request LookupStreamObjectRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
StreamObject

The response received from the server.

LookupStreamObject(LookupStreamObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual StreamObject LookupStreamObject(LookupStreamObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request LookupStreamObjectRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
StreamObject

The response received from the server.

LookupStreamObjectAsync(LookupStreamObjectRequest, CallOptions)

public virtual AsyncUnaryCall<StreamObject> LookupStreamObjectAsync(LookupStreamObjectRequest request, CallOptions options)

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

Parameters
Name Description
request LookupStreamObjectRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallStreamObject

The call object.

LookupStreamObjectAsync(LookupStreamObjectRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StreamObject> LookupStreamObjectAsync(LookupStreamObjectRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request LookupStreamObjectRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallStreamObject

The call object.

NewInstance(ClientBaseConfiguration)

protected override Datastream.DatastreamClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
DatastreamDatastreamClient
Overrides

StartBackfillJob(StartBackfillJobRequest, CallOptions)

public virtual StartBackfillJobResponse StartBackfillJob(StartBackfillJobRequest request, CallOptions options)

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

Parameters
Name Description
request StartBackfillJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
StartBackfillJobResponse

The response received from the server.

StartBackfillJob(StartBackfillJobRequest, Metadata, DateTime?, CancellationToken)

public virtual StartBackfillJobResponse StartBackfillJob(StartBackfillJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request StartBackfillJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
StartBackfillJobResponse

The response received from the server.

StartBackfillJobAsync(StartBackfillJobRequest, CallOptions)

public virtual AsyncUnaryCall<StartBackfillJobResponse> StartBackfillJobAsync(StartBackfillJobRequest request, CallOptions options)

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

Parameters
Name Description
request StartBackfillJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallStartBackfillJobResponse

The call object.

StartBackfillJobAsync(StartBackfillJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StartBackfillJobResponse> StartBackfillJobAsync(StartBackfillJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request StartBackfillJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallStartBackfillJobResponse

The call object.

StopBackfillJob(StopBackfillJobRequest, CallOptions)

public virtual StopBackfillJobResponse StopBackfillJob(StopBackfillJobRequest request, CallOptions options)

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

Parameters
Name Description
request StopBackfillJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
StopBackfillJobResponse

The response received from the server.

StopBackfillJob(StopBackfillJobRequest, Metadata, DateTime?, CancellationToken)

public virtual StopBackfillJobResponse StopBackfillJob(StopBackfillJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request StopBackfillJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
StopBackfillJobResponse

The response received from the server.

StopBackfillJobAsync(StopBackfillJobRequest, CallOptions)

public virtual AsyncUnaryCall<StopBackfillJobResponse> StopBackfillJobAsync(StopBackfillJobRequest request, CallOptions options)

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

Parameters
Name Description
request StopBackfillJobRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallStopBackfillJobResponse

The call object.

StopBackfillJobAsync(StopBackfillJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<StopBackfillJobResponse> StopBackfillJobAsync(StopBackfillJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request StopBackfillJobRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallStopBackfillJobResponse

The call object.

UpdateConnectionProfile(UpdateConnectionProfileRequest, CallOptions)

public virtual Operation UpdateConnectionProfile(UpdateConnectionProfileRequest request, CallOptions options)

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

Parameters
Name Description
request UpdateConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateConnectionProfile(UpdateConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateConnectionProfile(UpdateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request UpdateConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, CallOptions options)

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

Parameters
Name Description
request UpdateConnectionProfileRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request UpdateConnectionProfileRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateStream(UpdateStreamRequest, CallOptions)

public virtual Operation UpdateStream(UpdateStreamRequest request, CallOptions options)

Use this method to update the configuration of a stream.

Parameters
Name Description
request UpdateStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Operation

The response received from the server.

UpdateStream(UpdateStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateStream(UpdateStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to update the configuration of a stream.

Parameters
Name Description
request UpdateStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

UpdateStreamAsync(UpdateStreamRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateStreamAsync(UpdateStreamRequest request, CallOptions options)

Use this method to update the configuration of a stream.

Parameters
Name Description
request UpdateStreamRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateStreamAsync(UpdateStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateStreamAsync(UpdateStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Use this method to update the configuration of a stream.

Parameters
Name Description
request UpdateStreamRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallOperation

The call object.