Package com.google.spanner.admin.instance.v1

Interface InstanceAdminGrpc.AsyncService

All Known Implementing Classes:
InstanceAdminGrpc.InstanceAdminImplBase
Enclosing class:
InstanceAdminGrpc
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.

  • Method Details

    • listInstanceConfigs

      default void listInstanceConfigs(ListInstanceConfigsRequest request, io.grpc.stub.StreamObserver<ListInstanceConfigsResponse> responseObserver)
       Lists the supported instance configurations for a given project.
 Returns both Google-managed configurations and user-managed
 configurations.

    • getInstanceConfig

      default void getInstanceConfig(GetInstanceConfigRequest request, io.grpc.stub.StreamObserver<InstanceConfig> responseObserver)
       Gets information about a particular instance configuration.

    • createInstanceConfig

      default void createInstanceConfig(CreateInstanceConfigRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.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][google.spanner.admin.instance.v1.InstanceConfig.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][google.spanner.admin.instance.v1.InstanceConfig.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][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
 The response field type is
 [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
 successful.
 Authorization requires `spanner.instanceConfigs.create` permission on
 the resource
 [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].

    • updateInstanceConfig

      default void updateInstanceConfig(UpdateInstanceConfigRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       Updates an instance configuration. The returned
 long-running operation can be used to track
 the progress of updating the instance. If the named instance configuration
 does not exist, returns `NOT_FOUND`.
 Only user-managed configurations can be updated.
 Immediately after the request returns:
   * The instance configuration's
     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
     field is set to true.
 While the operation is pending:
   * Cancelling the operation sets its metadata's
     [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
     The operation is guaranteed to succeed at undoing all changes, after
     which point it terminates with a `CANCELLED` status.
   * All other attempts to modify the instance configuration are rejected.
   * Reading the instance configuration 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 new values of the instance configuration are readable via the API.
   * The instance configuration's
   [reconciling][google.spanner.admin.instance.v1.InstanceConfig.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 configuration modification.  The
 metadata field type is
 [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
 The response field type is
 [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
 successful.
 Authorization requires `spanner.instanceConfigs.update` permission on
 the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].

    • deleteInstanceConfig

      default void deleteInstanceConfig(DeleteInstanceConfigRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.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][google.spanner.admin.instance.v1.InstanceConfig.name].

    • listInstanceConfigOperations

      default void listInstanceConfigOperations(ListInstanceConfigOperationsRequest request, io.grpc.stub.StreamObserver<ListInstanceConfigOperationsResponse> responseObserver)
       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.

    • listInstances

      default void listInstances(ListInstancesRequest request, io.grpc.stub.StreamObserver<ListInstancesResponse> responseObserver)
       Lists all instances in the given project.

    • listInstancePartitions

      default void listInstancePartitions(ListInstancePartitionsRequest request, io.grpc.stub.StreamObserver<ListInstancePartitionsResponse> responseObserver)
       Lists all instance partitions for the given instance.

    • getInstance

      default void getInstance(GetInstanceRequest request, io.grpc.stub.StreamObserver<Instance> responseObserver)
       Gets information about a particular instance.

    • createInstance

      default void createInstance(CreateInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.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][google.spanner.admin.instance.v1.CreateInstanceMetadata].
 The response field type is
 [Instance][google.spanner.admin.instance.v1.Instance], if successful.

    • updateInstance

      default void updateInstance(UpdateInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.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][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 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][google.spanner.admin.instance.v1.UpdateInstanceMetadata].
 The response field type is
 [Instance][google.spanner.admin.instance.v1.Instance], if successful.
 Authorization requires `spanner.instances.update` permission on
 the resource [name][google.spanner.admin.instance.v1.Instance.name].

    • deleteInstance

      default void deleteInstance(DeleteInstanceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.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

      default void setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.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

      default void getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.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

      default void testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.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.

    • getInstancePartition

      default void getInstancePartition(GetInstancePartitionRequest request, io.grpc.stub.StreamObserver<InstancePartition> responseObserver)
       Gets information about a particular instance partition.

    • createInstancePartition

      default void createInstancePartition(CreateInstancePartitionRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.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][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata].
 The response field type is
 [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if
 successful.

    • deleteInstancePartition

      default void deleteInstancePartition(DeleteInstancePartitionRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.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][google.spanner.admin.instance.v1.InstancePartition.name].

    • updateInstancePartition

      default void updateInstancePartition(UpdateInstancePartitionRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       Updates an instance partition, and begins allocating or releasing resources
 as requested. The returned long-running operation can be used to track the
 progress of updating the instance partition. If the named instance
 partition does not exist, returns `NOT_FOUND`.
 Immediately upon completion of this request:
   * For resource types for which a decrease in the instance partition'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.UpdateInstancePartitionMetadata.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 partition are rejected.
   * Reading the instance partition 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
     partition's tables.
   * The instance partition's new resource levels are readable via the API.
 The returned long-running operation will
 have a name of the format
 `<instance_partition_name>/operations/<operation_id>` and can be used to
 track the instance partition modification. The
 metadata field type is
 [UpdateInstancePartitionMetadata][google.spanner.admin.instance.v1.UpdateInstancePartitionMetadata].
 The response field type is
 [InstancePartition][google.spanner.admin.instance.v1.InstancePartition], if
 successful.
 Authorization requires `spanner.instancePartitions.update` permission on
 the resource
 [name][google.spanner.admin.instance.v1.InstancePartition.name].

    • listInstancePartitionOperations

      default void listInstancePartitionOperations(ListInstancePartitionOperationsRequest request, io.grpc.stub.StreamObserver<ListInstancePartitionOperationsResponse> responseObserver)
       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][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.parent].

    • moveInstance

      default void moveInstance(MoveInstanceRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
       Moves an instance to the target instance configuration. You can use the
 returned long-running operation to track
 the progress of moving the instance.
 `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of
 the following criteria:
   * Is undergoing a move to a different instance configuration
   * Has backups
   * Has an ongoing update
   * Contains any CMEK-enabled databases
   * Is a free trial instance
 While the operation is pending:
   * All other attempts to modify the instance, including changes to its
     compute capacity, are rejected.
   * The following database and backup admin operations are rejected:
     * `DatabaseAdmin.CreateDatabase`
     * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is
        specified in the request.)
     * `DatabaseAdmin.RestoreDatabase`
     * `DatabaseAdmin.CreateBackup`
     * `DatabaseAdmin.CopyBackup`
   * Both the source and target instance configurations are subject to
     hourly compute and storage charges.
   * The instance might experience higher read-write latencies and a higher
     transaction abort rate. However, moving an instance doesn't cause any
     downtime.
 The returned long-running operation has
 a name of the format
 `<instance_name>/operations/<operation_id>` and can be used to track
 the move instance operation. The
 metadata field type is
 [MoveInstanceMetadata][google.spanner.admin.instance.v1.MoveInstanceMetadata].
 The response field type is
 [Instance][google.spanner.admin.instance.v1.Instance],
 if successful.
 Cancelling the operation sets its metadata's
 [cancel_time][google.spanner.admin.instance.v1.MoveInstanceMetadata.cancel_time].
 Cancellation is not immediate because it involves moving any data
 previously moved to the target instance configuration back to the original
 instance configuration. You can use this operation to track the progress of
 the cancellation. Upon successful completion of the cancellation, the
 operation terminates with `CANCELLED` status.
 If not cancelled, upon completion of the returned operation:
   * The instance successfully moves to the target instance
     configuration.
   * You are billed for compute and storage in target instance
   configuration.
 Authorization requires the `spanner.instances.update` permission on
 the resource [instance][google.spanner.admin.instance.v1.Instance].
 For more details, see
 [Move an instance](https://cloud.google.com/spanner/docs/move-instance).