Google Cloud Spanner C++ Client  1.35.0
A C++ Client Library for Google Cloud Spanner
Public Member Functions | Friends | List of all members
google::cloud::spanner_admin::InstanceAdminClient Class Reference

Cloud Spanner Instance Admin API. More...

#include <google/cloud/spanner/admin/instance_admin_client.h>

Public Member Functions

 InstanceAdminClient (std::shared_ptr< InstanceAdminConnection > connection, Options options={})
 
 ~InstanceAdminClient ()
 
 InstanceAdminClient (InstanceAdminClient const &)=default
 
InstanceAdminClientoperator= (InstanceAdminClient const &)=default
 
 InstanceAdminClient (InstanceAdminClient &&)=default
 
InstanceAdminClientoperator= (InstanceAdminClient &&)=default
 
StreamRange< google::spanner::admin::instance::v1::InstanceConfig > ListInstanceConfigs (std::string const &parent, Options options={})
 Lists the supported instance configurations for a given project. More...
 
StreamRange< google::spanner::admin::instance::v1::InstanceConfig > ListInstanceConfigs (google::spanner::admin::instance::v1::ListInstanceConfigsRequest request, Options options={})
 Lists the supported instance configurations for a given project. More...
 
StatusOr< google::spanner::admin::instance::v1::InstanceConfig > GetInstanceConfig (std::string const &name, Options options={})
 Gets information about a particular instance configuration. More...
 
StatusOr< google::spanner::admin::instance::v1::InstanceConfig > GetInstanceConfig (google::spanner::admin::instance::v1::GetInstanceConfigRequest const &request, Options options={})
 Gets information about a particular instance configuration. More...
 
StreamRange< google::spanner::admin::instance::v1::Instance > ListInstances (std::string const &parent, Options options={})
 Lists all instances in the given project. More...
 
StreamRange< google::spanner::admin::instance::v1::Instance > ListInstances (google::spanner::admin::instance::v1::ListInstancesRequest request, Options options={})
 Lists all instances in the given project. More...
 
StatusOr< google::spanner::admin::instance::v1::Instance > GetInstance (std::string const &name, Options options={})
 Gets information about a particular instance. More...
 
StatusOr< google::spanner::admin::instance::v1::Instance > GetInstance (google::spanner::admin::instance::v1::GetInstanceRequest const &request, Options options={})
 Gets information about a particular instance. More...
 
future< StatusOr< google::spanner::admin::instance::v1::Instance > > CreateInstance (std::string const &parent, std::string const &instance_id, google::spanner::admin::instance::v1::Instance const &instance, Options options={})
 Creates an instance and begins preparing it to begin serving. More...
 
future< StatusOr< google::spanner::admin::instance::v1::Instance > > CreateInstance (google::spanner::admin::instance::v1::CreateInstanceRequest const &request, Options options={})
 Creates an instance and begins preparing it to begin serving. More...
 
future< StatusOr< google::spanner::admin::instance::v1::Instance > > UpdateInstance (google::spanner::admin::instance::v1::Instance const &instance, google::protobuf::FieldMask const &field_mask, Options options={})
 Updates an instance, and begins allocating or releasing resources as requested. More...
 
future< StatusOr< google::spanner::admin::instance::v1::Instance > > UpdateInstance (google::spanner::admin::instance::v1::UpdateInstanceRequest const &request, Options options={})
 Updates an instance, and begins allocating or releasing resources as requested. More...
 
Status DeleteInstance (std::string const &name, Options options={})
 Deletes an instance. More...
 
Status DeleteInstance (google::spanner::admin::instance::v1::DeleteInstanceRequest const &request, Options options={})
 Deletes an instance. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, google::iam::v1::Policy const &policy, Options options={})
 Sets the access control policy on an instance resource. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (std::string const &resource, IamUpdater const &updater, Options options={})
 Updates the IAM policy for resource using an optimistic concurrency control loop. More...
 
StatusOr< google::iam::v1::Policy > SetIamPolicy (google::iam::v1::SetIamPolicyRequest const &request, Options options={})
 Sets the access control policy on an instance resource. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (std::string const &resource, Options options={})
 Gets the access control policy for an instance resource. More...
 
StatusOr< google::iam::v1::Policy > GetIamPolicy (google::iam::v1::GetIamPolicyRequest const &request, Options options={})
 Gets the access control policy for an instance resource. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (std::string const &resource, std::vector< std::string > const &permissions, Options options={})
 Returns permissions that the caller has on the specified instance resource. More...
 
