Google Bigtable v2 API - Class BigtableServiceApiClientImpl (3.9.0)

Version 3.9.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 sealed class BigtableServiceApiClientImpl : BigtableServiceApiClient

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

BigtableServiceApi client wrapper implementation, for convenient use.

Inheritance

object > BigtableServiceApiClient > BigtableServiceApiClientImpl

Inherited Members

BigtableServiceApiClient.DefaultEndpoint

BigtableServiceApiClient.DefaultScopes

BigtableServiceApiClient.ServiceMetadata

BigtableServiceApiClient.CreateAsync(CancellationToken)

BigtableServiceApiClient.Create()

BigtableServiceApiClient.ShutdownDefaultChannelsAsync()

BigtableServiceApiClient.ReadRows(string, CallSettings)

BigtableServiceApiClient.ReadRows(TableName, CallSettings)

BigtableServiceApiClient.ReadRows(string, string, CallSettings)

BigtableServiceApiClient.ReadRows(TableName, string, CallSettings)

BigtableServiceApiClient.SampleRowKeys(string, CallSettings)

BigtableServiceApiClient.SampleRowKeys(TableName, CallSettings)

BigtableServiceApiClient.SampleRowKeys(string, string, CallSettings)

BigtableServiceApiClient.SampleRowKeys(TableName, string, CallSettings)

BigtableServiceApiClient.MutateRowAsync(MutateRowRequest, CancellationToken)

