google::cloud::bigtable_admin Namespace Reference

Classes
struct	BigtableInstanceAdminBackoffPolicyOption
	Use with google::cloud::Options to configure the backoff policy. More...
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	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...
struct	BigtableInstanceAdminRetryPolicyOption
	Use with google::cloud::Options to configure the retry policy. More...
struct	BigtableTableAdminBackoffPolicyOption
	Use with google::cloud::Options to configure the backoff 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	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...
struct	BigtableTableAdminRetryPolicyOption
	Use with google::cloud::Options to configure the retry 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< BigtableInstanceAdminConnection >	MakeBigtableInstanceAdminConnection (Options options={})
	A factory function to construct an object of type BigtableInstanceAdminConnection. More...
std::unique_ptr< BigtableInstanceAdminConnectionIdempotencyPolicy >	MakeDefaultBigtableInstanceAdminConnectionIdempotencyPolicy ()
std::shared_ptr< BigtableTableAdminConnection >	MakeBigtableTableAdminConnection (Options options={})
	A factory function to construct an object of type BigtableTableAdminConnection. More...
std::unique_ptr< BigtableTableAdminConnectionIdempotencyPolicy >	MakeDefaultBigtableTableAdminConnectionIdempotencyPolicy ()
future< Status >	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. More...

Typedef Documentation

BigtableInstanceAdminLimitedErrorCountRetryPolicy

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

BigtableInstanceAdminLimitedTimeRetryPolicy

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

BigtableInstanceAdminPolicyOptionList

using google::cloud::bigtable_admin::BigtableInstanceAdminPolicyOptionList = typedef OptionList<BigtableInstanceAdminRetryPolicyOption, BigtableInstanceAdminBackoffPolicyOption, BigtableInstanceAdminPollingPolicyOption, BigtableInstanceAdminConnectionIdempotencyPolicyOption>

The options applicable to BigtableInstanceAdmin.

BigtableInstanceAdminRetryPolicy

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

BigtableTableAdminLimitedErrorCountRetryPolicy

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

BigtableTableAdminLimitedTimeRetryPolicy

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

BigtableTableAdminPolicyOptionList

using google::cloud::bigtable_admin::BigtableTableAdminPolicyOptionList = typedef OptionList<BigtableTableAdminRetryPolicyOption, BigtableTableAdminBackoffPolicyOption, BigtableTableAdminPollingPolicyOption, BigtableTableAdminConnectionIdempotencyPolicyOption>

The options applicable to BigtableTableAdmin.

BigtableTableAdminRetryPolicy

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

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

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

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:

• google::cloud::CommonOptionList
• google::cloud::GrpcOptionList
• google::cloud::UnifiedCredentialsOptionList
• google::cloud::bigtable_admin::BigtableInstanceAdminPolicyOptionList

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:

• google::cloud::CommonOptionList
• google::cloud::GrpcOptionList
• google::cloud::UnifiedCredentialsOptionList
• google::cloud::bigtable_admin::BigtableTableAdminPolicyOptionList

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

(

)