StatusOr< google::iam::v1::TestIamPermissionsResponse > TestIamPermissions (google::iam::v1::TestIamPermissionsRequest const &request, Options options={})
 Returns permissions that the caller has on the specified instance resource. More...
 

Friends

bool operator== (InstanceAdminClient const &a, InstanceAdminClient const &b)
 
bool operator!= (InstanceAdminClient const &a, InstanceAdminClient const &b)
 

Detailed Description

Cloud Spanner Instance Admin API.

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Definition at line 84 of file instance_admin_client.h.

Constructor & Destructor Documentation

◆ InstanceAdminClient() [1/3]

google::cloud::spanner_admin::InstanceAdminClient::InstanceAdminClient ( std::shared_ptr< InstanceAdminConnection connection,
Options  options = {} 
)
explicit

◆ ~InstanceAdminClient()

google::cloud::spanner_admin::InstanceAdminClient::~InstanceAdminClient ( )

◆ InstanceAdminClient() [2/3]

google::cloud::spanner_admin::InstanceAdminClient::InstanceAdminClient ( InstanceAdminClient const &  )
default

◆ InstanceAdminClient() [3/3]

google::cloud::spanner_admin::InstanceAdminClient::InstanceAdminClient ( InstanceAdminClient &&  )
default

Member Function Documentation

◆ CreateInstance() [1/2]

future<StatusOr<google::spanner::admin::instance::v1::Instance> > google::cloud::spanner_admin::InstanceAdminClient::CreateInstance ( google::spanner::admin::instance::v1::CreateInstanceRequest const &  request,
Options  options = {} 
)

Creates an instance and begins preparing it to begin serving.

The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS.

Immediately upon completion of this request:

  • The instance is readable via the API, with all requested attributes but no allocated resources. Its state is CREATING.

Until completion of the returned operation:

  • Cancelling the operation renders the instance immediately unreadable via the API.
  • The instance can be deleted.
  • All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

  • Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
  • Databases can be created in the instance.
  • The instance's allocated resource levels are readable via the API.
  • The instance's state becomes READY.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is Instance, if successful.

Parameters
requestgoogle::spanner::admin::instance::v1::CreateInstanceRequest
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ CreateInstance() [2/2]

future<StatusOr<google::spanner::admin::instance::v1::Instance> > google::cloud::spanner_admin::InstanceAdminClient::CreateInstance ( std::string const &  parent,
std::string const &  instance_id,
google::spanner::admin::instance::v1::Instance const &  instance,
Options  options = {} 
)

Creates an instance and begins preparing it to begin serving.

The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS.

Immediately upon completion of this request:

  • The instance is readable via the API, with all requested attributes but no allocated resources. Its state is CREATING.

Until completion of the returned operation:

  • Cancelling the operation renders the instance immediately unreadable via the API.
  • The instance can be deleted.
  • All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

  • Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
  • Databases can be created in the instance.
  • The instance's allocated resource levels are readable via the API.
  • The instance's state becomes READY.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The [metadata][google.longrunning.Operation.metadata] field type is [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is Instance, if successful.

