com.google.api.services.spanner.v1.model

Class InstanceConfig

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.InstanceConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class InstanceConfig
extends com.google.api.client.json.GenericJson

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

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
InstanceConfig()

Method Summary

Modifier and Type	Method and Description
InstanceConfig	clone()
String	getBaseConfig() Base configuration name, e.g.
String	getConfigType() Output only.
String	getDisplayName() The name of this instance configuration as it appears in UIs.
String	getEtag() etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other.
String	getFreeInstanceAvailability() Output only.
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.
List<String>	getLeaderOptions() Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
String	getName() A unique identifier for the instance configuration.
List<ReplicaInfo>	getOptionalReplicas() Output only.
String	getQuorumType() Output only.
Boolean	getReconciling() Output only.
List<ReplicaInfo>	getReplicas() The geographic placement of nodes in this instance configuration and their replication properties.
String	getState() Output only.
Long	getStorageLimitPerProcessingUnit() Output only.
InstanceConfig	set(String fieldName, Object value)
InstanceConfig	setBaseConfig(String baseConfig) Base configuration name, e.g.
InstanceConfig	setConfigType(String configType) Output only.
InstanceConfig	setDisplayName(String displayName) The name of this instance configuration as it appears in UIs.
InstanceConfig	setEtag(String etag) etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other.
InstanceConfig	setFreeInstanceAvailability(String freeInstanceAvailability) Output only.
InstanceConfig	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.
InstanceConfig	setLeaderOptions(List<String> leaderOptions) Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
InstanceConfig	setName(String name) A unique identifier for the instance configuration.
InstanceConfig	setOptionalReplicas(List<ReplicaInfo> optionalReplicas) Output only.
InstanceConfig	setQuorumType(String quorumType) Output only.
InstanceConfig	setReconciling(Boolean reconciling) Output only.
InstanceConfig	setReplicas(List<ReplicaInfo> replicas) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig	setState(String state) Output only.
InstanceConfig	setStorageLimitPerProcessingUnit(Long storageLimitPerProcessingUnit) 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

InstanceConfig

public InstanceConfig()

Method Detail

getBaseConfig

public String getBaseConfig()

Base configuration name, e.g. projects//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.

Returns:

value or null for none

setBaseConfig

public InstanceConfig setBaseConfig(String baseConfig)

Base configuration name, e.g. projects//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.

Parameters:

baseConfig - baseConfig or null for none

getConfigType

public String getConfigType()

Output only. Whether this instance configuration is a Google-managed or user-managed configuration.

Returns:

value or null for none

setConfigType

public InstanceConfig setConfigType(String configType)

Output only. Whether this instance configuration is a Google-managed or user-managed configuration.

Parameters:

configType - configType or null for none

getDisplayName

public String getDisplayName()

The name of this instance configuration as it appears in UIs.

Returns:

value or null for none

setDisplayName

public InstanceConfig setDisplayName(String displayName)

The name of this instance configuration as it appears in UIs.

Parameters:

displayName - displayName or null for none

getEtag

public String getEtag()

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.

Returns:

value or null for none

setEtag

public InstanceConfig setEtag(String etag)

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.

Parameters:

etag - etag or null for none

getFreeInstanceAvailability

public String getFreeInstanceAvailability()

Output only. Describes whether free instances are available to be created in this instance configuration.

Returns:

value or null for none

setFreeInstanceAvailability

public InstanceConfig setFreeInstanceAvailability(String freeInstanceAvailability)

Output only. Describes whether free instances are available to be created in this instance configuration.

Parameters:

freeInstanceAvailability - freeInstanceAvailability 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. 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.

Returns:

value or null for none

setLabels

public InstanceConfig 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. 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.

Parameters:

labels - labels or null for none

getLeaderOptions

public List<String> getLeaderOptions()

Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.

Returns:

value or null for none

setLeaderOptions

public InstanceConfig setLeaderOptions(List<String> leaderOptions)

Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.

Parameters:

leaderOptions - leaderOptions or null for none

getName

public String getName()

A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.

Returns:

value or null for none

setName

public InstanceConfig setName(String name)

A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.

Parameters:

name - name or null for none

getOptionalReplicas

public List<ReplicaInfo> getOptionalReplicas()

Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.

Returns:

value or null for none

setOptionalReplicas

public InstanceConfig setOptionalReplicas(List<ReplicaInfo> optionalReplicas)

Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.

Parameters:

optionalReplicas - optionalReplicas or null for none

getQuorumType

public String getQuorumType()

Output only. The `QuorumType` of the instance configuration.

Returns:

value or null for none

setQuorumType

public InstanceConfig setQuorumType(String quorumType)

Output only. The `QuorumType` of the instance configuration.

Parameters:

quorumType - quorumType or null for none

getReconciling

public Boolean getReconciling()

Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.

Returns:

value or null for none

setReconciling

public InstanceConfig setReconciling(Boolean reconciling)

Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.

Parameters:

reconciling - reconciling or null for none

getReplicas

public List<ReplicaInfo> getReplicas()

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`.

Returns:

value or null for none

setReplicas

public InstanceConfig setReplicas(List<ReplicaInfo> replicas)

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`.

Parameters:

replicas - replicas or null for none

getState

public String getState()

Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.

Returns:

value or null for none

setState

public InstanceConfig setState(String state)

Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.

Parameters:

state - state or null for none

getStorageLimitPerProcessingUnit

public Long getStorageLimitPerProcessingUnit()

Output only. The storage limit in bytes per processing unit.

Returns:

value or null for none

setStorageLimitPerProcessingUnit

public InstanceConfig setStorageLimitPerProcessingUnit(Long storageLimitPerProcessingUnit)

Output only. The storage limit in bytes per processing unit.

Parameters:

storageLimitPerProcessingUnit - storageLimitPerProcessingUnit or null for none

set

public InstanceConfig set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public InstanceConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson