com.google.spanner.admin.instance.v1

Class InstanceConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<InstanceConfig.Builder>

com.google.spanner.admin.instance.v1.InstanceConfig.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, InstanceConfigOrBuilder, Cloneable

Enclosing class:

InstanceConfig

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

Method Summary

Modifier and Type	Method and Description
InstanceConfig.Builder	addAllLeaderOptions(Iterable<String> values) Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
InstanceConfig.Builder	addAllReplicas(Iterable<? extends ReplicaInfo> values) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	addLeaderOptions(String value) Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
InstanceConfig.Builder	addLeaderOptionsBytes(ByteString value) Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
InstanceConfig.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
InstanceConfig.Builder	addReplicas(int index, ReplicaInfo.Builder builderForValue) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	addReplicas(int index, ReplicaInfo value) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	addReplicas(ReplicaInfo.Builder builderForValue) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	addReplicas(ReplicaInfo value) The geographic placement of nodes in this instance configuration and their replication properties.
ReplicaInfo.Builder	addReplicasBuilder() The geographic placement of nodes in this instance configuration and their replication properties.
ReplicaInfo.Builder	addReplicasBuilder(int index) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig	build()
InstanceConfig	buildPartial()
InstanceConfig.Builder	clear()
InstanceConfig.Builder	clearDisplayName() The name of this instance configuration as it appears in UIs.
InstanceConfig.Builder	clearField(Descriptors.FieldDescriptor field)
InstanceConfig.Builder	clearLeaderOptions() Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
InstanceConfig.Builder	clearName() A unique identifier for the instance configuration.
InstanceConfig.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
InstanceConfig.Builder	clearReplicas() The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	clone()
InstanceConfig	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getDisplayName() The name of this instance configuration as it appears in UIs.
ByteString	getDisplayNameBytes() The name of this instance configuration as it appears in UIs.
String	getLeaderOptions(int index) Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
ByteString	getLeaderOptionsBytes(int index) Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
int	getLeaderOptionsCount() Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
ProtocolStringList	getLeaderOptionsList() 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.
ByteString	getNameBytes() A unique identifier for the instance configuration.
ReplicaInfo	getReplicas(int index) The geographic placement of nodes in this instance configuration and their replication properties.
ReplicaInfo.Builder	getReplicasBuilder(int index) The geographic placement of nodes in this instance configuration and their replication properties.
List<ReplicaInfo.Builder>	getReplicasBuilderList() The geographic placement of nodes in this instance configuration and their replication properties.
int	getReplicasCount() The geographic placement of nodes in this instance configuration and their replication properties.
List<ReplicaInfo>	getReplicasList() The geographic placement of nodes in this instance configuration and their replication properties.
ReplicaInfoOrBuilder	getReplicasOrBuilder(int index) The geographic placement of nodes in this instance configuration and their replication properties.
List<? extends ReplicaInfoOrBuilder>	getReplicasOrBuilderList() The geographic placement of nodes in this instance configuration and their replication properties.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
InstanceConfig.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
InstanceConfig.Builder	mergeFrom(InstanceConfig other)
InstanceConfig.Builder	mergeFrom(Message other)
InstanceConfig.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
InstanceConfig.Builder	removeReplicas(int index) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	setDisplayName(String value) The name of this instance configuration as it appears in UIs.
InstanceConfig.Builder	setDisplayNameBytes(ByteString value) The name of this instance configuration as it appears in UIs.
InstanceConfig.Builder	setField(Descriptors.FieldDescriptor field, Object value)
InstanceConfig.Builder	setLeaderOptions(int index, String value) Allowed values of the “default_leader” schema option for databases in instances that use this instance configuration.
InstanceConfig.Builder	setName(String value) A unique identifier for the instance configuration.
InstanceConfig.Builder	setNameBytes(ByteString value) A unique identifier for the instance configuration.
InstanceConfig.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
InstanceConfig.Builder	setReplicas(int index, ReplicaInfo.Builder builderForValue) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	setReplicas(int index, ReplicaInfo value) The geographic placement of nodes in this instance configuration and their replication properties.
InstanceConfig.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

