Class InstanceConfig.Builder

Version 6.21.2

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > InstanceConfig.Builder

Implements

InstanceConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public InstanceConfig getDefaultInstanceForType()

Returns

Type	Description
InstanceConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public InstanceConfig.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
InstanceConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)