google::cloud::spanner_admin Namespace Reference

Classes
struct	DatabaseAdminBackoffPolicyOption
	Use with google::cloud::Options to configure the backoff policy. More...
class	DatabaseAdminClient
	Cloud Spanner Database Admin API. More...
class	DatabaseAdminConnection
	The DatabaseAdminConnection object for DatabaseAdminClient. More...
class	DatabaseAdminConnectionIdempotencyPolicy
struct	DatabaseAdminConnectionIdempotencyPolicyOption
	Use with google::cloud::Options to configure which operations are retried. More...
struct	DatabaseAdminPollingPolicyOption
	Use with google::cloud::Options to configure the long-running operations polling policy. More...
struct	DatabaseAdminRetryPolicyOption
	Use with google::cloud::Options to configure the retry policy. More...
struct	InstanceAdminBackoffPolicyOption
	Use with google::cloud::Options to configure the backoff policy. More...
class	InstanceAdminClient
	Cloud Spanner Instance Admin API. More...
class	InstanceAdminConnection
	The InstanceAdminConnection object for InstanceAdminClient. More...
class	InstanceAdminConnectionIdempotencyPolicy
struct	InstanceAdminConnectionIdempotencyPolicyOption
	Use with google::cloud::Options to configure which operations are retried. More...
struct	InstanceAdminPollingPolicyOption
	Use with google::cloud::Options to configure the long-running operations polling policy. More...
struct	InstanceAdminRetryPolicyOption
	Use with google::cloud::Options to configure the retry policy. More...

Typedefs
using	DatabaseAdminRetryPolicy = ::google::cloud::internal::TraitBasedRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits >
using	DatabaseAdminLimitedTimeRetryPolicy = ::google::cloud::internal::LimitedTimeRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits >
using	DatabaseAdminLimitedErrorCountRetryPolicy = ::google::cloud::internal::LimitedErrorCountRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits >
using	DatabaseAdminPolicyOptionList = OptionList< DatabaseAdminRetryPolicyOption, DatabaseAdminBackoffPolicyOption, DatabaseAdminPollingPolicyOption, DatabaseAdminConnectionIdempotencyPolicyOption >
	The options applicable to DatabaseAdmin. More...
using	InstanceAdminRetryPolicy = ::google::cloud::internal::TraitBasedRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits >
using	InstanceAdminLimitedTimeRetryPolicy = ::google::cloud::internal::LimitedTimeRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits >
using	InstanceAdminLimitedErrorCountRetryPolicy = ::google::cloud::internal::LimitedErrorCountRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits >
using	InstanceAdminPolicyOptionList = OptionList< InstanceAdminRetryPolicyOption, InstanceAdminBackoffPolicyOption, InstanceAdminPollingPolicyOption, InstanceAdminConnectionIdempotencyPolicyOption >
	The options applicable to InstanceAdmin. More...

Functions
std::shared_ptr< DatabaseAdminConnection >	MakeDatabaseAdminConnection (Options options={})
	A factory function to construct an object of type DatabaseAdminConnection. More...
std::unique_ptr< DatabaseAdminConnectionIdempotencyPolicy >	MakeDefaultDatabaseAdminConnectionIdempotencyPolicy ()
std::shared_ptr< DatabaseAdminConnection >	MakeDatabaseAdminConnectionRest (Options options={})
	A factory function to construct an object of type DatabaseAdminConnection that uses REST over HTTP as transport in lieu of gRPC. More...
std::shared_ptr< InstanceAdminConnection >	MakeInstanceAdminConnection (Options options={})
	A factory function to construct an object of type InstanceAdminConnection. More...
std::unique_ptr< InstanceAdminConnectionIdempotencyPolicy >	MakeDefaultInstanceAdminConnectionIdempotencyPolicy ()
std::shared_ptr< InstanceAdminConnection >	MakeInstanceAdminConnectionRest (Options options={})
	A factory function to construct an object of type InstanceAdminConnection that uses REST over HTTP as transport in lieu of gRPC. More...

Typedef Documentation

DatabaseAdminLimitedErrorCountRetryPolicy

using google::cloud::spanner_admin::DatabaseAdminLimitedErrorCountRetryPolicy = typedef ::google::cloud::internal::LimitedErrorCountRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits>

DatabaseAdminLimitedTimeRetryPolicy

using google::cloud::spanner_admin::DatabaseAdminLimitedTimeRetryPolicy = typedef ::google::cloud::internal::LimitedTimeRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits>