Parameters
parentRequired. The name of the project in which to create the instance. Values are of the form projects/<project>.
instance_idRequired. The ID of the instance to create. Valid identifiers are of the form [a-z][-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length.
instanceRequired. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>.
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ DeleteInstance() [1/2]

Status google::cloud::spanner_admin::InstanceAdminClient::DeleteInstance ( google::spanner::admin::instance::v1::DeleteInstanceRequest const &  request,
Options  options = {} 
)

Deletes an instance.

Immediately upon completion of the request:

  • Billing ceases for all of the instance's reserved resources.

Soon afterward:

  • The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
Parameters
requestgoogle::spanner::admin::instance::v1::DeleteInstanceRequest
optionsOptional. Operation options.

◆ DeleteInstance() [2/2]

Status google::cloud::spanner_admin::InstanceAdminClient::DeleteInstance ( std::string const &  name,
Options  options = {} 
)

Deletes an instance.

Immediately upon completion of the request:

  • Billing ceases for all of the instance's reserved resources.

Soon afterward:

  • The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.
Parameters
nameRequired. The name of the instance to be deleted. Values are of the form projects/<project>/instances/<instance>
optionsOptional. Operation options.

◆ GetIamPolicy() [1/2]

StatusOr<google::iam::v1::Policy> google::cloud::spanner_admin::InstanceAdminClient::GetIamPolicy ( google::iam::v1::GetIamPolicyRequest const &  request,
Options  options = {} 
)

Gets the access control policy for an instance resource.

Returns an empty policy if an instance exists but does not have a policy set.

Authorization requires spanner.instances.getIamPolicy on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
requestgoogle::iam::v1::GetIamPolicyRequest
optionsOptional. Operation options.
Returns
google::iam::v1::Policy

◆ GetIamPolicy() [2/2]

StatusOr<google::iam::v1::Policy> google::cloud::spanner_admin::InstanceAdminClient::GetIamPolicy ( std::string const &  resource,
Options  options = {} 
)

Gets the access control policy for an instance resource.

Returns an empty policy if an instance exists but does not have a policy set.

Authorization requires spanner.instances.getIamPolicy on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Parameters
resourceREQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
optionsOptional. Operation options.
Returns
google::iam::v1::Policy

◆ GetInstance() [1/2]

StatusOr<google::spanner::admin::instance::v1::Instance> google::cloud::spanner_admin::InstanceAdminClient::GetInstance ( google::spanner::admin::instance::v1::GetInstanceRequest const &  request,
Options  options = {} 
)

Gets information about a particular instance.

Parameters
requestgoogle::spanner::admin::instance::v1::GetInstanceRequest
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ GetInstance() [2/2]

StatusOr<google::spanner::admin::instance::v1::Instance> google::cloud::spanner_admin::InstanceAdminClient::GetInstance ( std::string const &  name,
Options  options = {} 
)

Gets information about a particular instance.

Parameters
nameRequired. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ GetInstanceConfig() [1/2]

StatusOr<google::spanner::admin::instance::v1::InstanceConfig> google::cloud::spanner_admin::InstanceAdminClient::GetInstanceConfig ( google::spanner::admin::instance::v1::GetInstanceConfigRequest const &  request,
Options  options = {} 
)

Gets information about a particular instance configuration.

Parameters
requestgoogle::spanner::admin::instance::v1::GetInstanceConfigRequest
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::InstanceConfig

◆ GetInstanceConfig() [2/2]

StatusOr<google::spanner::admin::instance::v1::InstanceConfig> google::cloud::spanner_admin::InstanceAdminClient::GetInstanceConfig ( std::string const &  name,
Options  options = {} 
)

Gets information about a particular instance configuration.

Parameters
nameRequired. The name of the requested instance configuration. Values are of the form projects/<project>/instanceConfigs/<config>.
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::InstanceConfig

◆ ListInstanceConfigs() [1/2]

StreamRange<google::spanner::admin::instance::v1::InstanceConfig> google::cloud::spanner_admin::InstanceAdminClient::ListInstanceConfigs ( google::spanner::admin::instance::v1::ListInstanceConfigsRequest  request,
Options  options = {} 
)

Lists the supported instance configurations for a given project.

Parameters
requestgoogle::spanner::admin::instance::v1::ListInstanceConfigsRequest
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::InstanceConfig

◆ ListInstanceConfigs() [2/2]

StreamRange<google::spanner::admin::instance::v1::InstanceConfig> google::cloud::spanner_admin::InstanceAdminClient::ListInstanceConfigs ( std::string const &  parent,
Options  options = {} 
)

Lists the supported instance configurations for a given project.

Parameters
parentRequired. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::InstanceConfig

◆ ListInstances() [1/2]

StreamRange<google::spanner::admin::instance::v1::Instance> google::cloud::spanner_admin::InstanceAdminClient::ListInstances ( google::spanner::admin::instance::v1::ListInstancesRequest  request,
Options  options = {} 
)

Lists all instances in the given project.

Parameters
requestgoogle::spanner::admin::instance::v1::ListInstancesRequest
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ ListInstances() [2/2]

StreamRange<google::spanner::admin::instance::v1::Instance> google::cloud::spanner_admin::InstanceAdminClient::ListInstances ( std::string const &  parent,
Options  options = {} 
)

Lists all instances in the given project.

Parameters
parentRequired. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ operator=() [1/2]

InstanceAdminClient& google::cloud::spanner_admin::InstanceAdminClient::operator= ( InstanceAdminClient &&  )
default

◆ operator=() [2/2]

InstanceAdminClient& google::cloud::spanner_admin::InstanceAdminClient::operator= ( InstanceAdminClient const &  )
default

◆ SetIamPolicy() [1/3]

StatusOr<google::iam::v1::Policy> google::cloud::spanner_admin::InstanceAdminClient::SetIamPolicy ( google::iam::v1::SetIamPolicyRequest const &  request,
Options  options = {} 
)

Sets the access control policy on an instance resource.

Replaces any existing policy.

Authorization requires spanner.instances.setIamPolicy on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Parameters
requestgoogle::iam::v1::SetIamPolicyRequest
optionsOptional. Operation options.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [2/3]

StatusOr<google::iam::v1::Policy> google::cloud::spanner_admin::InstanceAdminClient::SetIamPolicy ( std::string const &  resource,
google::iam::v1::Policy const &  policy,
Options  options = {} 
)

Sets the access control policy on an instance resource.

Replaces any existing policy.

Authorization requires spanner.instances.setIamPolicy on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Parameters
resourceREQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
policyREQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
optionsOptional. Operation options.
Returns
google::iam::v1::Policy

◆ SetIamPolicy() [3/3]

StatusOr<google::iam::v1::Policy> google::cloud::spanner_admin::InstanceAdminClient::SetIamPolicy ( std::string const &  resource,
IamUpdater const &  updater,
Options  options = {} 
)

Updates the IAM policy for resource using an optimistic concurrency control loop.

The loop fetches the current policy for resource, and passes it to updater, which should return the new policy. This new policy should use the current etag so that the read-modify-write cycle can detect races and rerun the update when there is a mismatch. If the new policy does not have an etag, the existing policy will be blindly overwritten. If updater does not yield a policy, the control loop is terminated and kCancelled is returned.

Parameters
resourceRequired. The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
updaterRequired. Functor to map the current policy to a new one.
optionsOptional. Options to control the loop. Expected options are:
Returns
google::iam::v1::Policy

◆ TestIamPermissions() [1/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::spanner_admin::InstanceAdminClient::TestIamPermissions ( google::iam::v1::TestIamPermissionsRequest const &  request,
Options  options = {} 
)

Returns permissions that the caller has on the specified instance resource.

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Parameters
requestgoogle::iam::v1::TestIamPermissionsRequest
optionsOptional. Operation options.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ TestIamPermissions() [2/2]

StatusOr<google::iam::v1::TestIamPermissionsResponse> google::cloud::spanner_admin::InstanceAdminClient::TestIamPermissions ( std::string const &  resource,
std::vector< std::string > const &  permissions,
Options  options = {} 
)

Returns permissions that the caller has on the specified instance resource.

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Parameters
resourceREQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissionsThe set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
optionsOptional. Operation options.
Returns
google::iam::v1::TestIamPermissionsResponse

◆ UpdateInstance() [1/2]

future<StatusOr<google::spanner::admin::instance::v1::Instance> > google::cloud::spanner_admin::InstanceAdminClient::UpdateInstance ( google::spanner::admin::instance::v1::Instance const &  instance,
google::protobuf::FieldMask const &  field_mask,
Options  options = {} 
)

Updates an instance, and begins allocating or releasing resources as requested.

The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND.

Immediately upon completion of this request:

  • For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

  • Cancelling the operation sets its metadata's [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status.
  • All other attempts to modify the instance are rejected.
  • Reading the instance via the API continues to give the pre-request resource levels.

Upon completion of the returned operation:

  • Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
  • All newly-reserved resources are available for serving the instance's tables.
  • The instance's new resource levels are readable via the API.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is Instance, if successful.

Authorization requires spanner.instances.update permission on resource [name][google.spanner.admin.instance.v1.Instance.name].

Parameters
instanceRequired. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
field_maskRequired. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them.
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

◆ UpdateInstance() [2/2]

future<StatusOr<google::spanner::admin::instance::v1::Instance> > google::cloud::spanner_admin::InstanceAdminClient::UpdateInstance ( google::spanner::admin::instance::v1::UpdateInstanceRequest const &  request,
Options  options = {} 
)

Updates an instance, and begins allocating or releasing resources as requested.

The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND.

Immediately upon completion of this request:

  • For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

  • Cancelling the operation sets its metadata's [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time], and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status.
  • All other attempts to modify the instance are rejected.
  • Reading the instance via the API continues to give the pre-request resource levels.

Upon completion of the returned operation:

  • Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
  • All newly-reserved resources are available for serving the instance's tables.
  • The instance's new resource levels are readable via the API.

The returned [long-running operation][google.longrunning.Operation] will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata]. The [response][google.longrunning.Operation.response] field type is Instance, if successful.

Authorization requires spanner.instances.update permission on resource [name][google.spanner.admin.instance.v1.Instance.name].

Parameters
requestgoogle::spanner::admin::instance::v1::UpdateInstanceRequest
optionsOptional. Operation options.
Returns
google::spanner::admin::instance::v1::Instance

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( InstanceAdminClient const &  a,
InstanceAdminClient const &  b 
)
friend

Definition at line 105 of file instance_admin_client.h.

◆ operator==

bool operator== ( InstanceAdminClient const &  a,
InstanceAdminClient const &  b 
)
friend

Definition at line 101 of file instance_admin_client.h.