Instance (Cloud Spanner API v1-rev20250708-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.spanner.v1.model.Instance

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Instance
extends com.google.api.client.json.GenericJson
```
An isolated set of Cloud Spanner resources on which databases can be hosted.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Instance()

Constructors
Constructor and Description
`Instance()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Instance`	`clone()`
`AutoscalingConfig`	`getAutoscalingConfig()` Optional.
`String`	`getConfig()` Required.
`String`	`getCreateTime()` Output only.
`String`	`getDefaultBackupScheduleType()` Optional.
`String`	`getDisplayName()` Required.
`String`	`getEdition()` Optional.
`List<String>`	`getEndpointUris()` Deprecated.
`FreeInstanceMetadata`	`getFreeInstanceMetadata()` Free instance metadata.
`String`	`getInstanceType()` The `InstanceType` of the current instance.
`Map<String,String>`	`getLabels()` Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies.
`String`	`getName()` Required.
`Integer`	`getNodeCount()` The number of nodes allocated to this instance.
`Integer`	`getProcessingUnits()` The number of processing units allocated to this instance.
`List<ReplicaComputeCapacity>`	`getReplicaComputeCapacity()` Output only.
`String`	`getState()` Output only.
`String`	`getUpdateTime()` Output only.
`Instance`	`set(String fieldName, Object value)`
`Instance`	`setAutoscalingConfig(AutoscalingConfig autoscalingConfig)` Optional.
`Instance`	`setConfig(String config)` Required.
`Instance`	`setCreateTime(String createTime)` Output only.
`Instance`	`setDefaultBackupScheduleType(String defaultBackupScheduleType)` Optional.
`Instance`	`setDisplayName(String displayName)` Required.
`Instance`	`setEdition(String edition)` Optional.
`Instance`	`setEndpointUris(List<String> endpointUris)` Deprecated.
`Instance`	`setFreeInstanceMetadata(FreeInstanceMetadata freeInstanceMetadata)` Free instance metadata.
`Instance`	`setInstanceType(String instanceType)` The `InstanceType` of the current instance.
`Instance`	`setLabels(Map<String,String> labels)` Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies.
`Instance`	`setName(String name)` Required.
`Instance`	`setNodeCount(Integer nodeCount)` The number of nodes allocated to this instance.
`Instance`	`setProcessingUnits(Integer processingUnits)` The number of processing units allocated to this instance.
`Instance`	`setReplicaComputeCapacity(List<ReplicaComputeCapacity> replicaComputeCapacity)` Output only.
`Instance`	`setState(String state)` Output only.
`Instance`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Instance
```
public Instance()
```
- Method Detail
  - getAutoscalingConfig
```
public AutoscalingConfig getAutoscalingConfig()
```
    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.
    
    Returns:
    
    value or null for none
  - setAutoscalingConfig
```
public Instance setAutoscalingConfig(AutoscalingConfig autoscalingConfig)
```
    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.
    
    Parameters:
    
    autoscalingConfig - autoscalingConfig or null for none
  - getConfig
```
public String getConfig()
```
    Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
    
    Returns:
    
    value or null for none
  - setConfig
```
public Instance setConfig(String config)
```
    Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
    
    Parameters:
    
    config - config or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time at which the instance was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Instance setCreateTime(String createTime)
```
    Output only. The time at which the instance was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDefaultBackupScheduleType
```
public String getDefaultBackupScheduleType()
```
    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.
    
    Returns:
    
    value or null for none
  - setDefaultBackupScheduleType
```
public Instance setDefaultBackupScheduleType(String defaultBackupScheduleType)
```
    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.
    
    Parameters:
    
    defaultBackupScheduleType - defaultBackupScheduleType or null for none
  - getDisplayName
```
public String getDisplayName()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Instance setDisplayName(String displayName)
```
    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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEdition
```
public String getEdition()
```
    Optional. The `Edition` of the current instance.
    
    Returns:
    
    value or null for none
  - setEdition
```
public Instance setEdition(String edition)
```
    Optional. The `Edition` of the current instance.
    
    Parameters:
    
    edition - edition or null for none
  - getEndpointUris
```
public List<String> getEndpointUris()
```
    Deprecated. This field is not populated.
    
    Returns:
    
    value or null for none
  - setEndpointUris
```
public Instance setEndpointUris(List<String> endpointUris)
```
    Deprecated. This field is not populated.
    
    Parameters:
    
    endpointUris - endpointUris or null for none
  - getFreeInstanceMetadata
```
public FreeInstanceMetadata getFreeInstanceMetadata()
```
    Free instance metadata. Only populated for free instances.
    
    Returns:
    
    value or null for none
  - setFreeInstanceMetadata
```
public Instance setFreeInstanceMetadata(FreeInstanceMetadata freeInstanceMetadata)
```
    Free instance metadata. Only populated for free instances.
    
    Parameters:
    
    freeInstanceMetadata - freeInstanceMetadata or null for none
  - getInstanceType
```
public String getInstanceType()
```
    The `InstanceType` of the current instance.
    
    Returns:
    
    value or null for none
  - setInstanceType
```
public Instance setInstanceType(String instanceType)
```
    The `InstanceType` of the current instance.
    
    Parameters:
    
    instanceType - instanceType or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    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{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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Instance setLabels(Map<String,String> labels)
```
    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{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.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
    
    Returns:
    
    value or null for none
  - setName
```
public Instance setName(String name)
```
    Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
    
    Parameters:
    
    name - name or null for none
  - getNodeCount
```
public Integer getNodeCount()
```
    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. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
    
    Returns:
    
    value or null for none
  - setNodeCount
```
public Instance setNodeCount(Integer nodeCount)
```
    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. If the instance has varying node count across replicas (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `node_count` set here is the maximum node count across all replicas. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
    
    Parameters:
    
    nodeCount - nodeCount or null for none
  - getProcessingUnits
```
public Integer getProcessingUnits()
```
    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. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
    
    Returns:
    
    value or null for none
  - setProcessingUnits
```
public Instance setProcessingUnits(Integer processingUnits)
```
    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. If the instance has varying processing units per replica (achieved by setting `asymmetric_autoscaling_options` in the autoscaling configuration), the `processing_units` set here is the maximum processing units across all replicas. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).
    
    Parameters:
    
    processingUnits - processingUnits or null for none
  - getReplicaComputeCapacity
```
public List<ReplicaComputeCapacity> getReplicaComputeCapacity()
```
    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.
    
    Returns:
    
    value or null for none
  - setReplicaComputeCapacity
```
public Instance setReplicaComputeCapacity(List<ReplicaComputeCapacity> replicaComputeCapacity)
```
    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.
    
    Parameters:
    
    replicaComputeCapacity - replicaComputeCapacity or null for none
  - getState
```
public String getState()
```
    Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.
    
    Returns:
    
    value or null for none
  - setState
```
public Instance setState(String state)
```
    Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.
    
    Parameters:
    
    state - state or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time at which the instance was most recently updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Instance setUpdateTime(String updateTime)
```
    Output only. The time at which the instance was most recently updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Instance set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Instance clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Instance

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Instance

Method Detail

getAutoscalingConfig

setAutoscalingConfig

getConfig

setConfig

getCreateTime

setCreateTime

getDefaultBackupScheduleType

setDefaultBackupScheduleType

getDisplayName

setDisplayName

getEdition

setEdition

getEndpointUris

setEndpointUris

getFreeInstanceMetadata

setFreeInstanceMetadata

getInstanceType

setInstanceType

getLabels

setLabels

getName

setName

getNodeCount

setNodeCount

getProcessingUnits

setProcessingUnits

getReplicaComputeCapacity

setReplicaComputeCapacity

getState

setState

getUpdateTime

setUpdateTime

set

clone