Class InstanceConfig.Builder

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 \u201cdefault_leader\u201d 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.

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 \u201cdefault_leader\u201d 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 \u201cdefault_leader\u201d 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.

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

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.

clearField(Descriptors.FieldDescriptor field)

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

clearLeaderOptions()

public InstanceConfig.Builder clearLeaderOptions()

Allowed values of the \u201cdefault_leader\u201d 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

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

clone()

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

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.

getLeaderOptions(int index)

public String getLeaderOptions(int index)

Allowed values of the \u201cdefault_leader\u201d 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 \u201cdefault_leader\u201d 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 \u201cdefault_leader\u201d 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 \u201cdefault_leader\u201d 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.

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.

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>

internalGetFieldAccessorTable()

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

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

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

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.

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 \u201cdefault_leader\u201d 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.

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

setUnknownFields(UnknownFieldSet unknownFields)

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