com.google.spanner.admin.instance.v1

Class InstanceAdminGrpc.InstanceAdminStub

java.lang.Object

io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminStub>

com.google.spanner.admin.instance.v1.InstanceAdminGrpc.InstanceAdminStub

Enclosing class:

InstanceAdminGrpc

public static final class InstanceAdminGrpc.InstanceAdminStub
extends io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminStub>

 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.
 

Method Summary

Modifier and Type	Method and Description
protected InstanceAdminGrpc.InstanceAdminStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
void	createInstance(CreateInstanceRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Creates an instance and begins preparing it to begin serving.
void	deleteInstance(DeleteInstanceRequest request, io.grpc.stub.StreamObserver<Empty> responseObserver) Deletes an instance.
void	getIamPolicy(GetIamPolicyRequest request, io.grpc.stub.StreamObserver<Policy> responseObserver) Gets the access control policy for an instance resource.
void	getInstance(GetInstanceRequest request, io.grpc.stub.StreamObserver<Instance> responseObserver) Gets information about a particular instance.
void	getInstanceConfig(GetInstanceConfigRequest request, io.grpc.stub.StreamObserver<InstanceConfig> responseObserver) Gets information about a particular instance configuration.
void	listInstanceConfigs(ListInstanceConfigsRequest request, io.grpc.stub.StreamObserver<ListInstanceConfigsResponse> responseObserver) Lists the supported instance configurations for a given project.
void	listInstances(ListInstancesRequest request, io.grpc.stub.StreamObserver<ListInstancesResponse> responseObserver) Lists all instances in the given project.
void	setIamPolicy(SetIamPolicyRequest request, io.grpc.stub.StreamObserver<Policy> responseObserver) Sets the access control policy on an instance resource.
void	testIamPermissions(TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<TestIamPermissionsResponse> responseObserver) Returns permissions that the caller has on the specified instance resource.
void	updateInstance(UpdateInstanceRequest request, io.grpc.stub.StreamObserver<Operation> responseObserver) Updates an instance, and begins allocating or releasing resources as requested.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected InstanceAdminGrpc.InstanceAdminStub build(io.grpc.Channel channel,
                                                    io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<InstanceAdminGrpc.InstanceAdminStub>

listInstanceConfigs

public void listInstanceConfigs(ListInstanceConfigsRequest request,
                                io.grpc.stub.StreamObserver<ListInstanceConfigsResponse> responseObserver)

 Lists the supported instance configurations for a given project.
 

getInstanceConfig

public void getInstanceConfig(GetInstanceConfigRequest request,
                              io.grpc.stub.StreamObserver<InstanceConfig> responseObserver)

 Gets information about a particular instance configuration.
 

listInstances

public void listInstances(ListInstancesRequest request,
                          io.grpc.stub.StreamObserver<ListInstancesResponse> responseObserver)

 Lists all instances in the given project.
 

getInstance

public void getInstance(GetInstanceRequest request,
                        io.grpc.stub.StreamObserver<Instance> responseObserver)

 Gets information about a particular instance.
 

createInstance

public void createInstance(CreateInstanceRequest request,
                           io.grpc.stub.StreamObserver<Operation> responseObserver)

 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][google.spanner.admin.instance.v1.Instance], if successful.
 

updateInstance

public void updateInstance(UpdateInstanceRequest request,
                           io.grpc.stub.StreamObserver<Operation> responseObserver)

 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][google.spanner.admin.instance.v1.Instance], if successful.
 Authorization requires `spanner.instances.update` permission on
 resource [name][google.spanner.admin.instance.v1.Instance.name].
 

deleteInstance

public void deleteInstance(DeleteInstanceRequest request,
                           io.grpc.stub.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.
 

setIamPolicy

public void setIamPolicy(SetIamPolicyRequest request,
                         io.grpc.stub.StreamObserver<Policy> responseObserver)

 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].
 

getIamPolicy

public void getIamPolicy(GetIamPolicyRequest request,
                         io.grpc.stub.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][google.iam.v1.GetIamPolicyRequest.resource].
 

testIamPermissions

public void testIamPermissions(TestIamPermissionsRequest request,
                               io.grpc.stub.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.