Class InstanceAdminConnection (2.28.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
Type Description
Options

GetInstance(GetInstanceParams)

Return the metadata for the given instance.

Parameter
Name Description
GetInstanceParams
Returns
Type Description
StatusOr< google::spanner::admin::instance::v1::Instance >

CreateInstance(CreateInstanceParams)

Parameter
Name Description
p CreateInstanceParams
Returns
Type Description
future< StatusOr< google::spanner::admin::instance::v1::Instance > >

UpdateInstance(UpdateInstanceParams)

Parameter
Name Description
p UpdateInstanceParams
Returns
Type Description
future< StatusOr< google::spanner::admin::instance::v1::Instance > >

DeleteInstance(DeleteInstanceParams)

Parameter
Name Description
p DeleteInstanceParams
Returns
Type Description
Status

GetInstanceConfig(GetInstanceConfigParams)

Return the InstanceConfig with the given name.

Parameter
Name Description
GetInstanceConfigParams
Returns
Type Description
StatusOr< google::spanner::admin::instance::v1::InstanceConfig >

ListInstanceConfigs(ListInstanceConfigsParams)

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

Parameter
Name Description
ListInstanceConfigsParams
Returns
Type Description
ListInstanceConfigsRange

ListInstances(ListInstancesParams)

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

Parameter
Name Description
params ListInstancesParams
Returns
Type Description
ListInstancesRange

GetIamPolicy(GetIamPolicyParams)

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

Parameter
Name Description
GetIamPolicyParams
Returns
Type Description
StatusOr< google::iam::v1::Policy >

SetIamPolicy(SetIamPolicyParams)

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

Parameter
Name Description
SetIamPolicyParams
Returns
Type Description
StatusOr< google::iam::v1::Policy >

TestIamPermissions(TestIamPermissionsParams)

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

Parameter
Name Description
TestIamPermissionsParams
Returns
Type Description
StatusOr< google::iam::v1::TestIamPermissionsResponse >