Class BigtableClientImpl (3.1.0)

public sealed class BigtableClientImpl : BigtableClient

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
NameDescription
serviceClientBigtableServiceApiClient

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
TypeDescription
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
NameDescription
requestCheckAndMutateRowRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestCheckAndMutateRowRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<CheckAndMutateRowResponse>

A Task containing the RPC response.

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
NameDescription
requestMutateRowRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestMutateRowRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<MutateRowResponse>

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
NameDescription
requestMutateRowsRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestMutateRowsRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<MutateRowsResponse>

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
NameDescription
requestPingAndWarmRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestPingAndWarmRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<PingAndWarmResponse>

A Task containing the RPC response.

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
NameDescription
requestReadModifyWriteRowRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestReadModifyWriteRowRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ReadModifyWriteRowResponse>

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
NameDescription
requestReadRowsRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
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
NameDescription
requestSampleRowKeysRequest

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BigtableServiceApiClient.SampleRowKeysStream

The server stream.

Overrides