Class BigtableServiceApiClient
BigtableServiceApi client wrapper, for convenient use.
Inherited Members
Namespace: Google.Cloud.Bigtable.V2
Assembly: Google.Cloud.Bigtable.V2.dll
Syntax
public abstract class BigtableServiceApiClient
Remarks
Service for reading from and writing to existing Bigtable tables.
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 BigtableServiceApi service, which is a host of "bigtable.googleapis.com" and a port of 443.
Declaration
public static string DefaultEndpoint { get; }
Property Value
Type | Description |
---|---|
System.String |
DefaultScopes
The default BigtableServiceApi scopes.
Declaration
public static IReadOnlyList<string> DefaultScopes { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyList<System.String> |
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
The underlying gRPC BigtableServiceApi 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 | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
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 = 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
System.String | appProfileId | 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. |
Sample code
// 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)
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 = 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)
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 | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
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)
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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
System.String | appProfileId | 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. |
Sample code
// 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)
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 | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
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 = 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
System.String | appProfileId | 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 |
---|---|
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 = 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)
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, string appProfileId, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
System.String | appProfileId | This value specifies routing for replication. If not specified, the "default" application profile will be used. |
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 = 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)
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 | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
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 = 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)
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 = 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)
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 = 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)
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 | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
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)
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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
System.String | appProfileId | 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 |
---|---|
System.Threading.Tasks.Task<CheckAndMutateRowResponse> | A Task containing the RPC response. |
Sample code
// 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)
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, string appProfileId, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
System.String | appProfileId | This value specifies routing for replication. If not specified, the "default" application profile will be used. |
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)
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)
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 | Required. The unique name of the table to which the conditional mutation should be
applied.
Values are of the form
|
ByteString | rowKey | Required. 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 |
System.Collections.Generic.IEnumerable<Mutation> | trueMutations | Changes to be atomically applied to the specified row if |
System.Collections.Generic.IEnumerable<Mutation> | falseMutations | Changes to be atomically applied to the specified row if |
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)
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()
Synchronously creates a BigtableServiceApiClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableServiceApiClientBuilder .
Declaration
public static BigtableServiceApiClient Create()
Returns
Type | Description |
---|---|
BigtableServiceApiClient | The created BigtableServiceApiClient. |
CreateAsync(CancellationToken)
Asynchronously creates a BigtableServiceApiClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use BigtableServiceApiClientBuilder .
Declaration
public static Task<BigtableServiceApiClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.Threading.CancellationToken | cancellationToken | The System.Threading.CancellationToken to use while creating the client. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<BigtableServiceApiClient> | The task representing the created BigtableServiceApiClient. |
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 | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
Sample code
// 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
System.String | appProfileId | 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. |
Sample code
// 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)
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 = 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)
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 | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
Sample code
// 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
System.String | appProfileId | 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. |
Sample code
// 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)
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 | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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 |
---|---|
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 = 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
System.String | appProfileId | 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 |
---|---|
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 = 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)
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, string appProfileId, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
System.String | appProfileId | This value specifies routing for replication. If not specified, the "default" application profile will be used. |
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 = 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)
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 | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
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 = 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)
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 = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
RowKey = ByteString.Empty,
Mutations = { new Mutation(), },
AppProfileId = "",
};
// 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 = 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)
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 | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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 |
---|---|
System.Threading.Tasks.Task<MutateRowResponse> | A Task containing the RPC response. |
Sample code
// 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
System.String | appProfileId | 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 |
---|---|
System.Threading.Tasks.Task<MutateRowResponse> | A Task containing the RPC response. |
Sample code
// 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)
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, string appProfileId, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
System.String | appProfileId | This value specifies routing for replication. If not specified, the "default" application profile will be used. |
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)
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)
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 | Required. The unique name of the table to which the mutation should be applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the mutation should be applied. |
System.Collections.Generic.IEnumerable<Mutation> | mutations | 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. |
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)
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<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 | Required. The unique name of the table to which the mutations should be applied. |
System.Collections.Generic.IEnumerable<MutateRowsRequest.Types.Entry> | entries | 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 |
---|---|
BigtableServiceApiClient.MutateRowsStream | The server stream. |
Sample code
// 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
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<MutateRowsRequest.Types.Entry>, String, 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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table to which the mutations should be applied. |
System.Collections.Generic.IEnumerable<MutateRowsRequest.Types.Entry> | entries | 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. |
System.String | appProfileId | 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 |
---|---|
BigtableServiceApiClient.MutateRowsStream | The server stream. |
Sample code
// 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
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)
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(s)
MutateRowsRequest request = new MutateRowsRequest
{
TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
Entries =
{
new MutateRowsRequest.Types.Entry(),
},
AppProfileId = "",
};
// Make the request, returning a streaming response
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<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 | Required. The unique name of the table to which the mutations should be applied. |
System.Collections.Generic.IEnumerable<MutateRowsRequest.Types.Entry> | entries | 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 |
---|---|
BigtableServiceApiClient.MutateRowsStream | The server stream. |
Sample code
// 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
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<MutateRowsRequest.Types.Entry>, String, 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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the mutations should be applied. |
System.Collections.Generic.IEnumerable<MutateRowsRequest.Types.Entry> | entries | 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. |
System.String | appProfileId | 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 |
---|---|
BigtableServiceApiClient.MutateRowsStream | The server stream. |
Sample code
// 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
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
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 | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
Sample code
// 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | 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
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
System.String | appProfileId | 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. |
Sample code
// 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)
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 = 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)
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 | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
Sample code
// 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
System.String | appProfileId | 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. |
Sample code
// 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)
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 | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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 |
---|---|
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 = 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | 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
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
System.String | appProfileId | 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 |
---|---|
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 = 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)
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, string appProfileId, CancellationToken cancellationToken)
Parameters
Type | 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
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
System.String | appProfileId | This value specifies routing for replication. If not specified, the "default" application profile will be used. |
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 = 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)
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 | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
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 = 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)
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 = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
RowKey = ByteString.Empty,
Rules =
{
new ReadModifyWriteRule(),
},
AppProfileId = "",
};
// 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 = 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)
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 | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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 |
---|---|
System.Threading.Tasks.Task<ReadModifyWriteRowResponse> | A Task containing the RPC response. |
Sample code
// 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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
System.String | appProfileId | 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 |
---|---|
System.Threading.Tasks.Task<ReadModifyWriteRowResponse> | A Task containing the RPC response. |
Sample code
// 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)
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, string appProfileId, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
System.String | appProfileId | This value specifies routing for replication. If not specified, the "default" application profile will be used. |
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)
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)
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 | Required. The unique name of the table to which the read/modify/write rules should be
applied.
Values are of the form
|
ByteString | rowKey | Required. The key of the row to which the read/modify/write rules should be applied. |
System.Collections.Generic.IEnumerable<ReadModifyWriteRule> | rules | 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. |
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)
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)
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 | Required. The unique name of the table from which to read.
Values are of the form
|
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(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request, returning a streaming response
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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table from which to read.
Values are of the form
|
System.String | appProfileId | 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 |
---|---|
BigtableServiceApiClient.ReadRowsStream | The server stream. |
Sample code
// 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
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)
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(s)
ReadRowsRequest request = new ReadRowsRequest
{
TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
Rows = new RowSet(),
Filter = new RowFilter(),
RowsLimit = 0L,
AppProfileId = "",
};
// Make the request, returning a streaming response
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)
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 | Required. The unique name of the table from which to read.
Values are of the form
|
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(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request, returning a streaming response
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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table from which to read.
Values are of the form
|
System.String | appProfileId | 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 |
---|---|
BigtableServiceApiClient.ReadRowsStream | The server stream. |
Sample code
// 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
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)
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 | Required. The unique name of the table from which to sample row keys.
Values are of the form
|
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(s)
TableName tableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]");
// Make the request, returning a streaming response
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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
TableName | tableName | Required. The unique name of the table from which to sample row keys.
Values are of the form
|
System.String | appProfileId | 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 |
---|---|
BigtableServiceApiClient.SampleRowKeysStream | The server stream. |
Sample code
// 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
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)
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(s)
SampleRowKeysRequest request = new SampleRowKeysRequest
{
TableNameAsTableName = TableName.FromProjectInstanceTable("[PROJECT]", "[INSTANCE]", "[TABLE]"),
AppProfileId = "",
};
// Make the request, returning a streaming response
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)
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 | Required. The unique name of the table from which to sample row keys.
Values are of the form
|
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(s)
string tableName = "projects/[PROJECT]/instances/[INSTANCE]/tables/[TABLE]";
// Make the request, returning a streaming response
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)
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, string appProfileId, CallSettings callSettings = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName | Required. The unique name of the table from which to sample row keys.
Values are of the form
|
System.String | appProfileId | 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 |
---|---|
BigtableServiceApiClient.SampleRowKeysStream | The server stream. |
Sample code
// 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
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()
Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). 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() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.