public static interface InstanceAdminGrpc.AsyncServiceCloud 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 config and begins preparing it to be used. The
returned long-running operation
can be used to track the progress of preparing the new
instance config. The instance config name is assigned by the caller. If the
named instance config already exists, CreateInstanceConfig returns
ALREADY_EXISTS.
Immediately after the request returns:
- The instance config is readable via the API, with all requested
attributes. The instance config's
reconciling
field is set to true. Its state is
CREATING. While the operation is pending: - Cancelling the operation renders the instance config immediately unreadable via the API.
- Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation:
- Instances can be created using the instance configuration.
- The instance config'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 config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requiresspanner.instanceConfigs.createpermission on the resource parent.
| Parameters | |
|---|---|
| Name | Description |
request | CreateInstanceConfigRequest |
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 config. Deletion is only allowed when no
instances are using the configuration. If any instances are using
the config, 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> |
getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)
public default void getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver) 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.
| Parameters | |
|---|---|
| Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest |
responseObserver | io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> |
getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)
public default void getInstance(GetInstanceRequest request, StreamObserver<Instance> responseObserver)Gets information about a particular instance.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceRequest |
responseObserver | io.grpc.stub.StreamObserver<Instance> |
getInstanceConfig(GetInstanceConfigRequest request, StreamObserver<InstanceConfig> responseObserver)
public default void getInstanceConfig(GetInstanceConfigRequest request, StreamObserver<InstanceConfig> responseObserver)Gets information about a particular instance configuration.
| Parameters | |
|---|---|
| Name | Description |
request | GetInstanceConfigRequest |
responseObserver | io.grpc.stub.StreamObserver<InstanceConfig> |
listInstanceConfigOperations(ListInstanceConfigOperationsRequest request, StreamObserver<ListInstanceConfigOperationsResponse> responseObserver)
public default void listInstanceConfigOperations(ListInstanceConfigOperationsRequest request, StreamObserver<ListInstanceConfigOperationsResponse> responseObserver) Lists the user-managed instance config long-running
operations in the given project. An instance
config operation has a name of the form
projects/<project>/instanceConfigs/<instance_config>/operations/<operation>.
The long-running operation
metadata field type
metadata.type_url describes the type of the metadata. Operations returned
include those that have completed/failed/canceled within the last 7 days,
and pending operations. Operations returned are ordered by
operation.metadata.value.start_time in descending order starting
from the most recently started operation.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceConfigOperationsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListInstanceConfigOperationsResponse> |
listInstanceConfigs(ListInstanceConfigsRequest request, StreamObserver<ListInstanceConfigsResponse> responseObserver)
public default void listInstanceConfigs(ListInstanceConfigsRequest request, StreamObserver<ListInstanceConfigsResponse> responseObserver)Lists the supported instance configurations for a given project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstanceConfigsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListInstanceConfigsResponse> |
listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)
public default void listInstances(ListInstancesRequest request, StreamObserver<ListInstancesResponse> responseObserver)Lists all instances in the given project.
| Parameters | |
|---|---|
| Name | Description |
request | ListInstancesRequest |
responseObserver | io.grpc.stub.StreamObserver<ListInstancesResponse> |
setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)
public default void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver) Sets the access control policy on an instance resource. Replaces any
existing policy.
Authorization requires spanner.instances.setIamPolicy on
resource.
| Parameters | |
|---|---|
| Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest |
responseObserver | io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> |
testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)
public default void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver) 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 | |
|---|---|
| Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest |
responseObserver | io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> |
updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver)
public default void updateInstance(UpdateInstanceRequest request, StreamObserver<Operation> responseObserver) Updates an instance, and begins allocating or releasing resources
as requested. The returned long-running
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,
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
CANCELLEDstatus. - 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 will
have a name of the format
<instance_name>/operations/<operation_id>and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requiresspanner.instances.updatepermission on the resource name.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |
updateInstanceConfig(UpdateInstanceConfigRequest request, StreamObserver<Operation> responseObserver)
public default void updateInstanceConfig(UpdateInstanceConfigRequest request, StreamObserver<Operation> responseObserver) Updates an instance config. The returned
long-running operation can be used to track
the progress of updating the instance. If the named instance config does
not exist, returns NOT_FOUND.
Only user managed configurations can be updated.
Immediately after the request returns:
- The instance config's reconciling field is set to true. While the operation is pending:
- Cancelling the operation sets its metadata's
cancel_time.
The operation is guaranteed to succeed at undoing all changes, after
which point it terminates with a
CANCELLEDstatus. - All other attempts to modify the instance config are rejected.
- Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation:
- Creating instances using the instance configuration uses the new values.
- The instance config's new values are readable via the API.
- The instance config's
reconciling
field becomes false.
The returned long-running operation will
have a name of the format
<instance_config_name>/operations/<operation_id>and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requiresspanner.instanceConfigs.updatepermission on the resource name.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateInstanceConfigRequest |
responseObserver | io.grpc.stub.StreamObserver<Operation> |