Class BigtableServiceApiClient

Bigtable client wrapper, for convenient use.

Inheritance

System.Object

BigtableServiceApiClient

BigtableServiceApiClientImpl

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.Bigtable.V2

Assembly: Google.Cloud.Bigtable.V2.dll

Syntax

public abstract class BigtableServiceApiClient

Properties

AppProfileId

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

Declaration

public virtual string AppProfileId { get; }

Property Value

Type	Description
System.String

DefaultEndpoint

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

Declaration

public static ServiceEndpoint DefaultEndpoint { get; }

Property Value

Type	Description
ServiceEndpoint

DefaultScopes

The default Bigtable scopes.

Declaration

public static IReadOnlyList<string> DefaultScopes { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<System.String>

Remarks

The default Bigtable 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

The underlying gRPC Bigtable client.

Declaration

public virtual Bigtable.BigtableClient GrpcClient { get; }

Property Value

Type	Description
Bigtable.BigtableClient

Methods

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

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

Declaration

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

Parameters

Type	Name	Description
TableName	tableName	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>.
ByteString	rowKey	The key of the row to which the conditional mutation should be applied.
RowFilter	predicateFilter	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.
System.Collections.Generic.IEnumerable<Mutation>	trueMutations	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.
System.Collections.Generic.IEnumerable<Mutation>	falseMutations	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.

Sample code

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

CheckAndMutateRow(CheckAndMutateRowRequest, CallSettings)

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

Declaration

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

Parameters

Type	Name	Description
CheckAndMutateRowRequest	request	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.

Sample code

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

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	tableName	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>.
ByteString	rowKey	The key of the row to which the conditional mutation should be applied.
RowFilter	predicateFilter	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.
System.Collections.Generic.IEnumerable<Mutation>	trueMutations	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.
System.Collections.Generic.IEnumerable<Mutation>	falseMutations	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.

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

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

Declaration

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

Parameters

Type	Name	Description
TableName	tableName	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>.
ByteString	rowKey	The key of the row to which the conditional mutation should be applied.
RowFilter	predicateFilter	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.
System.Collections.Generic.IEnumerable<Mutation>	trueMutations	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.
System.Collections.Generic.IEnumerable<Mutation>	falseMutations	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
System.Threading.Tasks.Task<CheckAndMutateRowResponse>	A Task containing the RPC response.

Sample code

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

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

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

Declaration

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

Parameters

Type	Name	Description
TableName	tableName	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>.
ByteString	rowKey	The key of the row to which the conditional mutation should be applied.
RowFilter	predicateFilter	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.
System.Collections.Generic.IEnumerable<Mutation>	trueMutations	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.
System.Collections.Generic.IEnumerable<Mutation>	falseMutations	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.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<CheckAndMutateRowResponse>	A Task containing the RPC response.

Sample code

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

CheckAndMutateRowAsync(CheckAndMutateRowRequest, CallSettings)

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

Declaration

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

Parameters

Type	Name	Description
CheckAndMutateRowRequest	request	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
System.Threading.Tasks.Task<CheckAndMutateRowResponse>	A Task containing the RPC response.

Sample code

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

CheckAndMutateRowAsync(CheckAndMutateRowRequest, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
CheckAndMutateRowRequest	request	The request object containing all of the parameters for the API call.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<CheckAndMutateRowResponse>	A Task containing the RPC response.

Sample code

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

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	tableName	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>.
ByteString	rowKey	The key of the row to which the conditional mutation should be applied.
RowFilter	predicateFilter	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.
System.Collections.Generic.IEnumerable<Mutation>	trueMutations	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.
System.Collections.Generic.IEnumerable<Mutation>	falseMutations	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
System.Threading.Tasks.Task<CheckAndMutateRowResponse>	A Task containing the RPC response.

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	tableName	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>.
ByteString	rowKey	The key of the row to which the conditional mutation should be applied.
RowFilter	predicateFilter	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.
System.Collections.Generic.IEnumerable<Mutation>	trueMutations	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.
System.Collections.Generic.IEnumerable<Mutation>	falseMutations	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.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<CheckAndMutateRowResponse>	A Task containing the RPC response.

Create(ServiceEndpoint, BigtableServiceApiSettings)

Synchronously creates a BigtableServiceApiClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application default credentials where necessary. See the example for how to use custom credentials.

Declaration

public static BigtableServiceApiClient Create(ServiceEndpoint endpoint = null, BigtableServiceApiSettings settings = null)

Parameters

Type	Name	Description
ServiceEndpoint	endpoint	Optional ServiceEndpoint.
BigtableServiceApiSettings	settings	Optional BigtableServiceApiSettings.

Returns

Type	Description
BigtableServiceApiClient	The created BigtableServiceApiClient.

Examples

This sample shows how to create a client using default credentials:

using Google.Cloud.Bigtable.V2;
...
// When running on Google Cloud Platform this will use the project Compute Credential.
// Or set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path of a JSON
// credential file to use that credential.
BigtableServiceApiClient client = BigtableServiceApiClient.Create();

This sample shows how to create a client using credentials loaded from a JSON file:

using Google.Cloud.Bigtable.V2;
using Google.Apis.Auth.OAuth2;
using Grpc.Auth;
using Grpc.Core;
...
GoogleCredential cred = GoogleCredential.FromFile("/path/to/credentials.json");
Channel channel = new Channel(
    BigtableServiceApiClient.DefaultEndpoint.Host, BigtableServiceApiClient.DefaultEndpoint.Port, cred.ToChannelCredentials());
BigtableServiceApiClient client = BigtableServiceApiClient.Create(channel);
...
// Shutdown the channel when it is no longer required.
channel.ShutdownAsync().Wait();

Create(CallInvoker, BigtableServiceApiSettings)

Creates a BigtableServiceApiClient which uses the specified call invoker for remote operations.

Declaration

public static BigtableServiceApiClient Create(CallInvoker callInvoker, BigtableServiceApiSettings settings = null)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The CallInvoker for remote operations. Must not be null.
BigtableServiceApiSettings	settings	Optional BigtableServiceApiSettings.

Returns

Type	Description
BigtableServiceApiClient	The created BigtableServiceApiClient.

Create(Channel, BigtableServiceApiSettings)

Creates a BigtableServiceApiClient which uses the specified channel for remote operations.

Declaration

public static BigtableServiceApiClient Create(Channel channel, BigtableServiceApiSettings settings = null)

Parameters

Type	Name	Description
Channel	channel	The Channel for remote operations. Must not be null.
BigtableServiceApiSettings	settings	Optional BigtableServiceApiSettings.

Returns

Type	Description
BigtableServiceApiClient	The created BigtableServiceApiClient.

CreateAsync(ServiceEndpoint, BigtableServiceApiSettings)

Asynchronously creates a BigtableServiceApiClient, applying defaults for all unspecified settings, and creating a channel connecting to the given endpoint with application default credentials where necessary. See the example for how to use custom credentials.

Declaration

public static Task<BigtableServiceApiClient> CreateAsync(ServiceEndpoint endpoint = null, BigtableServiceApiSettings settings = null)

Parameters

Type	Name	Description
ServiceEndpoint	endpoint	Optional ServiceEndpoint.
BigtableServiceApiSettings	settings	Optional BigtableServiceApiSettings.

Returns

Type	Description
System.Threading.Tasks.Task<BigtableServiceApiClient>	The task representing the created BigtableServiceApiClient.

Examples

This sample shows how to create a client using default credentials:

using Google.Cloud.Bigtable.V2;
...
// When running on Google Cloud Platform this will use the project Compute Credential.
// Or set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the path of a JSON
// credential file to use that credential.
BigtableServiceApiClient client = await BigtableServiceApiClient.CreateAsync();

This sample shows how to create a client using credentials loaded from a JSON file:

using Google.Cloud.Bigtable.V2;
using Google.Apis.Auth.OAuth2;
using Grpc.Auth;
using Grpc.Core;
...
GoogleCredential cred = GoogleCredential.FromFile("/path/to/credentials.json");
Channel channel = new Channel(
    BigtableServiceApiClient.DefaultEndpoint.Host, BigtableServiceApiClient.DefaultEndpoint.Port, cred.ToChannelCredentials());
BigtableServiceApiClient client = BigtableServiceApiClient.Create(channel);
...
// Shutdown the channel when it is no longer required.
await channel.ShutdownAsync();

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

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

Declaration

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

Parameters

Type	Name	Description
TableName	tableName	The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
ByteString	rowKey	The key of the row to which the mutation should be applied.
System.Collections.Generic.IEnumerable<Mutation>	mutations	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.

Sample code

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

MutateRow(MutateRowRequest, CallSettings)

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

Declaration

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

Parameters

Type	Name	Description
MutateRowRequest	request	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.

Sample code

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

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	tableName	The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
ByteString	rowKey	The key of the row to which the mutation should be applied.
System.Collections.Generic.IEnumerable<Mutation>	mutations	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.

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

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

Declaration

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

Parameters

Type	Name	Description
TableName	tableName	The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
ByteString	rowKey	The key of the row to which the mutation should be applied.
System.Collections.Generic.IEnumerable<Mutation>	mutations	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
System.Threading.Tasks.Task<MutateRowResponse>	A Task containing the RPC response.

Sample code

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

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

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

Declaration

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

Parameters

Type	Name	Description
TableName	tableName	The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
ByteString	rowKey	The key of the row to which the mutation should be applied.
System.Collections.Generic.IEnumerable<Mutation>	mutations	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.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<MutateRowResponse>	A Task containing the RPC response.

Sample code

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

MutateRowAsync(MutateRowRequest, CallSettings)

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

Declaration

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

Parameters

Type	Name	Description
MutateRowRequest	request	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
System.Threading.Tasks.Task<MutateRowResponse>	A Task containing the RPC response.

Sample code

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

MutateRowAsync(MutateRowRequest, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
MutateRowRequest	request	The request object containing all of the parameters for the API call.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<MutateRowResponse>	A Task containing the RPC response.

Sample code

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

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	tableName	The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
ByteString	rowKey	The key of the row to which the mutation should be applied.
System.Collections.Generic.IEnumerable<Mutation>	mutations	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
System.Threading.Tasks.Task<MutateRowResponse>	A Task containing the RPC response.

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	tableName	The unique name of the table to which the mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
ByteString	rowKey	The key of the row to which the mutation should be applied.
System.Collections.Generic.IEnumerable<Mutation>	mutations	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.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<MutateRowResponse>	A Task containing the RPC response.

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

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

Declaration

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(TableName tableName, IEnumerable<MutateRowsRequest.Types.Entry> entries, CallSettings callSettings = null)

Parameters

Type	Name	Description
TableName	tableName	The unique name of the table to which the mutations should be applied.
System.Collections.Generic.IEnumerable<MutateRowsRequest.Types.Entry>	entries	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
BigtableServiceApiClient.MutateRowsStream	The server stream.

MutateRows(MutateRowsRequest, CallSettings)

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

Declaration

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(MutateRowsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
MutateRowsRequest	request	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
BigtableServiceApiClient.MutateRowsStream	The server stream.

Sample code

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

// Read streaming responses from server until complete
IAsyncEnumerator<MutateRowsResponse> responseStream = streamingResponse.ResponseStream;
while (await responseStream.MoveNext())
{
    MutateRowsResponse response = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

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

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

Declaration

public virtual BigtableServiceApiClient.MutateRowsStream MutateRows(string tableName, IEnumerable<MutateRowsRequest.Types.Entry> entries, CallSettings callSettings = null)

Parameters

Type	Name	Description
System.String	tableName	The unique name of the table to which the mutations should be applied.
System.Collections.Generic.IEnumerable<MutateRowsRequest.Types.Entry>	entries	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
BigtableServiceApiClient.MutateRowsStream	The server stream.

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

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.

Declaration

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CallSettings callSettings = null)

Parameters

Type	Name	Description
TableName	tableName	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>.
ByteString	rowKey	The key of the row to which the read/modify/write rules should be applied.
System.Collections.Generic.IEnumerable<ReadModifyWriteRule>	rules	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.

Sample code

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

ReadModifyWriteRow(ReadModifyWriteRowRequest, CallSettings)

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.

Declaration

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

Parameters

Type	Name	Description
ReadModifyWriteRowRequest	request	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.

Sample code

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

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

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.

Declaration

public virtual ReadModifyWriteRowResponse ReadModifyWriteRow(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CallSettings callSettings = null)

Parameters

Type	Name	Description
System.String	tableName	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>.
ByteString	rowKey	The key of the row to which the read/modify/write rules should be applied.
System.Collections.Generic.IEnumerable<ReadModifyWriteRule>	rules	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.

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

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.

Declaration

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CallSettings callSettings = null)

Parameters

Type	Name	Description
TableName	tableName	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>.
ByteString	rowKey	The key of the row to which the read/modify/write rules should be applied.
System.Collections.Generic.IEnumerable<ReadModifyWriteRule>	rules	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
System.Threading.Tasks.Task<ReadModifyWriteRowResponse>	A Task containing the RPC response.

Sample code

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

ReadModifyWriteRowAsync(TableName, ByteString, IEnumerable<ReadModifyWriteRule>, 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.

Declaration

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(TableName tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CancellationToken cancellationToken)

Parameters

Type	Name	Description
TableName	tableName	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>.
ByteString	rowKey	The key of the row to which the read/modify/write rules should be applied.
System.Collections.Generic.IEnumerable<ReadModifyWriteRule>	rules	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.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<ReadModifyWriteRowResponse>	A Task containing the RPC response.

Sample code

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

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, CallSettings)

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.

Declaration

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

Parameters

Type	Name	Description
ReadModifyWriteRowRequest	request	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
System.Threading.Tasks.Task<ReadModifyWriteRowResponse>	A Task containing the RPC response.

Sample code

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

ReadModifyWriteRowAsync(ReadModifyWriteRowRequest, 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.

Declaration

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(ReadModifyWriteRowRequest request, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ReadModifyWriteRowRequest	request	The request object containing all of the parameters for the API call.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<ReadModifyWriteRowResponse>	A Task containing the RPC response.

Sample code

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

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

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.

Declaration

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CallSettings callSettings = null)

Parameters

Type	Name	Description
System.String	tableName	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>.
ByteString	rowKey	The key of the row to which the read/modify/write rules should be applied.
System.Collections.Generic.IEnumerable<ReadModifyWriteRule>	rules	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
System.Threading.Tasks.Task<ReadModifyWriteRowResponse>	A Task containing the RPC response.

ReadModifyWriteRowAsync(String, ByteString, IEnumerable<ReadModifyWriteRule>, 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.

Declaration

public virtual Task<ReadModifyWriteRowResponse> ReadModifyWriteRowAsync(string tableName, ByteString rowKey, IEnumerable<ReadModifyWriteRule> rules, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	tableName	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>.
ByteString	rowKey	The key of the row to which the read/modify/write rules should be applied.
System.Collections.Generic.IEnumerable<ReadModifyWriteRule>	rules	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.
System.Threading.CancellationToken	cancellationToken	A System.Threading.CancellationToken to use for this RPC.

Returns

Type	Description
System.Threading.Tasks.Task<ReadModifyWriteRowResponse>	A Task containing the RPC response.

ReadRows(TableName, CallSettings)

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.

Declaration

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(TableName tableName, CallSettings callSettings = null)

Parameters

Type	Name	Description
TableName	tableName	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
BigtableServiceApiClient.ReadRowsStream	The server stream.

ReadRows(ReadRowsRequest, CallSettings)

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.

Declaration

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(ReadRowsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ReadRowsRequest	request	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
BigtableServiceApiClient.ReadRowsStream	The server stream.

Sample code

// Create client
BigtableServiceApiClient bigtableServiceApiClient = BigtableServiceApiClient.Create();
// Initialize request argument
ReadRowsRequest request = new ReadRowsRequest
{
    TableNameAsTableName = new TableName("[PROJECT]", "[INSTANCE]", "[TABLE]"),
};
// Make the request, returning a streaming response
BigtableServiceApiClient.ReadRowsStream streamingResponse = bigtableServiceApiClient.ReadRows(request);

// Read streaming responses from server until complete
IAsyncEnumerator<ReadRowsResponse> responseStream = streamingResponse.ResponseStream;
while (await responseStream.MoveNext())
{
    ReadRowsResponse response = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

ReadRows(String, CallSettings)

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.

Declaration

public virtual BigtableServiceApiClient.ReadRowsStream ReadRows(string tableName, CallSettings callSettings = null)

Parameters

Type	Name	Description
System.String	tableName	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
BigtableServiceApiClient.ReadRowsStream	The server stream.

SampleRowKeys(TableName, CallSettings)

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.

Declaration

public virtual BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(TableName tableName, CallSettings callSettings = null)

Parameters

Type	Name	Description
TableName	tableName	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
BigtableServiceApiClient.SampleRowKeysStream	The server stream.

SampleRowKeys(SampleRowKeysRequest, CallSettings)

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.

Declaration

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

Parameters

Type	Name	Description
SampleRowKeysRequest	request	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
BigtableServiceApiClient.SampleRowKeysStream	The server stream.

Sample code

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

// Read streaming responses from server until complete
IAsyncEnumerator<SampleRowKeysResponse> responseStream = streamingResponse.ResponseStream;
while (await responseStream.MoveNext())
{
    SampleRowKeysResponse response = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed

SampleRowKeys(String, CallSettings)

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.

Declaration

public virtual BigtableServiceApiClient.SampleRowKeysStream SampleRowKeys(string tableName, CallSettings callSettings = null)

Parameters

Type	Name	Description
System.String	tableName	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
BigtableServiceApiClient.SampleRowKeysStream	The server stream.

ShutdownDefaultChannelsAsync()

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

Declaration

public static Task ShutdownDefaultChannelsAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task representing the asynchronous shutdown operation.

Remarks

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