Google Bigtable v2 API - Class BigtableServiceApiClient (3.7.0)

Version 3.7.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 abstract class BigtableServiceApiClient

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

BigtableServiceApi client wrapper, for convenient use.

Inheritance

object > BigtableServiceApiClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

BigtableServiceApiClientImpl

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Remarks

Service for reading from and writing to existing Bigtable tables.

Properties

AppProfileId

public virtual 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

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the BigtableServiceApi service, which is a host of "bigtable.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default BigtableServiceApi scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default BigtableServiceApi scopes are:

• https://www.googleapis.com/auth/bigtable.data
• https://www.googleapis.com/auth/bigtable.data.readonly
• https://www.googleapis.com/auth/cloud-bigtable.data
• https://www.googleapis.com/auth/cloud-bigtable.data.readonly
• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

GrpcClient

public virtual Bigtable.BigtableClient GrpcClient { get; }

The underlying gRPC BigtableServiceApi client

Property Value
Type	Description
BigtableBigtableClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

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

public virtual CheckAndMutateRowResponse CheckAndMutateRow(TableName tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CheckAndMutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
// Make the request
CheckAndMutateRowResponse response = bigtableServiceApiClient.CheckAndMutateRow(tableName, rowKey, predicateFilter, trueMutations, falseMutations);

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

public virtual CheckAndMutateRowResponse CheckAndMutateRow(TableName tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CheckAndMutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
CheckAndMutateRowResponse response = bigtableServiceApiClient.CheckAndMutateRow(tableName, rowKey, predicateFilter, trueMutations, falseMutations, appProfileId);

CheckAndMutateRow(CheckAndMutateRowRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
CheckAndMutateRowRequest request = new CheckAndMutateRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    TrueMutations = { new Mutation(), },
    FalseMutations = { new Mutation(), },
    PredicateFilter = new RowFilter(),
    AppProfileId = "",
};
// Make the request
CheckAndMutateRowResponse response = bigtableServiceApiClient.CheckAndMutateRow(request);

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

public virtual CheckAndMutateRowResponse CheckAndMutateRow(string tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CheckAndMutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
// Make the request
CheckAndMutateRowResponse response = bigtableServiceApiClient.CheckAndMutateRow(tableName, rowKey, predicateFilter, trueMutations, falseMutations);

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

public virtual CheckAndMutateRowResponse CheckAndMutateRow(string tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CheckAndMutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
CheckAndMutateRowResponse response = bigtableServiceApiClient.CheckAndMutateRow(tableName, rowKey, predicateFilter, trueMutations, falseMutations, appProfileId);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(TableName tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(TableName tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations, appProfileId);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(TableName tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, string appProfileId, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations, appProfileId);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(TableName tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations);

CheckAndMutateRowAsync(CheckAndMutateRowRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
CheckAndMutateRowRequest request = new CheckAndMutateRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    TrueMutations = { new Mutation(), },
    FalseMutations = { new Mutation(), },
    PredicateFilter = new RowFilter(),
    AppProfileId = "",
};
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(request);

CheckAndMutateRowAsync(CheckAndMutateRowRequest, CancellationToken)

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(CheckAndMutateRowRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
CheckAndMutateRowRequest request = new CheckAndMutateRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    TrueMutations = { new Mutation(), },
    FalseMutations = { new Mutation(), },
    PredicateFilter = new RowFilter(),
    AppProfileId = "",
};
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(request);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(string tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(string tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations, appProfileId);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(string tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, string appProfileId, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations, appProfileId);

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

public virtual Task<CheckAndMutateRowResponse> CheckAndMutateRowAsync(string tableName, ByteString rowKey, RowFilter predicateFilter, IEnumerable<Mutation> trueMutations, IEnumerable<Mutation> falseMutations, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the conditional mutation should be applied.
predicateFilter	RowFilter The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
trueMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
falseMutations	IEnumerableMutation Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCheckAndMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
RowFilter predicateFilter = new RowFilter();
IEnumerable<Mutation> trueMutations = new Mutation[] { new Mutation(), };
IEnumerable<Mutation> falseMutations = new Mutation[] { new Mutation(), };
// Make the request
CheckAndMutateRowResponse response = await bigtableServiceApiClient.CheckAndMutateRowAsync(tableName, rowKey, predicateFilter, trueMutations, falseMutations);

Create()

public static BigtableServiceApiClient Create()

Synchronously creates a BigtableServiceApiClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableServiceApiClientBuilder .

Returns
Type	Description
BigtableServiceApiClient	The created BigtableServiceApiClient.

CreateAsync(CancellationToken)

public static Task<BigtableServiceApiClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a BigtableServiceApiClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableServiceApiClientBuilder .

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskBigtableServiceApiClient	The task representing the created BigtableServiceApiClient.

GenerateInitialChangeStreamPartitions(TableName, CallSettings)

public virtual BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream GenerateInitialChangeStreamPartitions(TableName tableName, 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
tableName	TableName Required. The unique name of the table from which to get change stream partitions. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientGenerateInitialChangeStreamPartitionsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request, returning a streaming response
using BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream response = bigtableServiceApiClient.GenerateInitialChangeStreamPartitions(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<GenerateInitialChangeStreamPartitionsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    GenerateInitialChangeStreamPartitionsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

GenerateInitialChangeStreamPartitions(TableName, string, CallSettings)

public virtual BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream GenerateInitialChangeStreamPartitions(TableName tableName, string appProfileId, 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
tableName	TableName Required. The unique name of the table from which to get change stream partitions. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientGenerateInitialChangeStreamPartitionsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream response = bigtableServiceApiClient.GenerateInitialChangeStreamPartitions(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<GenerateInitialChangeStreamPartitionsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    GenerateInitialChangeStreamPartitionsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

GenerateInitialChangeStreamPartitions(GenerateInitialChangeStreamPartitionsRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
GenerateInitialChangeStreamPartitionsRequest request = new GenerateInitialChangeStreamPartitionsRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    AppProfileId = "",
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream response = bigtableServiceApiClient.GenerateInitialChangeStreamPartitions(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<GenerateInitialChangeStreamPartitionsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    GenerateInitialChangeStreamPartitionsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

GenerateInitialChangeStreamPartitions(string, CallSettings)

public virtual BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream GenerateInitialChangeStreamPartitions(string tableName, 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
tableName	string Required. The unique name of the table from which to get change stream partitions. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientGenerateInitialChangeStreamPartitionsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request, returning a streaming response
using BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream response = bigtableServiceApiClient.GenerateInitialChangeStreamPartitions(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<GenerateInitialChangeStreamPartitionsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    GenerateInitialChangeStreamPartitionsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

GenerateInitialChangeStreamPartitions(string, string, CallSettings)

public virtual BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream GenerateInitialChangeStreamPartitions(string tableName, string appProfileId, 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
tableName	string Required. The unique name of the table from which to get change stream partitions. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientGenerateInitialChangeStreamPartitionsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.GenerateInitialChangeStreamPartitionsStream response = bigtableServiceApiClient.GenerateInitialChangeStreamPartitions(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<GenerateInitialChangeStreamPartitionsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    GenerateInitialChangeStreamPartitionsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

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

public virtual MutateRowResponse MutateRow(TableName tableName, ByteString rowKey, IEnumerable<Mutation> mutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
// Make the request
MutateRowResponse response = bigtableServiceApiClient.MutateRow(tableName, rowKey, mutations);

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

public virtual MutateRowResponse MutateRow(TableName tableName, ByteString rowKey, IEnumerable<Mutation> mutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
MutateRowResponse response = bigtableServiceApiClient.MutateRow(tableName, rowKey, mutations, appProfileId);

MutateRow(MutateRowRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
MutateRowRequest request = new MutateRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    Mutations = { new Mutation(), },
    AppProfileId = "",
};
// Make the request
MutateRowResponse response = bigtableServiceApiClient.MutateRow(request);

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

public virtual MutateRowResponse MutateRow(string tableName, ByteString rowKey, IEnumerable<Mutation> mutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
// Make the request
MutateRowResponse response = bigtableServiceApiClient.MutateRow(tableName, rowKey, mutations);

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

public virtual MutateRowResponse MutateRow(string tableName, ByteString rowKey, IEnumerable<Mutation> mutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
MutateRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
MutateRowResponse response = bigtableServiceApiClient.MutateRow(tableName, rowKey, mutations, appProfileId);

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

public virtual Task<MutateRowResponse> MutateRowAsync(TableName tableName, ByteString rowKey, IEnumerable<Mutation> mutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations);

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

public virtual Task<MutateRowResponse> MutateRowAsync(TableName tableName, ByteString rowKey, IEnumerable<Mutation> mutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations, appProfileId);

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

public virtual Task<MutateRowResponse> MutateRowAsync(TableName tableName, ByteString rowKey, IEnumerable<Mutation> mutations, string appProfileId, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations, appProfileId);

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

public virtual Task<MutateRowResponse> MutateRowAsync(TableName tableName, ByteString rowKey, IEnumerable<Mutation> mutations, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	TableName Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations);

MutateRowAsync(MutateRowRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
MutateRowRequest request = new MutateRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    Mutations = { new Mutation(), },
    AppProfileId = "",
};
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(request);

MutateRowAsync(MutateRowRequest, CancellationToken)

public virtual Task<MutateRowResponse> MutateRowAsync(MutateRowRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
MutateRowRequest request = new MutateRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    Mutations = { new Mutation(), },
    AppProfileId = "",
};
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(request);

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

public virtual Task<MutateRowResponse> MutateRowAsync(string tableName, ByteString rowKey, IEnumerable<Mutation> mutations, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations);

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

public virtual Task<MutateRowResponse> MutateRowAsync(string tableName, ByteString rowKey, IEnumerable<Mutation> mutations, string appProfileId, CallSettings callSettings = null)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations, appProfileId);

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

public virtual Task<MutateRowResponse> MutateRowAsync(string tableName, ByteString rowKey, IEnumerable<Mutation> mutations, string appProfileId, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
string appProfileId = "";
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations, appProfileId);

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

public virtual Task<MutateRowResponse> MutateRowAsync(string tableName, ByteString rowKey, IEnumerable<Mutation> mutations, CancellationToken cancellationToken)

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

Parameters
Name	Description
tableName	string Required. The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the mutation should be applied.
mutations	IEnumerableMutation Required. Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry and at most 100000.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskMutateRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<Mutation> mutations = new Mutation[] { new Mutation(), };
// Make the request
MutateRowResponse response = await bigtableServiceApiClient.MutateRowAsync(tableName, rowKey, mutations);

MutateRows(TableName, IEnumerable<Entry>, CallSettings)

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(TableName tableName, IEnumerable<MutateRowsRequest.Types.Entry> entries, 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
tableName	TableName Required. The unique name of the table to which the mutations should be applied.
entries	IEnumerableMutateRowsRequestTypesEntry Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientMutateRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
IEnumerable<MutateRowsRequest.Types.Entry> entries = new MutateRowsRequest.Types.Entry[]
{
    new MutateRowsRequest.Types.Entry(),
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.MutateRowsStream response = bigtableServiceApiClient.MutateRows(tableName, entries);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<MutateRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    MutateRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

MutateRows(TableName, IEnumerable<Entry>, string, CallSettings)

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(TableName tableName, IEnumerable<MutateRowsRequest.Types.Entry> entries, string appProfileId, 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
tableName	TableName Required. The unique name of the table to which the mutations should be applied.
entries	IEnumerableMutateRowsRequestTypesEntry Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientMutateRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
IEnumerable<MutateRowsRequest.Types.Entry> entries = new MutateRowsRequest.Types.Entry[]
{
    new MutateRowsRequest.Types.Entry(),
};
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.MutateRowsStream response = bigtableServiceApiClient.MutateRows(tableName, entries, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<MutateRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    MutateRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

MutateRows(MutateRowsRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
MutateRowsRequest request = new MutateRowsRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    Entries =
    {
        new MutateRowsRequest.Types.Entry(),
    },
    AppProfileId = "",
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.MutateRowsStream response = bigtableServiceApiClient.MutateRows(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<MutateRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    MutateRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

MutateRows(string, IEnumerable<Entry>, CallSettings)

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(string tableName, IEnumerable<MutateRowsRequest.Types.Entry> entries, 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
tableName	string Required. The unique name of the table to which the mutations should be applied.
entries	IEnumerableMutateRowsRequestTypesEntry Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientMutateRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
IEnumerable<MutateRowsRequest.Types.Entry> entries = new MutateRowsRequest.Types.Entry[]
{
    new MutateRowsRequest.Types.Entry(),
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.MutateRowsStream response = bigtableServiceApiClient.MutateRows(tableName, entries);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<MutateRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    MutateRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

MutateRows(string, IEnumerable<Entry>, string, CallSettings)

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(string tableName, IEnumerable<MutateRowsRequest.Types.Entry> entries, string appProfileId, 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
tableName	string Required. The unique name of the table to which the mutations should be applied.
entries	IEnumerableMutateRowsRequestTypesEntry Required. The row keys and corresponding mutations to be applied in bulk. Each entry is applied as an atomic mutation, but the entries may be applied in arbitrary order (even between entries for the same row). At least one entry must be specified, and in total the entries can contain at most 100000 mutations.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientMutateRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
IEnumerable<MutateRowsRequest.Types.Entry> entries = new MutateRowsRequest.Types.Entry[]
{
    new MutateRowsRequest.Types.Entry(),
};
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.MutateRowsStream response = bigtableServiceApiClient.MutateRows(tableName, entries, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<MutateRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    MutateRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

PingAndWarm(InstanceName, CallSettings)

public virtual PingAndWarmResponse PingAndWarm(InstanceName name, 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
name	InstanceName Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PingAndWarmResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PingAndWarmResponse response = bigtableServiceApiClient.PingAndWarm(name);

PingAndWarm(InstanceName, string, CallSettings)

public virtual PingAndWarmResponse PingAndWarm(InstanceName name, string appProfileId, 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
name	InstanceName Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PingAndWarmResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string appProfileId = "";
// Make the request
PingAndWarmResponse response = bigtableServiceApiClient.PingAndWarm(name, appProfileId);

PingAndWarm(PingAndWarmRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
PingAndWarmRequest request = new PingAndWarmRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    AppProfileId = "",
};
// Make the request
PingAndWarmResponse response = bigtableServiceApiClient.PingAndWarm(request);

PingAndWarm(string, CallSettings)

public virtual PingAndWarmResponse PingAndWarm(string name, 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
name	string Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PingAndWarmResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PingAndWarmResponse response = bigtableServiceApiClient.PingAndWarm(name);

PingAndWarm(string, string, CallSettings)

public virtual PingAndWarmResponse PingAndWarm(string name, string appProfileId, 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
name	string Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PingAndWarmResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
string appProfileId = "";
// Make the request
PingAndWarmResponse response = bigtableServiceApiClient.PingAndWarm(name, appProfileId);

PingAndWarmAsync(InstanceName, CallSettings)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(InstanceName name, 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
name	InstanceName Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name);

PingAndWarmAsync(InstanceName, string, CallSettings)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(InstanceName name, string appProfileId, 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
name	InstanceName Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string appProfileId = "";
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name, appProfileId);

PingAndWarmAsync(InstanceName, string, CancellationToken)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(InstanceName name, string appProfileId, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	InstanceName Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
string appProfileId = "";
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name, appProfileId);

PingAndWarmAsync(InstanceName, CancellationToken)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(InstanceName name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	InstanceName Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
InstanceName name = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]");
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name);

PingAndWarmAsync(PingAndWarmRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
PingAndWarmRequest request = new PingAndWarmRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    AppProfileId = "",
};
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(request);

PingAndWarmAsync(PingAndWarmRequest, CancellationToken)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(PingAndWarmRequest request, CancellationToken cancellationToken)

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
PingAndWarmRequest request = new PingAndWarmRequest
{
    InstanceName = InstanceName.FromProjectInstance("[PROJECT]", "[INSTANCE]"),
    AppProfileId = "",
};
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(request);

PingAndWarmAsync(string, CallSettings)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(string name, 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
name	string Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name);

PingAndWarmAsync(string, string, CallSettings)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(string name, string appProfileId, 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
name	string Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
string appProfileId = "";
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name, appProfileId);

PingAndWarmAsync(string, string, CancellationToken)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(string name, string appProfileId, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
string appProfileId = "";
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name, appProfileId);

PingAndWarmAsync(string, CancellationToken)

public virtual Task<PingAndWarmResponse> PingAndWarmAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name	Description
name	string Required. The unique name of the instance to check permissions for as well as respond. Values are of the form projects/<project>/instances/<instance>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskPingAndWarmResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/instances/[INSTANCE]";
// Make the request
PingAndWarmResponse response = await bigtableServiceApiClient.PingAndWarmAsync(name);

ReadChangeStream(TableName, CallSettings)

public virtual BigtableServiceApiClient.ReadChangeStreamStream ReadChangeStream(TableName tableName, 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
tableName	TableName Required. The unique name of the table from which to read a change stream. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadChangeStreamStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadChangeStreamStream response = bigtableServiceApiClient.ReadChangeStream(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadChangeStreamResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadChangeStreamResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadChangeStream(TableName, string, CallSettings)

public virtual BigtableServiceApiClient.ReadChangeStreamStream ReadChangeStream(TableName tableName, string appProfileId, 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
tableName	TableName Required. The unique name of the table from which to read a change stream. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadChangeStreamStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadChangeStreamStream response = bigtableServiceApiClient.ReadChangeStream(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadChangeStreamResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadChangeStreamResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadChangeStream(ReadChangeStreamRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
ReadChangeStreamRequest request = new ReadChangeStreamRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    AppProfileId = "",
    Partition = new StreamPartition(),
    StartTime = new Timestamp(),
    EndTime = new Timestamp(),
    HeartbeatDuration = new Duration(),
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadChangeStreamStream response = bigtableServiceApiClient.ReadChangeStream(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadChangeStreamResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadChangeStreamResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadChangeStream(string, CallSettings)

public virtual BigtableServiceApiClient.ReadChangeStreamStream ReadChangeStream(string tableName, 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
tableName	string Required. The unique name of the table from which to read a change stream. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadChangeStreamStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadChangeStreamStream response = bigtableServiceApiClient.ReadChangeStream(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadChangeStreamResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadChangeStreamResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadChangeStream(string, string, CallSettings)

public virtual BigtableServiceApiClient.ReadChangeStreamStream ReadChangeStream(string tableName, string appProfileId, 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
tableName	string Required. The unique name of the table from which to read a change stream. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Change streaming must be enabled on the table.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used. Single cluster routing must be configured on the profile.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadChangeStreamStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadChangeStreamStream response = bigtableServiceApiClient.ReadChangeStream(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadChangeStreamResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadChangeStreamResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

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

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, 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
tableName	TableName Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReadModifyWriteRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
// Make the request
ReadModifyWriteRowResponse response = bigtableServiceApiClient.ReadModifyWriteRow(tableName, rowKey, rules);

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

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, string appProfileId, 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
tableName	TableName Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReadModifyWriteRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
string appProfileId = "";
// Make the request
ReadModifyWriteRowResponse response = bigtableServiceApiClient.ReadModifyWriteRow(tableName, rowKey, rules, appProfileId);

ReadModifyWriteRow(ReadModifyWriteRowRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
ReadModifyWriteRowRequest request = new ReadModifyWriteRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    Rules =
    {
        new ReadModifyWriteRule(),
    },
    AppProfileId = "",
};
// Make the request
ReadModifyWriteRowResponse response = bigtableServiceApiClient.ReadModifyWriteRow(request);

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

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, 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
tableName	string Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReadModifyWriteRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
// Make the request
ReadModifyWriteRowResponse response = bigtableServiceApiClient.ReadModifyWriteRow(tableName, rowKey, rules);

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

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, string appProfileId, 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
tableName	string Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReadModifyWriteRowResponse	The RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
string appProfileId = "";
// Make the request
ReadModifyWriteRowResponse response = bigtableServiceApiClient.ReadModifyWriteRow(tableName, rowKey, rules, appProfileId);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, 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
tableName	TableName Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, string appProfileId, 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
tableName	TableName Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
string appProfileId = "";
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules, appProfileId);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, string appProfileId, CancellationToken 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
Name	Description
tableName	TableName Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
string appProfileId = "";
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules, appProfileId);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CancellationToken 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
Name	Description
tableName	TableName Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules);

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
ReadModifyWriteRowRequest request = new ReadModifyWriteRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    Rules =
    {
        new ReadModifyWriteRule(),
    },
    AppProfileId = "",
};
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(request);

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CancellationToken)

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(ReadModifyWriteRowRequest request, CancellationToken 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
Name	Description
request	ReadModifyWriteRowRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
ReadModifyWriteRowRequest request = new ReadModifyWriteRowRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    RowKey = ByteString.Empty,
    Rules =
    {
        new ReadModifyWriteRule(),
    },
    AppProfileId = "",
};
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(request);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, 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
tableName	string Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, string appProfileId, 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
tableName	string Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
string appProfileId = "";
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules, appProfileId);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, string appProfileId, CancellationToken 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
Name	Description
tableName	string Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
string appProfileId = "";
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules, appProfileId);

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

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CancellationToken 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
Name	Description
tableName	string Required. The unique name of the table to which the read/modify/write rules should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
rowKey	ByteString Required. The key of the row to which the read/modify/write rules should be applied.
rules	IEnumerableReadModifyWriteRule Required. Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReadModifyWriteRowResponse	A Task containing the RPC response.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = await BigtableServiceApiClient.CreateAsync();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
ByteString rowKey = ByteString.Empty;
IEnumerable<ReadModifyWriteRule> rules = new ReadModifyWriteRule[]
{
    new ReadModifyWriteRule(),
};
// Make the request
ReadModifyWriteRowResponse response = await bigtableServiceApiClient.ReadModifyWriteRowAsync(tableName, rowKey, rules);

ReadRows(TableName, CallSettings)

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(TableName tableName, 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
tableName	TableName Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadRowsStream response = bigtableServiceApiClient.ReadRows(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadRows(TableName, string, CallSettings)

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(TableName tableName, string appProfileId, 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
tableName	TableName Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadRowsStream response = bigtableServiceApiClient.ReadRows(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadRows(ReadRowsRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
ReadRowsRequest request = new ReadRowsRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    Rows = new RowSet(),
    Filter = new RowFilter(),
    RowsLimit = 0L,
    AppProfileId = "",
    RequestStatsView = ReadRowsRequest.Types.RequestStatsView.Unspecified,
    Reversed = false,
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadRowsStream response = bigtableServiceApiClient.ReadRows(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadRows(string, CallSettings)

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(string tableName, 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
tableName	string Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadRowsStream response = bigtableServiceApiClient.ReadRows(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadRows(string, string, CallSettings)

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(string tableName, string appProfileId, 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
tableName	string Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientReadRowsStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.ReadRowsStream response = bigtableServiceApiClient.ReadRows(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<ReadRowsResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    ReadRowsResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

SampleRowKeys(TableName, CallSettings)

public virtual BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(TableName tableName, 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
tableName	TableName Required. The unique name of the table from which to sample row keys. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientSampleRowKeysStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request, returning a streaming response
using BigtableServiceApiClient.SampleRowKeysStream response = bigtableServiceApiClient.SampleRowKeys(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<SampleRowKeysResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    SampleRowKeysResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

SampleRowKeys(TableName, string, CallSettings)

public virtual BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(TableName tableName, string appProfileId, 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
tableName	TableName Required. The unique name of the table from which to sample row keys. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientSampleRowKeysStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.SampleRowKeysStream response = bigtableServiceApiClient.SampleRowKeys(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<SampleRowKeysResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    SampleRowKeysResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

SampleRowKeys(SampleRowKeysRequest, CallSettings)

public virtual 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.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
SampleRowKeysRequest request = new SampleRowKeysRequest
{
    TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
    AppProfileId = "",
};
// Make the request, returning a streaming response
using BigtableServiceApiClient.SampleRowKeysStream response = bigtableServiceApiClient.SampleRowKeys(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<SampleRowKeysResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    SampleRowKeysResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

SampleRowKeys(string, CallSettings)

public virtual BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(string tableName, 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
tableName	string Required. The unique name of the table from which to sample row keys. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientSampleRowKeysStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request, returning a streaming response
using BigtableServiceApiClient.SampleRowKeysStream response = bigtableServiceApiClient.SampleRowKeys(tableName);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<SampleRowKeysResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    SampleRowKeysResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

SampleRowKeys(string, string, CallSettings)

public virtual BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(string tableName, string appProfileId, 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
tableName	string Required. The unique name of the table from which to sample row keys. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
appProfileId	string This value specifies routing for replication. If not specified, the "default" application profile will be used.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BigtableServiceApiClientSampleRowKeysStream	The server stream.

Example

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
string appProfileId = "";
// Make the request, returning a streaming response
using BigtableServiceApiClient.SampleRowKeysStream response = bigtableServiceApiClient.SampleRowKeys(tableName, appProfileId);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<SampleRowKeysResponse> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    SampleRowKeysResponse responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.