com.google.spanner.admin.instance.v1

Class InstanceConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, InstanceConfigOrBuilder, Serializable

public final class InstanceConfig
extends GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceConfig.Builder A possible configuration for a Cloud Spanner instance.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISPLAY_NAME_FIELD_NUMBER
static int	LEADER_OPTIONS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	REPLICAS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static InstanceConfig	getDefaultInstance()
InstanceConfig	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
Parser<InstanceConfig>	getParserForType()
ReplicaInfo	getReplicas(int index) 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.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static InstanceConfig.Builder	newBuilder()
static InstanceConfig.Builder	newBuilder(InstanceConfig prototype)
InstanceConfig.Builder	newBuilderForType()
protected InstanceConfig.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static InstanceConfig	parseDelimitedFrom(InputStream input)
static InstanceConfig	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static InstanceConfig	parseFrom(byte[] data)
static InstanceConfig	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static InstanceConfig	parseFrom(ByteBuffer data)
static InstanceConfig	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static InstanceConfig	parseFrom(ByteString data)
static InstanceConfig	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static InstanceConfig	parseFrom(CodedInputStream input)
static InstanceConfig	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static InstanceConfig	parseFrom(InputStream input)
static InstanceConfig	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<InstanceConfig>	parser()
InstanceConfig.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

REPLICAS_FIELD_NUMBER

public static final int REPLICAS_FIELD_NUMBER

See Also:

Constant Field Values

LEADER_OPTIONS_FIELD_NUMBER

public static final int LEADER_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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.

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.

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

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

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

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

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static InstanceConfig parseFrom(ByteBuffer data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static InstanceConfig parseFrom(ByteBuffer data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static InstanceConfig parseFrom(ByteString data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static InstanceConfig parseFrom(ByteString data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static InstanceConfig parseFrom(byte[] data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static InstanceConfig parseFrom(byte[] data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static InstanceConfig parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static InstanceConfig parseFrom(InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static InstanceConfig parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static InstanceConfig parseDelimitedFrom(InputStream input,
                                                ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static InstanceConfig parseFrom(CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static InstanceConfig parseFrom(CodedInputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public InstanceConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static InstanceConfig.Builder newBuilder()

newBuilder

public static InstanceConfig.Builder newBuilder(InstanceConfig prototype)

toBuilder

public InstanceConfig.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static InstanceConfig getDefaultInstance()

parser

public static Parser<InstanceConfig> parser()

getParserForType

public Parser<InstanceConfig> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public InstanceConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder