Google Bigtable v2 API - Class Bigtable.BigtableClient (3.4.0)

Version 3.4.0

• 3.15.0 (latest)
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0

public class Bigtable.BigtableClient : ClientBase<Bigtable.BigtableClient>

Reference documentation and code samples for the Google Bigtable v2 API class Bigtable.BigtableClient.

Client for Bigtable

Inheritance

object > ClientBase > ClientBaseBigtableBigtableClient > Bigtable.BigtableClient

Inherited Members

ClientBase<Bigtable.BigtableClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.BigtableV2

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

BigtableClient(ChannelBase)

public BigtableClient(ChannelBase channel)

Creates a new client for Bigtable

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

BigtableClient(ClientBaseConfiguration)

protected BigtableClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration 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
Name	Description
request	CheckAndMutateRowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CheckAndMutateRowResponse	The response received from the server.

CheckAndMutateRow(CheckAndMutateRowRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	CheckAndMutateRowRequest 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
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
Name	Description
request	CheckAndMutateRowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCheckAndMutateRowResponse	The call object.

CheckAndMutateRowAsync(CheckAndMutateRowRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	CheckAndMutateRowRequest 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
AsyncUnaryCallCheckAndMutateRowResponse	The call object.

GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, CallOptions)

public virtual AsyncServerStreamingCall<GenerateInitialChangeStreamPartitionsResponse> GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request, CallOptions options)

NOTE: This API is intended to be used by Apache Beam BigtableIO. Returns the current list of partitions that make up the table's change stream. The union of partitions will cover the entire keyspace. Partitions can be read with ReadChangeStream.

Parameters
Name	Description
request	GenerateInitialChangeStreamPartitionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncServerStreamingCallGenerateInitialChangeStreamPartitionsResponse	The call object.

GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<GenerateInitialChangeStreamPartitionsResponse> GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

NOTE: This API is intended to be used by Apache Beam BigtableIO. Returns the current list of partitions that make up the table's change stream. The union of partitions will cover the entire keyspace. Partitions can be read with ReadChangeStream.

Parameters
Name	Description
request	GenerateInitialChangeStreamPartitionsRequest 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
AsyncServerStreamingCallGenerateInitialChangeStreamPartitionsResponse	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
Name	Description
request	MutateRowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
MutateRowResponse	The response received from the server.

MutateRow(MutateRowRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	MutateRowRequest 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
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
Name	Description
request	MutateRowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallMutateRowResponse	The call object.

MutateRowAsync(MutateRowRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	MutateRowRequest 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
AsyncUnaryCallMutateRowResponse	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
Name	Description
request	MutateRowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncServerStreamingCallMutateRowsResponse	The call object.

MutateRows(MutateRowsRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	MutateRowsRequest 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
AsyncServerStreamingCallMutateRowsResponse	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
BigtableBigtableClient

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
Name	Description
request	PingAndWarmRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
PingAndWarmResponse	The response received from the server.

PingAndWarm(PingAndWarmRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	PingAndWarmRequest 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
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
Name	Description
request	PingAndWarmRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPingAndWarmResponse	The call object.

PingAndWarmAsync(PingAndWarmRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	PingAndWarmRequest 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
AsyncUnaryCallPingAndWarmResponse	The call object.

ReadChangeStream(ReadChangeStreamRequest, CallOptions)

public virtual AsyncServerStreamingCall<ReadChangeStreamResponse> ReadChangeStream(ReadChangeStreamRequest request, CallOptions options)

NOTE: This API is intended to be used by Apache Beam BigtableIO. Reads changes from a table's change stream. Changes will reflect both user-initiated mutations and mutations that are caused by garbage collection.

Parameters
Name	Description
request	ReadChangeStreamRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncServerStreamingCallReadChangeStreamResponse	The call object.

ReadChangeStream(ReadChangeStreamRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncServerStreamingCall<ReadChangeStreamResponse> ReadChangeStream(ReadChangeStreamRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

NOTE: This API is intended to be used by Apache Beam BigtableIO. Reads changes from a table's change stream. Changes will reflect both user-initiated mutations and mutations that are caused by garbage collection.

Parameters
Name	Description
request	ReadChangeStreamRequest 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
AsyncServerStreamingCallReadChangeStreamResponse	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
Name	Description
request	ReadModifyWriteRowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ReadModifyWriteRowResponse	The response received from the server.

ReadModifyWriteRow(ReadModifyWriteRowRequest, Metadata, DateTime?, CancellationToken)

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

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
Name	Description
request	ReadModifyWriteRowRequest 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
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
Name	Description
request	ReadModifyWriteRowRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallReadModifyWriteRowResponse	The call object.

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, Metadata, DateTime?, CancellationToken)

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

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
Name	Description
request	ReadModifyWriteRowRequest 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
AsyncUnaryCallReadModifyWriteRowResponse	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
Name	Description
request	ReadRowsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncServerStreamingCallReadRowsResponse	The call object.

ReadRows(ReadRowsRequest, Metadata, DateTime?, CancellationToken)

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

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
Name	Description
request	ReadRowsRequest 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
AsyncServerStreamingCallReadRowsResponse	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
Name	Description
request	SampleRowKeysRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncServerStreamingCallSampleRowKeysResponse	The call object.

SampleRowKeys(SampleRowKeysRequest, Metadata, DateTime?, CancellationToken)

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

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
Name	Description
request	SampleRowKeysRequest 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
AsyncServerStreamingCallSampleRowKeysResponse	The call object.