BigtableServiceApiClient.MutateRow(string, ByteString, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.MutateRowAsync(string, ByteString, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.MutateRowAsync(string, ByteString, IEnumerable<Mutation>, CancellationToken)

BigtableServiceApiClient.MutateRow(TableName, ByteString, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.MutateRowAsync(TableName, ByteString, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.MutateRowAsync(TableName, ByteString, IEnumerable<Mutation>, CancellationToken)

BigtableServiceApiClient.MutateRow(string, ByteString, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.MutateRowAsync(string, ByteString, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.MutateRowAsync(string, ByteString, IEnumerable<Mutation>, string, CancellationToken)

BigtableServiceApiClient.MutateRow(TableName, ByteString, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.MutateRowAsync(TableName, ByteString, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.MutateRowAsync(TableName, ByteString, IEnumerable<Mutation>, string, CancellationToken)

BigtableServiceApiClient.MutateRows(string, IEnumerable<MutateRowsRequest.Types.Entry>, CallSettings)

BigtableServiceApiClient.MutateRows(TableName, IEnumerable<MutateRowsRequest.Types.Entry>, CallSettings)

BigtableServiceApiClient.MutateRows(string, IEnumerable<MutateRowsRequest.Types.Entry>, string, CallSettings)

BigtableServiceApiClient.MutateRows(TableName, IEnumerable<MutateRowsRequest.Types.Entry>, string, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(CheckAndMutateRowRequest, CancellationToken)

BigtableServiceApiClient.CheckAndMutateRow(string, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(string, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(string, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, CancellationToken)

BigtableServiceApiClient.CheckAndMutateRow(TableName, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(TableName, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(TableName, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, CancellationToken)

BigtableServiceApiClient.CheckAndMutateRow(string, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(string, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(string, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, string, CancellationToken)

BigtableServiceApiClient.CheckAndMutateRow(TableName, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(TableName, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, string, CallSettings)

BigtableServiceApiClient.CheckAndMutateRowAsync(TableName, ByteString, RowFilter, IEnumerable<Mutation>, IEnumerable<Mutation>, string, CancellationToken)

BigtableServiceApiClient.PingAndWarmAsync(PingAndWarmRequest, CancellationToken)

BigtableServiceApiClient.PingAndWarm(string, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(string, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(string, CancellationToken)

BigtableServiceApiClient.PingAndWarm(InstanceName, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(InstanceName, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(InstanceName, CancellationToken)

BigtableServiceApiClient.PingAndWarm(string, string, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(string, string, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(string, string, CancellationToken)

BigtableServiceApiClient.PingAndWarm(InstanceName, string, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(InstanceName, string, CallSettings)

BigtableServiceApiClient.PingAndWarmAsync(InstanceName, string, CancellationToken)

BigtableServiceApiClient.ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CancellationToken)

BigtableServiceApiClient.ReadModifyWriteRow(string, ByteString, IEnumerable<ReadModifyWriteRule>, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(string, ByteString, IEnumerable<ReadModifyWriteRule>, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(string, ByteString, IEnumerable<ReadModifyWriteRule>, CancellationToken)

BigtableServiceApiClient.ReadModifyWriteRow(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, CancellationToken)

BigtableServiceApiClient.ReadModifyWriteRow(string, ByteString, IEnumerable<ReadModifyWriteRule>, string, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(string, ByteString, IEnumerable<ReadModifyWriteRule>, string, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(string, ByteString, IEnumerable<ReadModifyWriteRule>, string, CancellationToken)

BigtableServiceApiClient.ReadModifyWriteRow(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, string, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, string, CallSettings)

BigtableServiceApiClient.ReadModifyWriteRowAsync(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, string, CancellationToken)

BigtableServiceApiClient.GenerateInitialChangeStreamPartitions(string, CallSettings)

BigtableServiceApiClient.GenerateInitialChangeStreamPartitions(TableName, CallSettings)

BigtableServiceApiClient.GenerateInitialChangeStreamPartitions(string, string, CallSettings)

BigtableServiceApiClient.GenerateInitialChangeStreamPartitions(TableName, string, CallSettings)

BigtableServiceApiClient.ReadChangeStream(string, CallSettings)

BigtableServiceApiClient.ReadChangeStream(TableName, CallSettings)

BigtableServiceApiClient.ReadChangeStream(string, string, CallSettings)

BigtableServiceApiClient.ReadChangeStream(TableName, string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Remarks

Service for reading from and writing to existing Bigtable tables.

Constructors

BigtableServiceApiClientImpl(BigtableClient, BigtableServiceApiSettings, ILogger)

public BigtableServiceApiClientImpl(Bigtable.BigtableClient grpcClient, BigtableServiceApiSettings settings, ILogger logger)

Constructs a client wrapper for the BigtableServiceApi service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	BigtableBigtableClient The underlying gRPC client.
settings	BigtableServiceApiSettings The base BigtableServiceApiSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

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

BigtableServiceApiClient.AppProfileId

GrpcClient

public override Bigtable.BigtableClient GrpcClient { get; }

The underlying gRPC BigtableServiceApi client

Property Value
Type	Description
BigtableBigtableClient

Overrides

BigtableServiceApiClient.GrpcClient

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CheckAndMutateRowResponse	The RPC response.

Overrides

BigtableServiceApiClient.CheckAndMutateRow(CheckAndMutateRowRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Overrides

BigtableServiceApiClient.CheckAndMutateRowAsync(CheckAndMutateRowRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientGenerateInitialChangeStreamPartitionsStream	The server stream.

Overrides

BigtableServiceApiClient.GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MutateRowResponse	The RPC response.

Overrides

BigtableServiceApiClient.MutateRow(MutateRowRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Overrides

BigtableServiceApiClient.MutateRowAsync(MutateRowRequest, CallSettings)

MutateRows(MutateRowsRequest, CallSettings)

public override BigtableServiceApiClient.MutateRowsStream 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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientMutateRowsStream	The server stream.

Overrides

BigtableServiceApiClient.MutateRows(MutateRowsRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PingAndWarmResponse	The RPC response.

Overrides

BigtableServiceApiClient.PingAndWarm(PingAndWarmRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Overrides

BigtableServiceApiClient.PingAndWarmAsync(PingAndWarmRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadChangeStreamStream	The server stream.

Overrides

BigtableServiceApiClient.ReadChangeStream(ReadChangeStreamRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReadModifyWriteRowResponse	The RPC response.

Overrides

BigtableServiceApiClient.ReadModifyWriteRow(ReadModifyWriteRowRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Overrides

BigtableServiceApiClient.ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CallSettings)

ReadRows(ReadRowsRequest, CallSettings)

public override BigtableServiceApiClient.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. 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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadRowsStream	The server stream.

Overrides

BigtableServiceApiClient.ReadRows(ReadRowsRequest, CallSettings)

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientSampleRowKeysStream	The server stream.

Overrides

BigtableServiceApiClient.SampleRowKeys(SampleRowKeysRequest, CallSettings)