Dataflow v1beta3 API - Class SnapshotsV1Beta3.SnapshotsV1Beta3Client (2.0.0-beta07)

public class SnapshotsV1Beta3.SnapshotsV1Beta3Client : ClientBase<SnapshotsV1Beta3.SnapshotsV1Beta3Client>

Reference documentation and code samples for the Dataflow v1beta3 API class SnapshotsV1Beta3.SnapshotsV1Beta3Client.

Client for SnapshotsV1Beta3

Inheritance

object > ClientBase > ClientBaseSnapshotsV1Beta3SnapshotsV1Beta3Client > SnapshotsV1Beta3.SnapshotsV1Beta3Client

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

SnapshotsV1Beta3Client()

protected SnapshotsV1Beta3Client()

Protected parameterless constructor to allow creation of test doubles.

SnapshotsV1Beta3Client(CallInvoker)

public SnapshotsV1Beta3Client(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

SnapshotsV1Beta3Client(ChannelBase)

public SnapshotsV1Beta3Client(ChannelBase channel)

Creates a new client for SnapshotsV1Beta3

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

SnapshotsV1Beta3Client(ClientBaseConfiguration)

protected SnapshotsV1Beta3Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

DeleteSnapshot(DeleteSnapshotRequest, CallOptions)

public virtual DeleteSnapshotResponse DeleteSnapshot(DeleteSnapshotRequest request, CallOptions options)

Deletes a snapshot.

Parameters
Name Description
request DeleteSnapshotRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
DeleteSnapshotResponse

The response received from the server.

DeleteSnapshot(DeleteSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual DeleteSnapshotResponse DeleteSnapshot(DeleteSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a snapshot.

Parameters
Name Description
request DeleteSnapshotRequest

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
DeleteSnapshotResponse

The response received from the server.

DeleteSnapshotAsync(DeleteSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<DeleteSnapshotResponse> DeleteSnapshotAsync(DeleteSnapshotRequest request, CallOptions options)

Deletes a snapshot.

Parameters
Name Description
request DeleteSnapshotRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallDeleteSnapshotResponse

The call object.

DeleteSnapshotAsync(DeleteSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DeleteSnapshotResponse> DeleteSnapshotAsync(DeleteSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a snapshot.

Parameters
Name Description
request DeleteSnapshotRequest

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
AsyncUnaryCallDeleteSnapshotResponse

The call object.

GetSnapshot(GetSnapshotRequest, CallOptions)

public virtual Snapshot GetSnapshot(GetSnapshotRequest request, CallOptions options)

Gets information about a snapshot.

Parameters
Name Description
request GetSnapshotRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Snapshot

The response received from the server.

GetSnapshot(GetSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual Snapshot GetSnapshot(GetSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a snapshot.

Parameters
Name Description
request GetSnapshotRequest

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
Snapshot

The response received from the server.

GetSnapshotAsync(GetSnapshotRequest, CallOptions)

public virtual AsyncUnaryCall<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, CallOptions options)

Gets information about a snapshot.

Parameters
Name Description
request GetSnapshotRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSnapshot

The call object.

GetSnapshotAsync(GetSnapshotRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Snapshot> GetSnapshotAsync(GetSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a snapshot.

Parameters
Name Description
request GetSnapshotRequest

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
AsyncUnaryCallSnapshot

The call object.

ListSnapshots(ListSnapshotsRequest, CallOptions)

public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, CallOptions options)

Lists snapshots.

Parameters
Name Description
request ListSnapshotsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListSnapshotsResponse

The response received from the server.

ListSnapshots(ListSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListSnapshotsResponse ListSnapshots(ListSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists snapshots.

Parameters
Name Description
request ListSnapshotsRequest

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
ListSnapshotsResponse

The response received from the server.

ListSnapshotsAsync(ListSnapshotsRequest, CallOptions)

public virtual AsyncUnaryCall<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, CallOptions options)

Lists snapshots.

Parameters
Name Description
request ListSnapshotsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListSnapshotsResponse

The call object.

ListSnapshotsAsync(ListSnapshotsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListSnapshotsResponse> ListSnapshotsAsync(ListSnapshotsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists snapshots.

Parameters
Name Description
request ListSnapshotsRequest

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
AsyncUnaryCallListSnapshotsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override SnapshotsV1Beta3.SnapshotsV1Beta3Client NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
SnapshotsV1Beta3SnapshotsV1Beta3Client
Overrides