Class InstanceConfig.Builder (6.69.0)

public static final class InstanceConfig.Builder extends GeneratedMessageV3.Builder<InstanceConfig.Builder> implements InstanceConfigOrBuilder

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

Protobuf type google.spanner.admin.instance.v1.InstanceConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllLeaderOptions(Iterable<String> values)

public InstanceConfig.Builder addAllLeaderOptions(Iterable<String> values)

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

repeated string leader_options = 4;

Parameter
Name Description
values Iterable<String>

The leaderOptions to add.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

addAllOptionalReplicas(Iterable<? extends ReplicaInfo> values)

public InstanceConfig.Builder addAllOptionalReplicas(Iterable<? extends ReplicaInfo> values)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.spanner.admin.instance.v1.ReplicaInfo>
Returns
Type Description
InstanceConfig.Builder

addAllReplicas(Iterable<? extends ReplicaInfo> values)

public InstanceConfig.Builder addAllReplicas(Iterable<? extends ReplicaInfo> values)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
values Iterable<? extends com.google.spanner.admin.instance.v1.ReplicaInfo>
Returns
Type Description
InstanceConfig.Builder

addLeaderOptions(String value)

public InstanceConfig.Builder addLeaderOptions(String value)

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

repeated string leader_options = 4;

Parameter
Name Description
value String

The leaderOptions to add.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

addLeaderOptionsBytes(ByteString value)

public InstanceConfig.Builder addLeaderOptionsBytes(ByteString value)

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

repeated string leader_options = 4;

Parameter
Name Description
value ByteString

The bytes of the leaderOptions to add.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

addOptionalReplicas(ReplicaInfo value)

public InstanceConfig.Builder addOptionalReplicas(ReplicaInfo value)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ReplicaInfo
Returns
Type Description
InstanceConfig.Builder

addOptionalReplicas(ReplicaInfo.Builder builderForValue)

public InstanceConfig.Builder addOptionalReplicas(ReplicaInfo.Builder builderForValue)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue ReplicaInfo.Builder
Returns
Type Description
InstanceConfig.Builder

addOptionalReplicas(int index, ReplicaInfo value)

public InstanceConfig.Builder addOptionalReplicas(int index, ReplicaInfo value)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value ReplicaInfo
Returns
Type Description
InstanceConfig.Builder

addOptionalReplicas(int index, ReplicaInfo.Builder builderForValue)

public InstanceConfig.Builder addOptionalReplicas(int index, ReplicaInfo.Builder builderForValue)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue ReplicaInfo.Builder
Returns
Type Description
InstanceConfig.Builder

addOptionalReplicasBuilder()

public ReplicaInfo.Builder addOptionalReplicasBuilder()

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ReplicaInfo.Builder

addOptionalReplicasBuilder(int index)

public ReplicaInfo.Builder addOptionalReplicasBuilder(int index)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstanceConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstanceConfig.Builder
Overrides

addReplicas(ReplicaInfo value)

public InstanceConfig.Builder addReplicas(ReplicaInfo value)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
value ReplicaInfo
Returns
Type Description
InstanceConfig.Builder

addReplicas(ReplicaInfo.Builder builderForValue)

public InstanceConfig.Builder addReplicas(ReplicaInfo.Builder builderForValue)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
builderForValue ReplicaInfo.Builder
Returns
Type Description
InstanceConfig.Builder

addReplicas(int index, ReplicaInfo value)

public InstanceConfig.Builder addReplicas(int index, ReplicaInfo value)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameters
Name Description
index int
value ReplicaInfo
Returns
Type Description
InstanceConfig.Builder

addReplicas(int index, ReplicaInfo.Builder builderForValue)

public InstanceConfig.Builder addReplicas(int index, ReplicaInfo.Builder builderForValue)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameters
Name Description
index int
builderForValue ReplicaInfo.Builder
Returns
Type Description
InstanceConfig.Builder

addReplicasBuilder()

public ReplicaInfo.Builder addReplicasBuilder()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
ReplicaInfo.Builder

addReplicasBuilder(int index)

public ReplicaInfo.Builder addReplicasBuilder(int index)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo.Builder

build()

public InstanceConfig build()
Returns
Type Description
InstanceConfig

buildPartial()

public InstanceConfig buildPartial()
Returns
Type Description
InstanceConfig

clear()

public InstanceConfig.Builder clear()
Returns
Type Description
InstanceConfig.Builder
Overrides

clearBaseConfig()

public InstanceConfig.Builder clearBaseConfig()

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.

