Interface InstanceAdminGrpc.AsyncService (6.82.0) 

public static interface InstanceAdminGrpc.AsyncService

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.

Methods

createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

public default void createInstance(CreateInstanceRequest request, StreamObserver<Operation> responseObserver)

Creates an instance and begins preparing it to begin serving. The returned long-running 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 will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.
Parameters
Name Description
request CreateInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createInstanceConfig(CreateInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

public default void createInstanceConfig(CreateInstanceConfigRequest request, StreamObserver<Operation> responseObserver)

Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, CreateInstanceConfig returns ALREADY_EXISTS. Immediately after the request returns:

  • The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is CREATING. While the operation is pending:
  • Cancelling the operation renders the instance configuration immediately unreadable via the API.
  • Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation:
  • Instances can be created using the instance configuration.
  • The instance configuration's reconciling field becomes false. Its state becomes READY. The returned long-running operation will have a name of the format <instance_config_name>/operations/<operation_id> and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires spanner.instanceConfigs.create permission on the resource parent.
Parameters
Name Description
request CreateInstanceConfigRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

createInstancePartition(CreateInstancePartitionRequest request, StreamObserver<Operation> responseObserver)

public default void createInstancePartition(CreateInstancePartitionRequest request, StreamObserver<Operation> responseObserver)

Creates an instance partition and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance partition. The instance partition name is assigned by the caller. If the named instance partition already exists, CreateInstancePartition returns ALREADY_EXISTS. Immediately upon completion of this request:

  • The instance partition 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 partition immediately unreadable via the API.
  • The instance partition can be deleted.
  • All other attempts to modify the instance partition 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 start using this instance partition.
  • The instance partition's allocated resource levels are readable via the API.
  • The instance partition's state becomes READY. The returned long-running operation will have a name of the format <instance_partition_name>/operations/<operation_id> and can be used to track creation of the instance partition. The metadata field type is CreateInstancePartitionMetadata. The response field type is InstancePartition, if successful.
Parameters
Name Description
request CreateInstancePartitionRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteInstance(DeleteInstanceRequest request, StreamObserver<Empty> responseObserver)

public default void deleteInstance(DeleteInstanceRequest request, StreamObserver<Empty> responseObserver)

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
Name Description
request DeleteInstanceRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteInstanceConfig(DeleteInstanceConfigRequest request, StreamObserver<Empty> responseObserver)

public default void deleteInstanceConfig(DeleteInstanceConfigRequest request, StreamObserver<Empty> responseObserver)

Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns FAILED_PRECONDITION. Only user-managed configurations can be deleted. Authorization requires spanner.instanceConfigs.delete permission on the resource name.

Parameters
Name Description
request DeleteInstanceConfigRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteInstancePartition(DeleteInstancePartitionRequest request, StreamObserver<Empty> responseObserver)

public default void deleteInstancePartition(DeleteInstancePartitionRequest request, StreamObserver<Empty> responseObserver)

Deletes an existing instance partition. Requires that the instance partition is not used by any database or backup and is not the default instance partition of an instance. Authorization requires spanner.instancePartitions.delete permission on the resource name.

Parameters
Name Description
request DeleteInstancePartitionRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public default void getIamPolicy(GetIamPolicyRequest request,