Namespace google::cloud::spanner_admin (2.11.0)

Classes

DatabaseAdminClient

Cloud Spanner Database Admin API.

DatabaseAdminConnection

The DatabaseAdminConnection object for DatabaseAdminClient.

DatabaseAdminConnectionIdempotencyPolicy

InstanceAdminClient

Cloud Spanner Instance Admin API.

InstanceAdminConnection

The InstanceAdminConnection object for InstanceAdminClient.

InstanceAdminConnectionIdempotencyPolicy

Structs

DatabaseAdminBackoffPolicyOption

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

DatabaseAdminConnectionIdempotencyPolicyOption

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

DatabaseAdminPollingPolicyOption

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

DatabaseAdminRetryPolicyOption

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

InstanceAdminBackoffPolicyOption

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

InstanceAdminConnectionIdempotencyPolicyOption

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

InstanceAdminPollingPolicyOption

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

InstanceAdminRetryPolicyOption

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

Functions

MakeDatabaseAdminConnection(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:

Parameter
Name Description
options

(optional) Configure the DatabaseAdminConnection created by this function.

Returns
Type Description
std::shared_ptr< DatabaseAdminConnection >

MakeDefaultDatabaseAdminConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< DatabaseAdminConnectionIdempotencyPolicy >

MakeDatabaseAdminConnectionRest(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:

Parameter
Name Description
options

(optional) Configure the DatabaseAdminConnection created by this function.

Returns
Type Description
std::shared_ptr< DatabaseAdminConnection >

MakeInstanceAdminConnection(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:

Parameter
Name Description
options

(optional) Configure the InstanceAdminConnection created by this function.

Returns
Type Description
std::shared_ptr< InstanceAdminConnection >

MakeDefaultInstanceAdminConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< InstanceAdminConnectionIdempotencyPolicy >

MakeInstanceAdminConnectionRest(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:

Parameter
Name Description
options

(optional) Configure the InstanceAdminConnection created by this function.

Returns
Type Description
std::shared_ptr< InstanceAdminConnection >

Type Aliases

DatabaseAdminRetryPolicy

Alias Of: ::google::cloud::internal::TraitBasedRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits >

DatabaseAdminLimitedTimeRetryPolicy

Alias Of: ::google::cloud::internal::LimitedTimeRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits >

DatabaseAdminLimitedErrorCountRetryPolicy

Alias Of: ::google::cloud::internal::LimitedErrorCountRetryPolicy< spanner_admin_internal::DatabaseAdminRetryTraits >

DatabaseAdminPolicyOptionList

Alias Of: OptionList< DatabaseAdminRetryPolicyOption, DatabaseAdminBackoffPolicyOption, DatabaseAdminPollingPolicyOption, DatabaseAdminConnectionIdempotencyPolicyOption >

The options applicable to DatabaseAdmin.

InstanceAdminRetryPolicy

Alias Of: ::google::cloud::internal::TraitBasedRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits >

InstanceAdminLimitedTimeRetryPolicy

Alias Of: ::google::cloud::internal::LimitedTimeRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits >

InstanceAdminLimitedErrorCountRetryPolicy

Alias Of: ::google::cloud::internal::LimitedErrorCountRetryPolicy< spanner_admin_internal::InstanceAdminRetryTraits >

InstanceAdminPolicyOptionList

Alias Of: OptionList< InstanceAdminRetryPolicyOption, InstanceAdminBackoffPolicyOption, InstanceAdminPollingPolicyOption, InstanceAdminConnectionIdempotencyPolicyOption >

The options applicable to InstanceAdmin.