public static final class InstanceAdminGrpc.InstanceAdminFutureStub extends AbstractFutureStub<InstanceAdminGrpc.InstanceAdminFutureStub>
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.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
InstanceAdminGrpc.InstanceAdminFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected InstanceAdminGrpc.InstanceAdminFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
createInstance(CreateInstanceRequest request)
public ListenableFuture<Operation> createInstance(CreateInstanceRequest request)
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.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |
deleteInstance(DeleteInstanceRequest request)
public ListenableFuture<Empty> deleteInstance(DeleteInstanceRequest request)
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.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
getIamPolicy(GetIamPolicyRequest request)
public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)
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.
Parameter
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest
|
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> | |
getInstance(GetInstanceRequest request)
public ListenableFuture<Instance> getInstance(GetInstanceRequest request)
Gets information about a particular instance.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Instance> | |
getInstanceConfig(GetInstanceConfigRequest request)
public ListenableFuture<InstanceConfig> getInstanceConfig(GetInstanceConfigRequest request)
Gets information about a particular instance configuration.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<InstanceConfig> | |
listInstanceConfigs(ListInstanceConfigsRequest request)
public ListenableFuture<ListInstanceConfigsResponse> listInstanceConfigs(ListInstanceConfigsRequest request)
Lists the supported instance configurations for a given project.
Parameter
Returns
listInstances(ListInstancesRequest request)
public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)
Lists all instances in the given project.
Parameter
Returns
setIamPolicy(SetIamPolicyRequest request)
public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on an instance resource. Replaces any
existing policy.
Authorization requires spanner.instances.setIamPolicy
on
resource.
Parameter
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest
|
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy> | |
testIamPermissions(TestIamPermissionsRequest request)
public ListenableFuture<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request)
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.
Parameter
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest
|
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.TestIamPermissionsResponse> | |
updateInstance(UpdateInstanceRequest request)
public ListenableFuture<Operation> updateInstance(UpdateInstanceRequest request)
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
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 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 requires spanner.instances.update
permission on
resource name.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Operation> | |