Namespace google::cloud::bigtable_admin (2.33.0-rc)

Classes

BigtableInstanceAdminClient

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters.

BigtableInstanceAdminConnection

The BigtableInstanceAdminConnection object for BigtableInstanceAdminClient.

BigtableInstanceAdminConnectionIdempotencyPolicy

BigtableInstanceAdminLimitedErrorCountRetryPolicy

A retry policy for BigtableInstanceAdminConnection based on counting errors.

BigtableInstanceAdminLimitedTimeRetryPolicy

A retry policy for BigtableInstanceAdminConnection based on elapsed time.

BigtableInstanceAdminRetryPolicy

The retry policy for BigtableInstanceAdminConnection.

BigtableTableAdminClient

Service for creating, configuring, and deleting Cloud Bigtable tables.

BigtableTableAdminConnection

The BigtableTableAdminConnection object for BigtableTableAdminClient.

BigtableTableAdminConnectionIdempotencyPolicy

BigtableTableAdminLimitedErrorCountRetryPolicy

A retry policy for BigtableTableAdminConnection based on counting errors.

BigtableTableAdminLimitedTimeRetryPolicy

A retry policy for BigtableTableAdminConnection based on elapsed time.

BigtableTableAdminRetryPolicy

The retry policy for BigtableTableAdminConnection.

Structs

BigtableInstanceAdminBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

BigtableInstanceAdminConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

BigtableInstanceAdminPollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

BigtableInstanceAdminRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

BigtableTableAdminBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

BigtableTableAdminConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

BigtableTableAdminPollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

BigtableTableAdminRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

Functions

MakeBigtableInstanceAdminConnection(Options)

A factory function to construct an object of type BigtableInstanceAdminConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of BigtableInstanceAdminClient.

The optional options argument may be used to configure aspects of the returned BigtableInstanceAdminConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the BigtableInstanceAdminConnection created by this function.

Returns
Type Description
std::shared_ptr< BigtableInstanceAdminConnection >

MakeDefaultBigtableInstanceAdminConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< BigtableInstanceAdminConnectionIdempotencyPolicy >

MakeBigtableTableAdminConnection(Options)

A factory function to construct an object of type BigtableTableAdminConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of BigtableTableAdminClient.

The optional options argument may be used to configure aspects of the returned BigtableTableAdminConnection. Expected options are any of the types in the following option lists:

Parameter
Name Description
options

(optional) Configure the BigtableTableAdminConnection created by this function.

Returns
Type Description
std::shared_ptr< BigtableTableAdminConnection >

MakeDefaultBigtableTableAdminConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< BigtableTableAdminConnectionIdempotencyPolicy >

AsyncWaitForConsistency(CompletionQueue, BigtableTableAdminClient, std::string, std::string, Options)

Polls until a table is consistent, or until the polling policy has expired.

Parameters
Name Description
cq

the completion queue that will execute the asynchronous calls. The application must ensure that one or more threads are blocked on cq.Run().

client

the Table Admin client.

table_name

the fully qualified name of the table. Values are of the form: projects/{project}/instances/{instance}/tables/{table}.

consistency_token

the consistency token of the table.

options

(optional) configuration options. Users who wish to modify the default polling behavior can supply a custom polling policy with BigtableTableAdminPollingPolicyOption. Note that the client's polling policy is not used for this operation.

Returns
Type Description
future< Status >

the consistency status for the table. The status is OK if and only if the table is consistent.