Class Bigtable.BigtableClient (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public class BigtableClient : ClientBase<Bigtable.BigtableClient>

Client for Bigtable

Inheritance

Object > ClientBase > ClientBase<Bigtable.BigtableClient> > Bigtable.BigtableClient

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

BigtableClient()

protected BigtableClient()

Protected parameterless constructor to allow creation of test doubles.

BigtableClient(CallInvoker)

public BigtableClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

BigtableClient(ChannelBase)

public BigtableClient(ChannelBase channel)

Creates a new client for Bigtable

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

BigtableClient(ClientBase.ClientBaseConfiguration)

protected BigtableClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CheckAndMutateRow(CheckAndMutateRowRequest, CallOptions)

public virtual CheckAndMutateRowResponse CheckAndMutateRow(CheckAndMutateRowRequest request, CallOptions options)

Mutates a row atomically based on the output of a predicate Reader filter.

Parameters
NameDescription
requestCheckAndMutateRowRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CheckAndMutateRowResponse

The response received from the server.

CheckAndMutateRow(CheckAndMutateRowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CheckAndMutateRowResponse CheckAndMutateRow(CheckAndMutateRowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Mutates a row atomically based on the output of a predicate Reader filter.

Parameters
NameDescription
requestCheckAndMutateRowRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
CheckAndMutateRowResponse

The response received from the server.

CheckAndMutateRowAsync(CheckAndMutateRowRequest, CallOptions)

public virtual AsyncUnaryCall<CheckAndMutateRowResponse> CheckAndMutateRowAsync(CheckAndMutateRowRequest request, CallOptions options)

Mutates a row atomically based on the output of a predicate Reader filter.

Parameters
NameDescription
requestCheckAndMutateRowRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CheckAndMutateRowResponse>

The call object.

CheckAndMutateRowAsync(CheckAndMutateRowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CheckAndMutateRowResponse> CheckAndMutateRowAsync(CheckAndMutateRowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Mutates a row atomically based on the output of a predicate Reader filter.

Parameters
NameDescription
requestCheckAndMutateRowRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<CheckAndMutateRowResponse>

The call object.

MutateRow(MutateRowRequest, CallOptions)

public virtual MutateRowResponse MutateRow(MutateRowRequest request, CallOptions options)

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutation.

Parameters
NameDescription
requestMutateRowRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
MutateRowResponse

The response received from the server.

MutateRow(MutateRowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual MutateRowResponse MutateRow(MutateRowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutation.

Parameters
NameDescription
requestMutateRowRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
MutateRowResponse

The response received from the server.

MutateRowAsync(MutateRowRequest, CallOptions)

public virtual AsyncUnaryCall<MutateRowResponse> MutateRowAsync(MutateRowRequest request, CallOptions options)

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutation.

Parameters
NameDescription
requestMutateRowRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<MutateRowResponse>

The call object.

MutateRowAsync(MutateRowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<MutateRowResponse> MutateRowAsync(MutateRowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Mutates a row atomically. Cells already present in the row are left unchanged unless explicitly changed by mutation.

Parameters
NameDescription
requestMutateRowRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<MutateRowResponse>

The call object.

MutateRows(MutateRowsRequest, CallOptions)

public virtual AsyncServerStreamingCall<MutateRowsResponse> MutateRows(MutateRowsRequest request, CallOptions options)

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Parameters
NameDescription
requestMutateRowsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncServerStreamingCall<MutateRowsResponse>

The call object.

MutateRows(MutateRowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncServerStreamingCall<MutateRowsResponse> MutateRows(MutateRowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.

Parameters
NameDescription
requestMutateRowsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncServerStreamingCall<MutateRowsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Bigtable.BigtableClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
Bigtable.BigtableClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Bigtable.V2.Bigtable.BigtableClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PingAndWarm(PingAndWarmRequest, CallOptions)

public virtual PingAndWarmResponse PingAndWarm(PingAndWarmRequest request, CallOptions options)

Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.

Parameters
NameDescription
requestPingAndWarmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
PingAndWarmResponse

The response received from the server.

PingAndWarm(PingAndWarmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual PingAndWarmResponse PingAndWarm(PingAndWarmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.

Parameters
NameDescription
requestPingAndWarmRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
PingAndWarmResponse

The response received from the server.

PingAndWarmAsync(PingAndWarmRequest, CallOptions)

public virtual AsyncUnaryCall<PingAndWarmResponse> PingAndWarmAsync(PingAndWarmRequest request, CallOptions options)

Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.

Parameters
NameDescription
requestPingAndWarmRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<PingAndWarmResponse>

The call object.

PingAndWarmAsync(PingAndWarmRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<PingAndWarmResponse> PingAndWarmAsync(PingAndWarmRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Warm up associated instance metadata for this connection. This call is not required but may be useful for connection keep-alive.

Parameters
NameDescription
requestPingAndWarmRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<PingAndWarmResponse>

The call object.

ReadModifyWriteRow(ReadModifyWriteRowRequest, CallOptions)

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(ReadModifyWriteRowRequest request, CallOptions options)

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Parameters
NameDescription
requestReadModifyWriteRowRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ReadModifyWriteRowResponse

The response received from the server.

ReadModifyWriteRow(ReadModifyWriteRowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(ReadModifyWriteRowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Parameters
NameDescription
requestReadModifyWriteRowRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ReadModifyWriteRowResponse

The response received from the server.

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CallOptions)

public virtual AsyncUnaryCall<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(ReadModifyWriteRowRequest request, CallOptions options)

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Parameters
NameDescription
requestReadModifyWriteRowRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ReadModifyWriteRowResponse>

The call object.

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(ReadModifyWriteRowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.

Parameters
NameDescription
requestReadModifyWriteRowRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ReadModifyWriteRowResponse>

The call object.

ReadRows(ReadRowsRequest, CallOptions)

public virtual AsyncServerStreamingCall<ReadRowsResponse> ReadRows(ReadRowsRequest request, CallOptions options)

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.

Parameters
NameDescription
requestReadRowsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncServerStreamingCall<ReadRowsResponse>

The call object.

ReadRows(ReadRowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncServerStreamingCall<ReadRowsResponse> ReadRows(ReadRowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.

Parameters
NameDescription
requestReadRowsRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncServerStreamingCall<ReadRowsResponse>

The call object.

SampleRowKeys(SampleRowKeysRequest, CallOptions)

public virtual AsyncServerStreamingCall<SampleRowKeysResponse> SampleRowKeys(SampleRowKeysRequest request, CallOptions options)

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

Parameters
NameDescription
requestSampleRowKeysRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncServerStreamingCall<SampleRowKeysResponse>

The call object.

SampleRowKeys(SampleRowKeysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncServerStreamingCall<SampleRowKeysResponse> SampleRowKeys(SampleRowKeysRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.

Parameters
NameDescription
requestSampleRowKeysRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncServerStreamingCall<SampleRowKeysResponse>

The call object.