clear

public InstanceConfig.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

getDefaultInstanceForType

public InstanceConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public InstanceConfig build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public InstanceConfig buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public InstanceConfig.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

setField

public InstanceConfig.Builder setField(Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

clearField

public InstanceConfig.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

clearOneof

public InstanceConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

addRepeatedField

public InstanceConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

mergeFrom

public InstanceConfig.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<InstanceConfig.Builder>

mergeFrom

public InstanceConfig.Builder mergeFrom(InstanceConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

mergeFrom

public InstanceConfig.Builder mergeFrom(CodedInputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<InstanceConfig.Builder>

Throws:

IOException

getName

public String getName()

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

string name = 1;

Specified by:

getName in interface InstanceConfigOrBuilder

Returns:

The name.

getNameBytes

public ByteString getNameBytes()

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

string name = 1;

Specified by:

getNameBytes in interface InstanceConfigOrBuilder

Returns:

The bytes for name.

setName

public InstanceConfig.Builder setName(String value)

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

string name = 1;

Parameters:

value - The name to set.

Returns:

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][-a-z0-9]*`
 

string name = 1;

Returns:

This builder for chaining.

setNameBytes

public InstanceConfig.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

getDisplayName

public String getDisplayName()

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

string display_name = 2;

Specified by:

getDisplayName in interface InstanceConfigOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Specified by:

getDisplayNameBytes in interface InstanceConfigOrBuilder

Returns:

The bytes for displayName.

setDisplayName

public InstanceConfig.Builder setDisplayName(String value)

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

string display_name = 2;

Parameters:

value - The displayName to set.

Returns:

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:

This builder for chaining.

setDisplayNameBytes

public InstanceConfig.Builder setDisplayNameBytes(ByteString value)

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

string display_name = 2;

Parameters:

value - The bytes for displayName to set.

Returns:

This builder for chaining.

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;

Specified by:

getReplicasList in interface InstanceConfigOrBuilder

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;

Specified by:

getReplicasCount in interface InstanceConfigOrBuilder

getReplicas

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;

Specified by:

getReplicas in interface InstanceConfigOrBuilder

setReplicas

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;

setReplicas

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;

addReplicas

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;

addReplicas

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;

addReplicas

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;

addReplicas

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;

addAllReplicas

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;

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;

removeReplicas

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;

getReplicasBuilder

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;

getReplicasOrBuilder

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;

Specified by:

getReplicasOrBuilder in interface InstanceConfigOrBuilder

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;

Specified by:

getReplicasOrBuilderList in interface InstanceConfigOrBuilder

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;

addReplicasBuilder

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;

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;

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;

Specified by:

getLeaderOptionsList in interface InstanceConfigOrBuilder

Returns:

A list containing the leaderOptions.

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;

Specified by:

getLeaderOptionsCount in interface InstanceConfigOrBuilder

Returns:

The count of leaderOptions.

getLeaderOptions

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;

Specified by:

getLeaderOptions in interface InstanceConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The leaderOptions at the given index.

getLeaderOptionsBytes

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;

Specified by:

getLeaderOptionsBytes in interface InstanceConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the leaderOptions at the given index.

setLeaderOptions

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:

index - The index to set the value at.

value - The leaderOptions to set.

Returns:

This builder for chaining.

addLeaderOptions

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;

Parameters:

value - The leaderOptions to add.

Returns:

This builder for chaining.

addAllLeaderOptions

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;

Parameters:

values - The leaderOptions to add.

Returns:

This builder for chaining.

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:

This builder for chaining.

addLeaderOptionsBytes

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;

Parameters:

value - The bytes of the leaderOptions to add.

Returns:

This builder for chaining.

setUnknownFields

public final InstanceConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<InstanceConfig.Builder>

mergeUnknownFields

public final InstanceConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<InstanceConfig.Builder>