public static final class InstanceAdminGrpc.InstanceAdminFutureStub extends AbstractFutureStub<InstanceAdminGrpc.InstanceAdminFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service InstanceAdmin.
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.withOnReadyThreshold(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
|
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
createInstanceConfig(CreateInstanceConfigRequest request)
public ListenableFuture<Operation> createInstanceConfig(CreateInstanceConfigRequest request)
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Operation> |
|
createInstancePartition(CreateInstancePartitionRequest request)
public ListenableFuture<Operation> createInstancePartition(CreateInstancePartitionRequest request)
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.
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
deleteInstanceConfig(DeleteInstanceConfigRequest request)
public ListenableFuture<Empty> deleteInstanceConfig(DeleteInstanceConfigRequest request)
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<Empty> |
|
deleteInstancePartition(DeleteInstancePartitionRequest request)
public ListenableFuture<Empty> deleteInstancePartition(DeleteInstancePartitionRequest request)
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.
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.
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.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<InstanceConfig> |
|
getInstancePartition(GetInstancePartitionRequest request)
public ListenableFuture<InstancePartition> getInstancePartition(GetInstancePartitionRequest request)
Gets information about a particular instance partition.
Returns |
Type |
Description |
com.google.common.util.concurrent.ListenableFuture<InstancePartition> |
|
listInstanceConfigOperations(ListInstanceConfigOperationsRequest request)
public ListenableFuture<ListInstanceConfigOperationsResponse> listInstanceConfigOperations(ListInstanceConfigOperationsRequest request)
Lists the user-managed instance configuration long-running
operations in the given project. An instance
configuration 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.
listInstanceConfigs(ListInstanceConfigsRequest request)
public ListenableFuture<ListInstanceConfigsResponse> listInstanceConfigs(ListInstanceConfigsRequest request)
Lists the supported instance configurations for a given project.
listInstancePartitionOperations(ListInstancePartitionOperationsRequest request)
public ListenableFuture<ListInstancePartitionOperationsResponse> listInstancePartitionOperations(ListInstancePartitionOperationsRequest request)
Lists instance partition long-running
operations in the given instance.
An instance partition operation has a name of the form
projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/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.
Authorization requires spanner.instancePartitionOperations.list
permission on the resource
parent.
listInstancePartitions(ListInstancePartitionsRequest request)
public ListenableFuture<ListInstancePartitionsResponse> listInstancePartitions(ListInstancePartitionsRequest request)
Lists all instance partitions for the given instance.
listInstances(ListInstancesRequest request)
public ListenableFuture<ListInstancesResponse> listInstances(ListInstancesRequest request)
Lists all instances in the given project.
moveInstance(MoveInstanceRequest request)
public ListenableFuture<Operation> moveInstance(MoveInstanceRequest request)
Moves an instance to the target instance configuration. You can use the
returned long-running operation to track
the