Class InstanceAdminConnection (2.21.0)

A connection to the Cloud Spanner instance administration service.

This interface defines pure-virtual methods for each of the user-facing overload sets in InstanceAdminClient. This allows users to inject custom behavior (e.g., with a Google Mock object) in a InstanceAdminClient object for use in their own tests.

To create a concrete instance that connects you to a real Cloud Spanner instance administration service, see MakeInstanceAdminConnection().

Functions

virtual options()

Returns
TypeDescription
Options

GetInstance(GetInstanceParams)

Return the metadata for the given instance.

Parameter
NameDescription
GetInstanceParams
Returns
TypeDescription
StatusOr< google::spanner::admin::instance::v1::Instance >

CreateInstance(CreateInstanceParams)

Parameter
NameDescription
p CreateInstanceParams
Returns
TypeDescription
future< StatusOr< google::spanner::admin::instance::v1::Instance > >

UpdateInstance(UpdateInstanceParams)

Parameter
NameDescription
p UpdateInstanceParams
Returns
TypeDescription
future< StatusOr< google::spanner::admin::instance::v1::Instance > >

DeleteInstance(DeleteInstanceParams)

Parameter
NameDescription
p DeleteInstanceParams
Returns
TypeDescription
Status

GetInstanceConfig(GetInstanceConfigParams)

Return the InstanceConfig with the given name.

Parameter
NameDescription
GetInstanceConfigParams
Returns
TypeDescription
StatusOr< google::spanner::admin::instance::v1::InstanceConfig >

ListInstanceConfigs(ListInstanceConfigsParams)

Returns a one-pass input range with all the instance configs.

Parameter
NameDescription
ListInstanceConfigsParams
Returns
TypeDescription
ListInstanceConfigsRange

ListInstances(ListInstancesParams)

Returns a one-pass input range with all the instances meeting the requirements in params.

Parameter
NameDescription
params ListInstancesParams
Returns
TypeDescription
ListInstancesRange

GetIamPolicy(GetIamPolicyParams)

Define the interface for a google.spanner.v1.DatabaseAdmin.GetIamPolicy RPC.

Parameter
NameDescription
GetIamPolicyParams
Returns
TypeDescription
StatusOr< google::iam::v1::Policy >

SetIamPolicy(SetIamPolicyParams)

Define the interface for a google.spanner.v1.DatabaseAdmin.SetIamPolicy RPC.

Parameter
NameDescription
SetIamPolicyParams
Returns
TypeDescription
StatusOr< google::iam::v1::Policy >

TestIamPermissions(TestIamPermissionsParams)

Define the interface for a google.spanner.v1.DatabaseAdmin.TestIamPermissions RPC.

Parameter
NameDescription
TestIamPermissionsParams
Returns
TypeDescription
StatusOr< google::iam::v1::TestIamPermissionsResponse >