InstancePartition (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.InstancePartition

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class InstancePartition
extends com.google.api.client.json.GenericJson
```
An isolated set of Cloud Spanner resources that databases can define placements on.
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

InstancePartition()

Constructors
Constructor and Description
`InstancePartition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstancePartition`	`clone()`
`String`	`getConfig()` Required.
`String`	`getCreateTime()` Output only.
`String`	`getDisplayName()` Required.
`String`	`getEtag()` Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other.
`String`	`getName()` Required.
`Integer`	`getNodeCount()` The number of nodes allocated to this instance partition.
`Integer`	`getProcessingUnits()` The number of processing units allocated to this instance partition.
`List<String>`	`getReferencingBackups()` Output only.
`List<String>`	`getReferencingDatabases()` Output only.
`String`	`getState()` Output only.
`String`	`getUpdateTime()` Output only.
`InstancePartition`	`set(String fieldName, Object value)`
`InstancePartition`	`setConfig(String config)` Required.
`InstancePartition`	`setCreateTime(String createTime)` Output only.
`InstancePartition`	`setDisplayName(String displayName)` Required.
`InstancePartition`	`setEtag(String etag)` Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other.
`InstancePartition`	`setName(String name)` Required.
`InstancePartition`	`setNodeCount(Integer nodeCount)` The number of nodes allocated to this instance partition.
`InstancePartition`	`setProcessingUnits(Integer processingUnits)` The number of processing units allocated to this instance partition.
`InstancePartition`	`setReferencingBackups(List<String> referencingBackups)` Output only.
`InstancePartition`	`setReferencingDatabases(List<String> referencingDatabases)` Output only.
`InstancePartition`	`setState(String state)` Output only.
`InstancePartition`	`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
  - InstancePartition
```
public InstancePartition()
```
- Method Detail
  - getConfig
```
public String getConfig()
```
    Required. The name of the instance partition's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs.
    
    Returns:
    
    value or null for none
  - setConfig
```
public InstancePartition setConfig(String config)
```
    Required. The name of the instance partition'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 partition was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public InstancePartition setCreateTime(String createTime)
```
    Output only. The time at which the instance partition was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDisplayName
```
public String getDisplayName()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public InstancePartition setDisplayName(String displayName)
```
    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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEtag
```
public String getEtag()
```
    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.
    
    Returns:
    
    value or null for none
  - setEtag
```
public InstancePartition setEtag(String etag)
```
    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.
    
    Parameters:
    
    etag - etag or null for none
  - getName
```
public String getName()
```
    Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[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.
    
    Returns:
    
    value or null for none
  - setName
```
public InstancePartition setName(String name)
```
    Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[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.
    
    Parameters:
    
    name - name or null for none
  - getNodeCount
```
public Integer getNodeCount()
```
    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`.
    
    Returns:
    
    value or null for none
  - setNodeCount
```
public InstancePartition setNodeCount(Integer nodeCount)
```
    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`.
    
    Parameters:
    
    nodeCount - nodeCount or null for none
  - getProcessingUnits
```
public Integer getProcessingUnits()
```
    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.
    
    Returns:
    
    value or null for none
  - setProcessingUnits
```
public InstancePartition setProcessingUnits(Integer processingUnits)
```
    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.
    
    Parameters:
    
    processingUnits - processingUnits or null for none
  - getReferencingBackups
```
public List<String> getReferencingBackups()
```
    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.
    
    Returns:
    
    value or null for none
  - setReferencingBackups
```
public InstancePartition setReferencingBackups(List<String> referencingBackups)
```
    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.
    
    Parameters:
    
    referencingBackups - referencingBackups or null for none
  - getReferencingDatabases
```
public List<String> getReferencingDatabases()
```
    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.
    
    Returns:
    
    value or null for none
  - setReferencingDatabases
```
public InstancePartition setReferencingDatabases(List<String> referencingDatabases)
```
    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.
    
    Parameters:
    
    referencingDatabases - referencingDatabases or null for none
  - getState
```
public String getState()
```
    Output only. The current instance partition state.
    
    Returns:
    
    value or null for none
  - setState
```
public InstancePartition setState(String state)
```
    Output only. The current instance partition state.
    
    Parameters:
    
    state - state or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The time at which the instance partition was most recently updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public InstancePartition setUpdateTime(String updateTime)
```
    Output only. The time at which the instance partition was most recently updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public InstancePartition set(String fieldName,
                             Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InstancePartition clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class InstancePartition

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

InstancePartition

Method Detail

getConfig

setConfig

getCreateTime

setCreateTime

getDisplayName

setDisplayName

getEtag

setEtag

getName

setName

getNodeCount

setNodeCount

getProcessingUnits

setProcessingUnits

getReferencingBackups

setReferencingBackups

getReferencingDatabases

setReferencingDatabases

getState

setState

getUpdateTime

setUpdateTime

set

clone