Google Cloud Bigtable C++ Client  2.6.0
A C++ Client Library for Google Cloud Bigtable
Classes | Typedefs | Functions
google::cloud::bigtable_admin Namespace Reference

Classes

class  BigtableInstanceAdminClient
 Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. More...
 
class  BigtableInstanceAdminConnection
 The BigtableInstanceAdminConnection object for BigtableInstanceAdminClient. More...
 
class  BigtableInstanceAdminConnectionIdempotencyPolicy
 
struct  BigtableInstanceAdminRetryPolicyOption
 Use with google::cloud::Options to configure the retry policy. More...
 
struct  BigtableInstanceAdminBackoffPolicyOption
 Use with google::cloud::Options to configure the backoff policy. More...
 
struct  BigtableInstanceAdminConnectionIdempotencyPolicyOption
 Use with google::cloud::Options to configure which operations are retried. More...
 
struct  BigtableInstanceAdminPollingPolicyOption
 Use with google::cloud::Options to configure the long-running operations polling policy. More...
 
class  BigtableTableAdminClient
 Service for creating, configuring, and deleting Cloud Bigtable tables. More...
 
class  BigtableTableAdminConnection
 The BigtableTableAdminConnection object for BigtableTableAdminClient. More...
 
class  BigtableTableAdminConnectionIdempotencyPolicy
 
struct  BigtableTableAdminRetryPolicyOption
 Use with google::cloud::Options to configure the retry policy. More...
 
struct  BigtableTableAdminBackoffPolicyOption
 Use with google::cloud::Options to configure the backoff policy. More...
 
struct  BigtableTableAdminConnectionIdempotencyPolicyOption
 Use with google::cloud::Options to configure which operations are retried. More...
 
struct  BigtableTableAdminPollingPolicyOption
 Use with google::cloud::Options to configure the long-running operations polling policy. More...
 

Typedefs

using BigtableInstanceAdminRetryPolicy = ::google::cloud::internal::TraitBasedRetryPolicy< bigtable_admin_internal::BigtableInstanceAdminRetryTraits >
 
using BigtableInstanceAdminLimitedTimeRetryPolicy = ::google::cloud::internal::LimitedTimeRetryPolicy< bigtable_admin_internal::BigtableInstanceAdminRetryTraits >
 
using BigtableInstanceAdminLimitedErrorCountRetryPolicy = ::google::cloud::internal::LimitedErrorCountRetryPolicy< bigtable_admin_internal::BigtableInstanceAdminRetryTraits >
 
using BigtableInstanceAdminPolicyOptionList = OptionList< BigtableInstanceAdminRetryPolicyOption, BigtableInstanceAdminBackoffPolicyOption, BigtableInstanceAdminPollingPolicyOption, BigtableInstanceAdminConnectionIdempotencyPolicyOption >
 The options applicable to BigtableInstanceAdmin. More...
 
using BigtableTableAdminRetryPolicy = ::google::cloud::internal::TraitBasedRetryPolicy< bigtable_admin_internal::BigtableTableAdminRetryTraits >
 
using BigtableTableAdminLimitedTimeRetryPolicy = ::google::cloud::internal::LimitedTimeRetryPolicy< bigtable_admin_internal::BigtableTableAdminRetryTraits >
 
using BigtableTableAdminLimitedErrorCountRetryPolicy = ::google::cloud::internal::LimitedErrorCountRetryPolicy< bigtable_admin_internal::BigtableTableAdminRetryTraits >
 
using BigtableTableAdminPolicyOptionList = OptionList< BigtableTableAdminRetryPolicyOption, BigtableTableAdminBackoffPolicyOption, BigtableTableAdminPollingPolicyOption, BigtableTableAdminConnectionIdempotencyPolicyOption >
 The options applicable to BigtableTableAdmin. More...
 

Functions

std::shared_ptr< BigtableInstanceAdminConnectionMakeBigtableInstanceAdminConnection (Options options={})
 A factory function to construct an object of type BigtableInstanceAdminConnection. More...
 
std::unique_ptr< BigtableInstanceAdminConnectionIdempotencyPolicyMakeDefaultBigtableInstanceAdminConnectionIdempotencyPolicy ()
 
std::shared_ptr< BigtableTableAdminConnectionMakeBigtableTableAdminConnection (Options options={})
 A factory function to construct an object of type BigtableTableAdminConnection. More...
 
std::unique_ptr< BigtableTableAdminConnectionIdempotencyPolicyMakeDefaultBigtableTableAdminConnectionIdempotencyPolicy ()
 
future< StatusAsyncWaitForConsistency (CompletionQueue cq, BigtableTableAdminClient client, std::string table_name, std::string consistency_token, Options options={})
 Polls until a table is consistent, or until the polling policy has expired. More...
 

