Google Cloud Spanner C++ Client 2.13.0
A C++ Client Library for Google Cloud Spanner
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
google::cloud::spanner::InstanceAdminConnection Class Referenceabstract

A connection to the Cloud Spanner instance administration service. More...

#include <google/cloud/spanner/instance_admin_connection.h>

Classes

struct  CreateInstanceParams
 Wrap the arguments for CreateInstance(). More...
 
struct  DeleteInstanceParams
 Wrap the arguments for DeleteInstance(). More...
 
struct  GetIamPolicyParams
 Wrap the arguments for GetIamPolicy(). More...
 
struct  GetInstanceConfigParams
 Wrap the arguments for GetInstanceConfig(). More...
 
struct  GetInstanceParams
 Wrap the arguments for GetInstance(). More...
 
struct  ListInstanceConfigsParams
 Wrap the arguments for ListInstanceConfigs(). More...
 
struct  ListInstancesParams
 Wrap the arguments for ListInstances(). More...
 
struct  SetIamPolicyParams
 Wrap the arguments for SetIamPolicy(). More...
 
struct  TestIamPermissionsParams
 Wrap the arguments for TestIamPermissions(). More...
 
struct  UpdateInstanceParams
 Wrap the arguments for UpdateInstance(). More...
 

Public Member Functions

virtual ~InstanceAdminConnection ()=0
 
virtual Options options ()
 
virtual StatusOr< google::spanner::admin::instance::v1::Instance > GetInstance (GetInstanceParams)=0
 Return the metadata for the given instance. More...
 
virtual future< StatusOr< google::spanner::admin::instance::v1::Instance > > CreateInstance (CreateInstanceParams p)=0
 
virtual future< StatusOr< google::spanner::admin::instance::v1::Instance > > UpdateInstance (UpdateInstanceParams p)=0
 
virtual Status DeleteInstance (DeleteInstanceParams p)=0
 
virtual StatusOr< google::spanner::admin::instance::v1::InstanceConfig > GetInstanceConfig (GetInstanceConfigParams)=0
 Return the InstanceConfig with the given name. More...
 
virtual ListInstanceConfigsRange ListInstanceConfigs (ListInstanceConfigsParams)=0
 Returns a one-pass input range with all the instance configs. More...
 
virtual ListInstancesRange ListInstances (ListInstancesParams params)=0
 Returns a one-pass input range with all the instances meeting the requirements in params. More...
 
virtual StatusOr< google::iam::v1::Policy > GetIamPolicy (GetIamPolicyParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.GetIamPolicy RPC. More...
 
virtual StatusOr< google::iam::v1::Policy > SetIamPolicy (SetIamPolicyParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.SetIamPolicy RPC. More...
 
virtual StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (TestIamPermissionsParams)=0
 Define the interface for a google.spanner.v1.DatabaseAdmin.TestIamPermissions RPC. More...
 

Detailed Description

A connection to the Cloud Spanner instance administration service.

Deprecated:
Please use google::cloud::spanner_admin::InstanceAdminClient and google::cloud::spanner_admin::InstanceAdminConnection instead.

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().

Constructor & Destructor Documentation

◆ ~InstanceAdminConnection()

virtual google::cloud::spanner::InstanceAdminConnection::~InstanceAdminConnection ( )
pure virtual

Member Function Documentation

◆ CreateInstance()

virtual future< StatusOr< google::spanner::admin::instance::v1::Instance > > google::cloud::spanner::InstanceAdminConnection::CreateInstance ( CreateInstanceParams  p)
pure virtual

◆ DeleteInstance()

virtual Status google::cloud::spanner::InstanceAdminConnection::DeleteInstance ( DeleteInstanceParams  p)
pure virtual

◆ GetIamPolicy()

virtual StatusOr< google::iam::v1::Policy > google::cloud::spanner::InstanceAdminConnection::GetIamPolicy ( GetIamPolicyParams  )
pure virtual

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

◆ GetInstance()

virtual StatusOr< google::spanner::admin::instance::v1::Instance > google::cloud::spanner::InstanceAdminConnection::GetInstance ( GetInstanceParams  )
pure virtual

Return the metadata for the given instance.

◆ GetInstanceConfig()

virtual StatusOr< google::spanner::admin::instance::v1::InstanceConfig > google::cloud::spanner::InstanceAdminConnection::GetInstanceConfig ( GetInstanceConfigParams  )
pure virtual

Return the InstanceConfig with the given name.

◆ ListInstanceConfigs()

virtual ListInstanceConfigsRange google::cloud::spanner::InstanceAdminConnection::ListInstanceConfigs ( ListInstanceConfigsParams  )
pure virtual

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

◆ ListInstances()

virtual ListInstancesRange google::cloud::spanner::InstanceAdminConnection::ListInstances ( ListInstancesParams  params)
pure virtual

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

◆ options()

virtual Options google::cloud::spanner::InstanceAdminConnection::options ( )
inlinevirtual

◆ SetIamPolicy()

virtual StatusOr< google::iam::v1::Policy > google::cloud::spanner::InstanceAdminConnection::SetIamPolicy ( SetIamPolicyParams  )
pure virtual

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

◆ TestIamPermissions()

virtual StatusOr< google::iam::v1::TestIamPermissionsResponse > google::cloud::spanner::InstanceAdminConnection::TestIamPermissions ( TestIamPermissionsParams  )
pure virtual

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

◆ UpdateInstance()

virtual future< StatusOr< google::spanner::admin::instance::v1::Instance > > google::cloud::spanner::InstanceAdminConnection::UpdateInstance ( UpdateInstanceParams  p)
pure virtual