DatabaseAdminPolicyOptionList

using google::cloud::spanner_admin::DatabaseAdminPolicyOptionList = typedef OptionList<DatabaseAdminRetryPolicyOption, DatabaseAdminBackoffPolicyOption, DatabaseAdminPollingPolicyOption, DatabaseAdminConnectionIdempotencyPolicyOption>

The options applicable to DatabaseAdmin.

DatabaseAdminRetryPolicy

using google::cloud::spanner_admin::DatabaseAdminRetryPolicy = typedef ::google::cloud::internal::TraitBasedRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits>

InstanceAdminLimitedErrorCountRetryPolicy

using google::cloud::spanner_admin::InstanceAdminLimitedErrorCountRetryPolicy = typedef ::google::cloud::internal::LimitedErrorCountRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits>

InstanceAdminLimitedTimeRetryPolicy

using google::cloud::spanner_admin::InstanceAdminLimitedTimeRetryPolicy = typedef ::google::cloud::internal::LimitedTimeRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits>

InstanceAdminPolicyOptionList

using google::cloud::spanner_admin::InstanceAdminPolicyOptionList = typedef OptionList<InstanceAdminRetryPolicyOption, InstanceAdminBackoffPolicyOption, InstanceAdminPollingPolicyOption, InstanceAdminConnectionIdempotencyPolicyOption>

The options applicable to InstanceAdmin.

InstanceAdminRetryPolicy

using google::cloud::spanner_admin::InstanceAdminRetryPolicy = typedef ::google::cloud::internal::TraitBasedRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits>

Function Documentation

MakeDatabaseAdminConnection()

std::shared_ptr< DatabaseAdminConnection > google::cloud::spanner_admin::MakeDatabaseAdminConnection

(

Options

options = {}

)

A factory function to construct an object of type DatabaseAdminConnection.

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

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

• google::cloud::CommonOptionList
• google::cloud::GrpcOptionList
• google::cloud::UnifiedCredentialsOptionList
• google::cloud::spanner_admin::DatabaseAdminPolicyOptionList

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 DatabaseAdminConnection created by this function.

MakeDatabaseAdminConnectionRest()

std::shared_ptr< DatabaseAdminConnection > google::cloud::spanner_admin::MakeDatabaseAdminConnectionRest

(

Options

options = {}

)

A factory function to construct an object of type DatabaseAdminConnection that uses REST over HTTP as transport in lieu of gRPC.

REST transport should only be used for services that do not support gRPC or if the existing network configuration precludes using gRPC.

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

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

• google::cloud::CommonOptionList
• google::cloud::RestOptionList
• google::cloud::UnifiedCredentialsOptionList
• google::cloud::spanner_admin::DatabaseAdminPolicyOptionList

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 DatabaseAdminConnection created by this function.

MakeDefaultDatabaseAdminConnectionIdempotencyPolicy()

std::unique_ptr< DatabaseAdminConnectionIdempotencyPolicy > google::cloud::spanner_admin::MakeDefaultDatabaseAdminConnectionIdempotencyPolicy

(

)

MakeDefaultInstanceAdminConnectionIdempotencyPolicy()

std::unique_ptr< InstanceAdminConnectionIdempotencyPolicy > google::cloud::spanner_admin::MakeDefaultInstanceAdminConnectionIdempotencyPolicy

(

)

MakeInstanceAdminConnection()

std::shared_ptr< InstanceAdminConnection > google::cloud::spanner_admin::MakeInstanceAdminConnection

(

Options

options = {}

)

A factory function to construct an object of type InstanceAdminConnection.

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

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

• google::cloud::CommonOptionList
• google::cloud::GrpcOptionList
• google::cloud::UnifiedCredentialsOptionList
• google::cloud::spanner_admin::InstanceAdminPolicyOptionList

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 InstanceAdminConnection created by this function.

MakeInstanceAdminConnectionRest()

std::shared_ptr< InstanceAdminConnection > google::cloud::spanner_admin::MakeInstanceAdminConnectionRest

(

Options

options = {}

)

A factory function to construct an object of type InstanceAdminConnection that uses REST over HTTP as transport in lieu of gRPC.

REST transport should only be used for services that do not support gRPC or if the existing network configuration precludes using gRPC.

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

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

• google::cloud::CommonOptionList
• google::cloud::RestOptionList
• google::cloud::UnifiedCredentialsOptionList
• google::cloud::spanner_admin::InstanceAdminPolicyOptionList

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 InstanceAdminConnection created by this function.