Typedef Documentation

◆ BigtableInstanceAdminLimitedErrorCountRetryPolicy

using google::cloud::bigtable_admin::BigtableInstanceAdminLimitedErrorCountRetryPolicy = typedef ::google::cloud::internal::LimitedErrorCountRetryPolicy< bigtable_admin_internal::BigtableInstanceAdminRetryTraits>

Definition at line 48 of file bigtable_instance_admin_connection.h.

◆ BigtableInstanceAdminLimitedTimeRetryPolicy

using google::cloud::bigtable_admin::BigtableInstanceAdminLimitedTimeRetryPolicy = typedef ::google::cloud::internal::LimitedTimeRetryPolicy< bigtable_admin_internal::BigtableInstanceAdminRetryTraits>

Definition at line 44 of file bigtable_instance_admin_connection.h.

◆ BigtableInstanceAdminPolicyOptionList

The options applicable to BigtableInstanceAdmin.

Definition at line 77 of file bigtable_instance_admin_options.h.

◆ BigtableInstanceAdminRetryPolicy

using google::cloud::bigtable_admin::BigtableInstanceAdminRetryPolicy = typedef ::google::cloud::internal::TraitBasedRetryPolicy< bigtable_admin_internal::BigtableInstanceAdminRetryTraits>

Definition at line 40 of file bigtable_instance_admin_connection.h.

◆ BigtableTableAdminLimitedErrorCountRetryPolicy

using google::cloud::bigtable_admin::BigtableTableAdminLimitedErrorCountRetryPolicy = typedef ::google::cloud::internal::LimitedErrorCountRetryPolicy< bigtable_admin_internal::BigtableTableAdminRetryTraits>

Definition at line 48 of file bigtable_table_admin_connection.h.

◆ BigtableTableAdminLimitedTimeRetryPolicy

using google::cloud::bigtable_admin::BigtableTableAdminLimitedTimeRetryPolicy = typedef ::google::cloud::internal::LimitedTimeRetryPolicy< bigtable_admin_internal::BigtableTableAdminRetryTraits>

Definition at line 44 of file bigtable_table_admin_connection.h.

◆ BigtableTableAdminPolicyOptionList

The options applicable to BigtableTableAdmin.

Definition at line 76 of file bigtable_table_admin_options.h.

◆ BigtableTableAdminRetryPolicy

using google::cloud::bigtable_admin::BigtableTableAdminRetryPolicy = typedef ::google::cloud::internal::TraitBasedRetryPolicy< bigtable_admin_internal::BigtableTableAdminRetryTraits>

Definition at line 40 of file bigtable_table_admin_connection.h.

Function Documentation

◆ AsyncWaitForConsistency()

future<Status> google::cloud::bigtable_admin::AsyncWaitForConsistency ( CompletionQueue  cq,
BigtableTableAdminClient  client,
std::string  table_name,
std::string  consistency_token,
Options  options = {} 
)

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

Parameters
cqthe completion queue that will execute the asynchronous calls. The application must ensure that one or more threads are blocked on cq.Run().
clientthe Table Admin client.
table_namethe fully qualified name of the table. Values are of the form: projects/{project}/instances/{instance}/tables/{table}.
consistency_tokenthe 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
the consistency status for the table. The status is OK if and only if the table is consistent.

◆ MakeBigtableInstanceAdminConnection()

std::shared_ptr<BigtableInstanceAdminConnection> google::cloud::bigtable_admin::MakeBigtableInstanceAdminConnection ( Options  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:

Note
Unexpected options will be ignored. To log unexpected options instead, set GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes in the environment.
Parameters
options(optional) Configure the BigtableInstanceAdminConnection created by this function.

◆ MakeBigtableTableAdminConnection()

std::shared_ptr<BigtableTableAdminConnection> google::cloud::bigtable_admin::MakeBigtableTableAdminConnection ( Options  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:

Note
Unexpected options will be ignored. To log unexpected options instead, set GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes in the environment.
Parameters
options(optional) Configure the BigtableTableAdminConnection created by this function.

◆ MakeDefaultBigtableInstanceAdminConnectionIdempotencyPolicy()

std::unique_ptr<BigtableInstanceAdminConnectionIdempotencyPolicy> google::cloud::bigtable_admin::MakeDefaultBigtableInstanceAdminConnectionIdempotencyPolicy ( )

◆ MakeDefaultBigtableTableAdminConnectionIdempotencyPolicy()

std::unique_ptr<BigtableTableAdminConnectionIdempotencyPolicy> google::cloud::bigtable_admin::MakeDefaultBigtableTableAdminConnectionIdempotencyPolicy ( )