package google.spanner.admin.instance.v1
Get desktop application:
View/edit binary Protocol Buffers messages
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.
Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.
The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
string parent = 1
Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/<project>`.
int32 page_size = 2
Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
string page_token = 3
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token] from a previous [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse].
The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
repeated instance_configs = 1
The list of requested instance configurations.
string next_page_token = 2
`next_page_token` can be sent in a subsequent [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs] call to fetch more of the matching instance configurations.
Gets information about a particular instance configuration.
The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
string name = 1
Required. The name of the requested instance configuration. Values are of the form `projects/<project>/instanceConfigs/<config>`.
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].
The request for [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig].
string parent = 1
Required. The name of the project in which to create the instance configuration. Values are of the form `projects/<project>`.
string instance_config_id = 2
Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations.
optional instance_config = 3
Required. The `InstanceConfig` proto of the configuration to create. `instance_config.name` must be `<parent>/instanceConfigs/<instance_config_id>`. `instance_config.base_config` must be a Google-managed configuration name, e.g. <parent>/instanceConfigs/us-east1, <parent>/instanceConfigs/nam3.
bool validate_only = 4
An option to validate, but not actually execute, a request, and provide the same response.
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].
The request for [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig].
optional instance_config = 1
Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in [update_mask][google.spanner.admin.instance.v1.UpdateInstanceConfigRequest.update_mask] need be included. To prevent conflicts of concurrent updates, [etag][google.spanner.admin.instance.v1.InstanceConfig.reconciling] can be used.
optional update_mask = 2
Required. A mask specifying which fields in [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] should be updated. The field mask must always be specified; this prevents any future fields in [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.
bool validate_only = 3
An option to validate, but not actually execute, a request, and provide the same response.
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].
The request for [DeleteInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstanceConfig].
string name = 1
Required. The name of the instance configuration to be deleted. Values are of the form `projects/<project>/instanceConfigs/<instance_config>`
string etag = 2
Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration.
bool validate_only = 3
An option to validate, but not actually execute, a request, and provide the same response.
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.
The request for [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].
string parent = 1
Required. The project of the instance configuration operations. Values are of the form `projects/<project>`.
string filter = 2
An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata] is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.<field_name>` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.<field_name>` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]. * The instance configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
int32 page_size = 3
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
string page_token = 4
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse.next_page_token] from a previous [ListInstanceConfigOperationsResponse][google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse] to the same `parent` and with the same `filter`.
The response for [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].
repeated operations = 1
The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the name of the instance configuration. The operation's metadata field type `metadata.type_url` describes the type of the metadata.
string next_page_token = 2
`next_page_token` can be sent in a subsequent [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations] call to fetch more of the matching metadata.
Lists all instances in the given project.
The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
string parent = 1
Required. The name of the project for which a list of instances is requested. Values are of the form `projects/<project>`.
int32 page_size = 2
Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
string page_token = 3
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
string filter = 4
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `display_name` * `labels.key` where key is the name of a label Some examples of using filters are: * `name:*` --> The instance has a name. * `name:Howl` --> The instance's name contains the string "howl". * `name:HOWL` --> Equivalent to above. * `NAME:howl` --> Equivalent to above. * `labels.env:*` --> The instance has the label "env". * `labels.env:dev` --> The instance has the label "env" and the value of the label contains the string "dev". * `name:howl labels.env:dev` --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
optional instance_deadline = 5
Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to [unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable] in [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
repeated instances = 1
The list of requested instances.
string next_page_token = 2
`next_page_token` can be sent in a subsequent [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances] call to fetch more of the matching instances.
repeated string unreachable = 3
The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within [instance_deadline][google.spanner.admin.instance.v1.ListInstancesRequest.instance_deadline].
Lists all instance partitions for the given instance.
The request for [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions].
string parent = 1
Required. The instance whose instance partitions should be listed. Values are of the form `projects/<project>/instances/<instance>`. Use `{instance} = '-'` to list instance partitions for all Instances in a project, e.g., `projects/myproject/instances/-`.
int32 page_size = 2
Number of instance partitions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
string page_token = 3
If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.next_page_token] from a previous [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
optional instance_partition_deadline = 4
Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to [unreachable][google.spanner.admin.instance.v1.ListInstancePartitionsResponse.unreachable] in [ListInstancePartitionsResponse][google.spanner.admin.instance.v1.ListInstancePartitionsResponse].
The response for [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions].
repeated instance_partitions = 1
The list of requested instancePartitions.
string next_page_token = 2
`next_page_token` can be sent in a subsequent [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions] call to fetch more of the matching instance partitions.
repeated string unreachable = 3
The list of unreachable instances or instance partitions. It includes the names of instances or instance partitions whose metadata could not be retrieved within [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionsRequest.instance_partition_deadline].
Gets information about a particular instance.
The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
string name = 1
Required. The name of the requested instance. Values are of the form `projects/<project>/instances/<instance>`.
optional field_mask = 2
If field_mask is present, specifies the subset of [Instance][google.spanner.admin.instance.v1.Instance] fields that should be returned. If absent, all [Instance][google.spanner.admin.instance.v1.Instance] fields are returned.
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.
The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
string parent = 1
Required. The name of the project in which to create the instance. Values are of the form `projects/<project>`.
string instance_id = 2
Required. The ID of the instance to create. Valid identifiers are of the form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length.
optional instance = 3
Required. The instance to create. The name may be omitted, but if specified must be `<parent>/instances/<instance_id>`.
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].
The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
optional instance = 1
Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
optional field_mask = 2
Required. A mask specifying which fields in [Instance][google.spanner.admin.instance.v1.Instance] should be updated. The field mask must always be specified; this prevents any future fields in [Instance][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them.
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.
The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
string name = 1
Required. The name of the instance to be deleted. Values are of the form `projects/<project>/instances/<instance>`
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].
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].
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.
Gets information about a particular instance partition.
The request for [GetInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.GetInstancePartition].
string name = 1
Required. The name of the requested instance partition. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`.
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.
The request for [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition].
string parent = 1
Required. The name of the instance in which to create the instance partition. Values are of the form `projects/<project>/instances/<instance>`.
string instance_partition_id = 2
Required. The ID of the instance partition to create. Valid identifiers are of the form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length.
optional instance_partition = 3
Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be `<parent>/instancePartitions/<instance_partition_id>`.
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].
The request for [DeleteInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstancePartition].
string name = 1
Required. The name of the instance partition to be deleted. Values are of the form `projects/{project}/instances/{instance}/instancePartitions/{instance_partition}`
string etag = 2
Optional. If not empty, the API only deletes the instance partition when the etag provided matches the current status of the requested instance partition. Otherwise, deletes the instance partition without checking the current status of the requested instance partition.
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].
The request for [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition].
optional instance_partition = 1
Required. The instance partition to update, which must always include the instance partition name. Otherwise, only fields mentioned in [field_mask][google.spanner.admin.instance.v1.UpdateInstancePartitionRequest.field_mask] need be included.
optional field_mask = 2
Required. A mask specifying which fields in [InstancePartition][google.spanner.admin.instance.v1.InstancePartition] should be updated. The field mask must always be specified; this prevents any future fields in [InstancePartition][google.spanner.admin.instance.v1.InstancePartition] from being erased accidentally by clients that do not know about them.
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].
The request for [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].
string parent = 1
Required. The parent instance of the instance partition operations. Values are of the form `projects/<project>/instances/<instance>`.
string filter = 2
Optional. An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata] is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata`. * `metadata.<field_name>` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.<field_name>` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstancePartitionMetadata) AND` \ `(metadata.instance_partition.name:custom-instance-partition) AND` \ `(metadata.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is [CreateInstancePartitionMetadata][google.spanner.admin.instance.v1.CreateInstancePartitionMetadata]. * The instance partition name contains "custom-instance-partition". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
int32 page_size = 3
Optional. Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
string page_token = 4
Optional. If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.next_page_token] from a previous [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse] to the same `parent` and with the same `filter`.
optional instance_partition_deadline = 5
Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to [unreachable_instance_partitions][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse.unreachable_instance_partitions] in [ListInstancePartitionOperationsResponse][google.spanner.admin.instance.v1.ListInstancePartitionOperationsResponse].
The response for [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].
repeated operations = 1
The list of matching instance partition long-running operations. Each operation's name will be prefixed by the instance partition's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.
string next_page_token = 2
`next_page_token` can be sent in a subsequent [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations] call to fetch more of the matching metadata.
repeated string unreachable_instance_partitions = 3
The list of unreachable instance partitions. It includes the names of instance partitions whose operation metadata could not be retrieved within [instance_partition_deadline][google.spanner.admin.instance.v1.ListInstancePartitionOperationsRequest.instance_partition_deadline].
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).
The request for [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
string name = 1
Required. The instance to move. Values are of the form `projects/<project>/instances/<instance>`.
string target_config = 2
Required. The target instance configuration where to move the instance. Values are of the form `projects/<project>/instanceConfigs/<config>`.
message
spanner_instance_admin.proto:901Autoscaling configuration for an instance.
Used in: , ,
optional autoscaling_limits = 1
Required. Autoscaling limits for an instance.
optional autoscaling_targets = 2
Required. The autoscaling targets for an instance.
repeated asymmetric_autoscaling_options = 3
Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them.
message
spanner_instance_admin.proto:953AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.
Used in:
optional replica_selection = 1
Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported.
optional overrides = 2
Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas.
message
spanner_instance_admin.proto:958Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration.
Used in:
optional autoscaling_limits = 1
Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas.
int32 autoscaling_target_high_priority_cpu_utilization_percent = 2
Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas.
message
spanner_instance_admin.proto:907The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.
Used in: ,
oneof min_limit
The minimum compute capacity for the instance.
int32 min_nodes = 1
Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1.
int32 min_processing_units = 2
Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000.
oneof max_limit
The maximum compute capacity for the instance. The maximum compute capacity should be less than or equal to 10X the minimum compute capacity.
int32 max_nodes = 3
Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes.
int32 max_processing_units = 4
Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.
message
spanner_instance_admin.proto:935The autoscaling targets for an instance.
Used in:
int32 high_priority_cpu_utilization_percent = 1
Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive.
int32 storage_utilization_percent = 2
Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 99] inclusive.
Metadata type for the operation returned by [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig].
optional instance_config = 1
The target instance configuration end state.
optional progress = 2
The progress of the [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig] operation.
optional cancel_time = 3
The time at which this operation was cancelled.
Metadata type for the operation returned by [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
optional instance = 1
The instance being created.
optional start_time = 2
The time at which the [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance] request was received.
optional cancel_time = 3
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
optional end_time = 4
The time at which this operation failed or was completed successfully.
FulfillmentPeriod expected_fulfillment_period = 5
The expected fulfillment period of this create operation.
Metadata type for the operation returned by [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition].
optional instance_partition = 1
The instance partition being created.
optional start_time = 2
The time at which the [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition] request was received.
optional cancel_time = 3
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
optional end_time = 4
The time at which this operation failed or was completed successfully.
Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.
Used in:
optional expire_time = 1
Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance.
optional upgrade_time = 2
Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance.
FreeInstanceMetadata.ExpireBehavior expire_behavior = 3
Specifies the expiration behavior of a free instance. The default of ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This can be modified during or after creation, and before expiration.
Allows users to change behavior when a free instance expires.
Used in:
EXPIRE_BEHAVIOR_UNSPECIFIED = 0
Not specified.
FREE_TO_PROVISIONED = 1
When the free instance expires, upgrade the instance to a provisioned instance.
REMOVE_AFTER_GRACE_PERIOD = 2
When the free instance expires, disable the instance, and delete it after the grace period passes if it has not been upgraded.
Indicates the expected fulfillment period of an operation.
Used in: ,
FULFILLMENT_PERIOD_UNSPECIFIED = 0
Not specified.
FULFILLMENT_PERIOD_NORMAL = 1
Normal fulfillment period. The operation is expected to complete within minutes.
FULFILLMENT_PERIOD_EXTENDED = 2
Extended fulfillment period. It can take up to an hour for the operation to complete.
An isolated set of Cloud Spanner resources on which databases can be hosted.
Used as response type in: InstanceAdmin.GetInstance
Used as field type in: , , , , ,
string name = 1
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
string config = 2
Required. The name of the instance's configuration. Values are of the form `projects/<project>/instanceConfigs/<configuration>`. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
string display_name = 3
Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
int32 node_count = 5
The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
int32 processing_units = 9
The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
repeated replica_compute_capacity = 19
Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity.
optional autoscaling_config = 17
Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
Instance.State state = 6
Output only. The current instance state. For [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be either omitted or set to `CREATING`. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set to `READY`.
map<string, string> labels = 7
Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z][a-z0-9_-]{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
Instance.InstanceType instance_type = 10
The `InstanceType` of the current instance.
repeated string endpoint_uris = 8
Deprecated. This field is not populated.
optional create_time = 11
Output only. The time at which the instance was created.
optional update_time = 12
Output only. The time at which the instance was most recently updated.
optional free_instance_metadata = 13
Free instance metadata. Only populated for free instances.
Instance.Edition edition = 20
Optional. The `Edition` of the current instance.
Instance.DefaultBackupScheduleType default_backup_schedule_type = 23
Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance.
Indicates the [default backup schedule](https://cloud.google.com/spanner/docs/backup#default-backup-schedules) behavior for new databases within the instance.
Used in:
DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED = 0
Not specified.
NONE = 1
A default backup schedule isn't created automatically when a new database is created in the instance.
AUTOMATIC = 2
A default backup schedule is created automatically when a new database is created in the instance. The default backup schedule creates a full backup every 24 hours. These full backups are retained for 7 days. You can edit or delete the default backup schedule once it's created.
The edition selected for this instance. Different editions provide different capabilities at different price points.
Used in:
EDITION_UNSPECIFIED = 0
Edition not specified.
STANDARD = 1
Standard edition.
ENTERPRISE = 2
Enterprise edition.
ENTERPRISE_PLUS = 3
Enterprise Plus edition.
The type of this instance. The type can be used to distinguish product variants, that can affect aspects like: usage restrictions, quotas and billing. Currently this is used to distinguish FREE_INSTANCE vs PROVISIONED instances.
Used in:
INSTANCE_TYPE_UNSPECIFIED = 0
Not specified.
PROVISIONED = 1
Provisioned instances have dedicated resources, standard usage limits and support.
FREE_INSTANCE = 2
Free instances provide no guarantee for dedicated resources, [node_count, processing_units] should be 0. They come with stricter usage limits and limited support.
Indicates the current state of the instance.
Used in:
STATE_UNSPECIFIED = 0
Not specified.
CREATING = 1
The instance is still being created. Resources may not be available yet, and operations such as database creation may not work.
READY = 2
The instance is fully created and ready to do work such as creating databases.
message
spanner_instance_admin.proto:694A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
Used as response type in: InstanceAdmin.GetInstanceConfig
Used as field type in: , , , , ,
string name = 1
A unique identifier for the instance configuration. Values are of the form `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`. User instance configuration must start with `custom-`.
string display_name = 2
The name of this instance configuration as it appears in UIs.
InstanceConfig.Type config_type = 5
Output only. Whether this instance configuration is a Google-managed or user-managed configuration.
repeated replicas = 3
The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
repeated optional_replicas = 6
Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.
string base_config = 7
Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration.
map<string, string> labels = 8
Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z][a-z0-9_-]{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
string etag = 9
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.
repeated string leader_options = 4
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
bool reconciling = 10
Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.
InstanceConfig.State state = 11
Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.
InstanceConfig.FreeInstanceAvailability free_instance_availability = 12
Output only. Describes whether free instances are available to be created in this instance configuration.
InstanceConfig.QuorumType quorum_type = 18
Output only. The `QuorumType` of the instance configuration.
int64 storage_limit_per_processing_unit = 19
Output only. The storage limit in bytes per processing unit.
Describes the availability for free instances to be created in an instance configuration.
Used in:
FREE_INSTANCE_AVAILABILITY_UNSPECIFIED = 0
Not specified.
AVAILABLE = 1
Indicates that free instances are available to be created in this instance configuration.
UNSUPPORTED = 2
Indicates that free instances are not supported in this instance configuration.
DISABLED = 3
Indicates that free instances are currently not available to be created in this instance configuration.
QUOTA_EXCEEDED = 4
Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances.
Indicates the quorum type of this instance configuration.
Used in:
QUORUM_TYPE_UNSPECIFIED = 0
Quorum type not specified.
REGION = 1
An instance configuration tagged with `REGION` quorum type forms a write quorum in a single region.
DUAL_REGION = 2
An instance configuration tagged with the `DUAL_REGION` quorum type forms a write quorum with exactly two read-write regions in a multi-region configuration. This instance configuration requires failover in the event of regional failures.
MULTI_REGION = 3
An instance configuration tagged with the `MULTI_REGION` quorum type forms a write quorum from replicas that are spread across more than one region in a multi-region configuration.
Indicates the current state of the instance configuration.
Used in:
STATE_UNSPECIFIED = 0
Not specified.
CREATING = 1
The instance configuration is still being created.
READY = 2
The instance configuration is fully created and ready to be used to create instances.
The type of this configuration.
Used in:
TYPE_UNSPECIFIED = 0
Unspecified.
GOOGLE_MANAGED = 1
Google-managed configuration.
USER_MANAGED = 2
User-managed configuration.
An isolated set of Cloud Spanner resources that databases can define placements on.
Used as response type in: InstanceAdmin.GetInstancePartition
Used as field type in: , , , ,
string name = 1
Required. A unique identifier for the instance partition. Values are of the form `projects/<project>/instances/<instance>/instancePartitions/[a-z][-a-z0-9]*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created.
string config = 2
Required. The name of the instance partition's configuration. Values are of the form `projects/<project>/instanceConfigs/<configuration>`. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
string display_name = 3
Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
oneof compute_capacity
Compute capacity defines amount of server and storage resources that are available to the databases in an instance partition. At most, one of either `node_count` or` processing_units` should be present in the message. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
int32 node_count = 5
The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.
int32 processing_units = 6
The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state.
InstancePartition.State state = 7
Output only. The current instance partition state.
optional create_time = 8
Output only. The time at which the instance partition was created.
optional update_time = 9
Output only. The time at which the instance partition was most recently updated.
repeated string referencing_databases = 10
Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.
repeated string referencing_backups = 11
Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.
string etag = 12
Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.
Indicates the current state of the instance partition.
Used in:
STATE_UNSPECIFIED = 0
Not specified.
CREATING = 1
The instance partition is still being created. Resources may not be available yet, and operations such as creating placements using this instance partition may not work.
READY = 2
The instance partition is fully created and ready to do work such as creating placements and using in databases.
Metadata type for the operation returned by [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
string target_config = 1
The target instance configuration where to move the instance. Values are of the form `projects/<project>/instanceConfigs/<config>`.
optional progress = 2
The progress of the [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance] operation. [progress_percent][google.spanner.admin.instance.v1.OperationProgress.progress_percent] is reset when cancellation is requested.
optional cancel_time = 3
The time at which this operation was cancelled.
The response for [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
(message has no fields)
message
common.proto:33Encapsulates progress related information for a Cloud Spanner long running instance operations.
Used in: , ,
int32 progress_percent = 1
Percent completion of the operation. Values are between 0 and 100 inclusive.
optional start_time = 2
Time the request was received.
optional end_time = 3
If set, the time at which this operation failed or was completed successfully.
message
spanner_instance_admin.proto:874ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection.
Used in:
optional replica_selection = 1
Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity.
oneof compute_capacity
Compute capacity allocated to each replica identified by the specified selection. The unit is selected based on the unit used to specify the instance size for non-autoscaling instances, or the unit used in autoscaling limit for autoscaling instances.
int32 node_count = 2
The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`.
int32 processing_units = 3
The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`.
message
spanner_instance_admin.proto:644Used in: ,
string location = 1
The location of the serving resources, e.g., "us-central1".
ReplicaInfo.ReplicaType type = 2
The type of replica.
bool default_leader_location = 3
If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
Indicates the type of replica. See the [replica types documentation](https://cloud.google.com/spanner/docs/replication#replica_types) for more details.
Used in:
TYPE_UNSPECIFIED = 0
Not specified.
READ_WRITE = 1
Read-write replicas support both reads and writes. These replicas: * Maintain a full copy of your data. * Serve reads. * Can vote whether to commit a write. * Participate in leadership election. * Are eligible to become a leader.
READ_ONLY = 2
Read-only replicas only support reads (not writes). Read-only replicas: * Maintain a full copy of your data. * Serve reads. * Do not participate in voting to commit writes. * Are not eligible to become a leader.
WITNESS = 3
Witness replicas don't support reads but do participate in voting to commit writes. Witness replicas: * Do not maintain a full copy of data. * Do not serve reads. * Vote whether to commit writes. * Participate in leader election but are not eligible to become leader.
message
common.proto:61ReplicaSelection identifies replicas with common properties.
Used in: ,
string location = 1
Required. Name of the location of the replicas (e.g., "us-central1").
Metadata type for the operation returned by [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig].
optional instance_config = 1
The desired instance configuration after updating.
optional progress = 2
The progress of the [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig] operation.
optional cancel_time = 3
The time at which this operation was cancelled.
Metadata type for the operation returned by [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
optional instance = 1
The desired end state of the update.
optional start_time = 2
The time at which [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance] request was received.
optional cancel_time = 3
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
optional end_time = 4
The time at which this operation failed or was completed successfully.
FulfillmentPeriod expected_fulfillment_period = 5
The expected fulfillment period of this update operation.
Metadata type for the operation returned by [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition].
optional instance_partition = 1
The desired end state of the update.
optional start_time = 2
The time at which [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition] request was received.
optional cancel_time = 3
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
optional end_time = 4
The time at which this operation failed or was completed successfully.