string base_config = 7 [(.google.api.resource_reference) = { ... }

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearConfigType()

public InstanceConfig.Builder clearConfigType()

Output only. Whether this instance config is a Google or User Managed Configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearDisplayName()

public InstanceConfig.Builder clearDisplayName()

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

string display_name = 2;

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearEtag()

public InstanceConfig.Builder clearEtag()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

string etag = 9;

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InstanceConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
InstanceConfig.Builder
Overrides

clearLabels()

public InstanceConfig.Builder clearLabels()
Returns
Type Description
InstanceConfig.Builder

clearLeaderOptions()

public InstanceConfig.Builder clearLeaderOptions()

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

repeated string leader_options = 4;

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearName()

public InstanceConfig.Builder clearName()

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

string name = 1;

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
InstanceConfig.Builder
Overrides

clearOptionalReplicas()

public InstanceConfig.Builder clearOptionalReplicas()

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.Builder

clearReconciling()

public InstanceConfig.Builder clearReconciling()

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

bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clearReplicas()

public InstanceConfig.Builder clearReplicas()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
InstanceConfig.Builder

clearState()

public InstanceConfig.Builder clearState()

Output only. The current instance config state.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

clone()

public InstanceConfig.Builder clone()
Returns
Type Description
InstanceConfig.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBaseConfig()

public String getBaseConfig()

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.

string base_config = 7 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The baseConfig.

getBaseConfigBytes()

public ByteString getBaseConfigBytes()

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.

string base_config = 7 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for baseConfig.

getConfigType()

public InstanceConfig.Type getConfigType()

Output only. Whether this instance config is a Google or User Managed Configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.Type

The configType.

getConfigTypeValue()

public int getConfigTypeValue()

Output only. Whether this instance config is a Google or User Managed Configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for configType.

getDefaultInstanceForType()

public InstanceConfig getDefaultInstanceForType()
Returns
Type Description
InstanceConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

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

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

string etag = 9;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

string etag = 9;

Returns
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 8;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getLeaderOptions(int index)

public String getLeaderOptions(int index)

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

repeated string leader_options = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The leaderOptions at the given index.

getLeaderOptionsBytes(int index)

public ByteString getLeaderOptionsBytes(int index)

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

repeated string leader_options = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the leaderOptions at the given index.

getLeaderOptionsCount()

public int getLeaderOptionsCount()

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

repeated string leader_options = 4;

Returns
Type Description
int

The count of leaderOptions.

getLeaderOptionsList()

public ProtocolStringList getLeaderOptionsList()

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

repeated string leader_options = 4;

Returns
Type Description
ProtocolStringList

A list containing the leaderOptions.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOptionalReplicas(int index)

public ReplicaInfo getOptionalReplicas(int index)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo

getOptionalReplicasBuilder(int index)

public ReplicaInfo.Builder getOptionalReplicasBuilder(int index)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo.Builder

getOptionalReplicasBuilderList()

public List<ReplicaInfo.Builder> getOptionalReplicasBuilderList()

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getOptionalReplicasCount()

public int getOptionalReplicasCount()

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getOptionalReplicasList()

public List<ReplicaInfo> getOptionalReplicasList()

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ReplicaInfo>

getOptionalReplicasOrBuilder(int index)

public ReplicaInfoOrBuilder getOptionalReplicasOrBuilder(int index)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfoOrBuilder

getOptionalReplicasOrBuilderList()

public List<? extends ReplicaInfoOrBuilder> getOptionalReplicasOrBuilderList()

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder>

getReconciling()

public boolean getReconciling()

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

bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The reconciling.

getReplicas(int index)

public ReplicaInfo getReplicas(int index)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo

getReplicasBuilder(int index)

public ReplicaInfo.Builder getReplicasBuilder(int index)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfo.Builder

getReplicasBuilderList()

public List<ReplicaInfo.Builder> getReplicasBuilderList()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
List<Builder>

getReplicasCount()

public int getReplicasCount()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
int

getReplicasList()

public List<ReplicaInfo> getReplicasList()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
List<ReplicaInfo>

getReplicasOrBuilder(int index)

public ReplicaInfoOrBuilder getReplicasOrBuilder(int index)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
index int
Returns
Type Description
ReplicaInfoOrBuilder

getReplicasOrBuilderList()

public List<? extends ReplicaInfoOrBuilder> getReplicasOrBuilderList()

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type Description
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder>

getState()

public InstanceConfig.State getState()

Output only. The current instance config state.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
InstanceConfig.State

The state.

getStateValue()

public int getStateValue()

Output only. The current instance config state.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InstanceConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InstanceConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InstanceConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InstanceConfig.Builder
Overrides

mergeFrom(InstanceConfig other)

public InstanceConfig.Builder mergeFrom(InstanceConfig other)
Parameter
Name Description
other InstanceConfig
Returns
Type Description
InstanceConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InstanceConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InstanceConfig.Builder
Overrides

putAllLabels(Map<String,String> values)

public InstanceConfig.Builder putAllLabels(Map<String,String> values)

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.

map<string, string> labels = 8;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
InstanceConfig.Builder

putLabels(String key, String value)

public InstanceConfig.Builder putLabels(String key, String value)

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.

map<string, string> labels = 8;

Parameters
Name Description
key String
value String
Returns
Type Description
InstanceConfig.Builder

removeLabels(String key)

public InstanceConfig.Builder removeLabels(String key)

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.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
InstanceConfig.Builder

removeOptionalReplicas(int index)

public InstanceConfig.Builder removeOptionalReplicas(int index)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
InstanceConfig.Builder

removeReplicas(int index)

public InstanceConfig.Builder removeReplicas(int index)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name Description
index int
Returns
Type Description
InstanceConfig.Builder

setBaseConfig(String value)

public InstanceConfig.Builder setBaseConfig(String value)

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.

string base_config = 7 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The baseConfig to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setBaseConfigBytes(ByteString value)

public InstanceConfig.Builder setBaseConfigBytes(ByteString value)

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.

string base_config = 7 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for baseConfig to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setConfigType(InstanceConfig.Type value)

public InstanceConfig.Builder setConfigType(InstanceConfig.Type value)

Output only. Whether this instance config is a Google or User Managed Configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value InstanceConfig.Type

The configType to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setConfigTypeValue(int value)

public InstanceConfig.Builder setConfigTypeValue(int value)

Output only. Whether this instance config is a Google or User Managed Configuration.

.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for configType to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setDisplayName(String value)

public InstanceConfig.Builder setDisplayName(String value)

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

string display_name = 2;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public InstanceConfig.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setEtag(String value)

public InstanceConfig.Builder setEtag(String value)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

string etag = 9;

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public InstanceConfig.Builder setEtagBytes(ByteString value)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

string etag = 9;

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InstanceConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstanceConfig.Builder
Overrides

setLeaderOptions(int index, String value)

public InstanceConfig.Builder setLeaderOptions(int index, String value)

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

repeated string leader_options = 4;

Parameters
Name Description
index int

The index to set the value at.

value String

The leaderOptions to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setName(String value)

public InstanceConfig.Builder setName(String value)

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

string name = 1;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public InstanceConfig.Builder setNameBytes(ByteString value)

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/a-z*.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setOptionalReplicas(int index, ReplicaInfo value)

public InstanceConfig.Builder setOptionalReplicas(int index, ReplicaInfo value)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value ReplicaInfo
Returns
Type Description
InstanceConfig.Builder

setOptionalReplicas(int index, ReplicaInfo.Builder builderForValue)

public InstanceConfig.Builder setOptionalReplicas(int index, ReplicaInfo.Builder builderForValue)

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

repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue ReplicaInfo.Builder
Returns
Type Description
InstanceConfig.Builder

setReconciling(boolean value)

public InstanceConfig.Builder setReconciling(boolean value)

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

bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The reconciling to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InstanceConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
InstanceConfig.Builder
Overrides

setReplicas(int index, ReplicaInfo value)

public InstanceConfig.Builder setReplicas(int index, ReplicaInfo value)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameters
Name Description
index int
value ReplicaInfo
Returns
Type Description
InstanceConfig.Builder

setReplicas(int index, ReplicaInfo.Builder builderForValue)

public InstanceConfig.Builder setReplicas(int index, ReplicaInfo.Builder builderForValue)

The geographic placement of nodes in this instance configuration and their replication properties.

repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameters
Name Description
index int
builderForValue ReplicaInfo.Builder
Returns
Type Description
InstanceConfig.Builder

setState(InstanceConfig.State value)

public InstanceConfig.Builder setState(InstanceConfig.State value)

Output only. The current instance config state.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value InstanceConfig.State

The state to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setStateValue(int value)

public InstanceConfig.Builder setStateValue(int value)

Output only. The current instance config state.

.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
InstanceConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final InstanceConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InstanceConfig.Builder
Overrides