Google Bigtable v2 API - Class BigtableClientImpl (3.15.0) 

public sealed class BigtableClientImpl : BigtableClient

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

BigtableServiceApi client wrapper, for convenient use.

Inheritance

object > BigtableClient > BigtableClientImpl

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Remarks

Service for reading from and writing to existing Bigtable tables.

Constructors

BigtableClientImpl(BigtableServiceApiClient)

public BigtableClientImpl(BigtableServiceApiClient serviceClient)

Constructs a client wrapper for the Bigtable service, with the specified BigtableServiceApiClient and settings.

Parameter
Name Description
serviceClient BigtableServiceApiClient

The underlying BigtableServiceApiClient which performs the requests to the service.

Properties

AppProfileId

public override string AppProfileId { get; }

Gets the value which specifies routing for replication. If null or empty, the "default" application profile will be used by the server.

Property Value
Type Description
string
Overrides

Methods

CheckAndMutateRow(CheckAndMutateRowRequest, CallSettings)

public override CheckAndMutateRowResponse CheckAndMutateRow(CheckAndMutateRowRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CheckAndMutateRowRequest

The request object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The RPC response.
Overrides

CheckAndMutateRowAsync(CheckAndMutateRowRequest, CallSettings)

public override Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(CheckAndMutateRowRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CheckAndMutateRowRequest

The request object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

A Task containing the RPC response.
Overrides

ExecuteQuery(ExecuteQueryRequest, CallSettings)

public override BigtableServiceApiClient.ExecuteQueryStream ExecuteQuery(ExecuteQueryRequest request, CallSettings callSettings = null)

Executes a BTQL query against a particular Cloud Bigtable instance.

Parameters
Name Description
request ExecuteQueryRequest

The request object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The server stream.
Overrides

GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, CallSettings)

public override BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The server stream.
Overrides

MutateRow(MutateRowRequest, CallSettings)

public override MutateRowResponse MutateRow(MutateRowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The RPC response.
Overrides

MutateRowAsync(MutateRowRequest, CallSettings)

public override Task<MutateRowResponse> MutateRowAsync(MutateRowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

A Task containing the RPC response.
Overrides

MutateRows(MutateRowsRequest, CallSettings)

public override MutateRowsResponse MutateRows(MutateRowsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The RPC response.
Overrides

MutateRowsAsync(MutateRowsRequest, CallSettings)

public override Task<MutateRowsResponse> MutateRowsAsync(MutateRowsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The RPC response.
Overrides

PingAndWarm(PingAndWarmRequest, CallSettings)

public override PingAndWarmResponse PingAndWarm(PingAndWarmRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The RPC response.
Overrides

PingAndWarmAsync(PingAndWarmRequest, CallSettings)

public override Task<PingAndWarmResponse> PingAndWarmAsync(PingAndWarmRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

A Task containing the RPC response.
Overrides

ReadChangeStream(ReadChangeStreamRequest, CallSettings)

public override BigtableServiceApiClient.ReadChangeStreamStream ReadChangeStream(ReadChangeStreamRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The server stream.
Overrides

ReadModifyWriteRow(ReadModifyWriteRowRequest, CallSettings)

public override ReadModifyWriteRowResponse ReadModifyWriteRow(ReadModifyWriteRowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The RPC response.
Overrides

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CallSettings)

public override Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(ReadModifyWriteRowRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

A Task containing the RPC response.
Overrides

ReadRows(ReadRowsRequest, CallSettings)

public override ReadRowsStream ReadRows(ReadRowsRequest request, CallSettings callSettings = null)

Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.

Parameters
Name Description
request ReadRowsRequest

The request object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The server stream.
Overrides

SampleRowKeys(SampleRowKeysRequest, CallSettings)

public override BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(SampleRowKeysRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call. If the AppProfileId has not been specified, it will be initialized from the value stored in the client.
callSettings CallSettings

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

The server stream.
Overrides