Classes
AutoscalingConfig
Autoscaling configuration for an instance.
AutoscalingConfig.Types
Container for nested types declared in the AutoscalingConfig message type.
AutoscalingConfig.Types.AsymmetricAutoscalingOption
AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.
AutoscalingConfig.Types.AsymmetricAutoscalingOption.Types
Container for nested types declared in the AsymmetricAutoscalingOption message type.
AutoscalingConfig.Types.AsymmetricAutoscalingOption.Types.AutoscalingConfigOverrides
Overrides 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.
AutoscalingConfig.Types.AutoscalingLimits
The 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.
AutoscalingConfig.Types.AutoscalingTargets
The autoscaling targets for an instance.
CreateInstanceConfigMetadata
Metadata type for the operation returned by [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig].
CreateInstanceConfigRequest
The request for [CreateInstanceConfigRequest][InstanceAdmin.CreateInstanceConfigRequest].
CreateInstanceMetadata
Metadata type for the operation returned by [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
CreateInstancePartitionMetadata
Metadata type for the operation returned by [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition].
CreateInstancePartitionRequest
The request for [CreateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstancePartition].
CreateInstanceRequest
The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
DeleteInstanceConfigRequest
The request for [DeleteInstanceConfigRequest][InstanceAdmin.DeleteInstanceConfigRequest].
DeleteInstancePartitionRequest
The request for [DeleteInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstancePartition].
DeleteInstanceRequest
The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
GetInstanceConfigRequest
The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
GetInstancePartitionRequest
The request for [GetInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.GetInstancePartition].
GetInstanceRequest
The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.
Instance.Types
Container for nested types declared in the Instance message type.
InstanceAdmin
Cloud Spanner Instance Admin API
The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.
Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.
Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.
InstanceAdmin.InstanceAdminBase
Base class for server-side implementations of InstanceAdmin
InstanceAdmin.InstanceAdminClient
Client for InstanceAdmin
InstanceAdminClient
InstanceAdmin client wrapper, for convenient use.
InstanceAdminClientBuilder
Builder class for InstanceAdminClient to provide simple configuration of credentials, endpoint etc.
InstanceAdminClientImpl
InstanceAdmin client wrapper implementation, for convenient use.
InstanceAdminSettings
Settings for InstanceAdminClient instances.
InstanceConfig
A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
InstanceConfig.Types
Container for nested types declared in the InstanceConfig message type.
InstanceConfigName
Resource name for the InstanceConfig resource.
InstancePartition
An isolated set of Cloud Spanner resources that databases can define placements on.
InstancePartition.Types
Container for nested types declared in the InstancePartition message type.
InstancePartitionName
Resource name for the InstancePartition resource.
ListInstanceConfigOperationsRequest
The request for [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].
ListInstanceConfigOperationsResponse
The response for [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].
ListInstanceConfigsRequest
The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
ListInstanceConfigsResponse
The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
ListInstancePartitionOperationsRequest
The request for [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].
ListInstancePartitionOperationsResponse
The response for [ListInstancePartitionOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitionOperations].
ListInstancePartitionsRequest
The request for [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions].
ListInstancePartitionsResponse
The response for [ListInstancePartitions][google.spanner.admin.instance.v1.InstanceAdmin.ListInstancePartitions].
ListInstancesRequest
The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
ListInstancesResponse
The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
MoveInstanceMetadata
Metadata type for the operation returned by [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
MoveInstanceRequest
The request for [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
MoveInstanceResponse
The response for [MoveInstance][google.spanner.admin.instance.v1.InstanceAdmin.MoveInstance].
OperationProgress
Encapsulates progress related information for a Cloud Spanner long running instance operations.
ReplicaComputeCapacity
ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection.
ReplicaInfo
ReplicaInfo.Types
Container for nested types declared in the ReplicaInfo message type.
ReplicaSelection
ReplicaSelection identifies replicas with common properties.
UpdateInstanceConfigMetadata
Metadata type for the operation returned by [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig].
UpdateInstanceConfigRequest
The request for [UpdateInstanceConfigRequest][InstanceAdmin.UpdateInstanceConfigRequest].
UpdateInstanceMetadata
Metadata type for the operation returned by [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
UpdateInstancePartitionMetadata
Metadata type for the operation returned by [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition].
UpdateInstancePartitionRequest
The request for [UpdateInstancePartition][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstancePartition].
UpdateInstanceRequest
The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
Enums
AutoscalingConfig.Types.AutoscalingLimits.MaxLimitOneofCase
Enum of possible cases for the "max_limit" oneof.
AutoscalingConfig.Types.AutoscalingLimits.MinLimitOneofCase
Enum of possible cases for the "min_limit" oneof.
FulfillmentPeriod
Indicates the expected fulfillment period of an operation.
Instance.Types.DefaultBackupScheduleType
Indicates the default backup behavior for new databases within the instance.
Instance.Types.Edition
The edition selected for this instance. Different editions provide different capabilities at different price points.
Instance.Types.State
Indicates the current state of the instance.
InstanceConfig.Types.State
Indicates the current state of the instance configuration.
InstanceConfig.Types.Type
The type of this configuration.
InstanceConfigName.ResourceNameType
The possible contents of InstanceConfigName.
InstancePartition.ComputeCapacityOneofCase
Enum of possible cases for the "compute_capacity" oneof.
InstancePartition.Types.State
Indicates the current state of the instance partition.
InstancePartitionName.ResourceNameType
The possible contents of InstancePartitionName.
ReplicaComputeCapacity.ComputeCapacityOneofCase
Enum of possible cases for the "compute_capacity" oneof.
ReplicaInfo.Types.ReplicaType
Indicates the type of replica. See the replica types documentation for more details.