Class InstanceConfig

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

Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LEADER_OPTIONS_FIELD_NUMBER

public static final int LEADER_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REPLICAS_FIELD_NUMBER

public static final int REPLICAS_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static InstanceConfig getDefaultInstance()
Returns
TypeDescription
InstanceConfig

getDefaultInstanceForType()

public InstanceConfig getDefaultInstanceForType()
Returns
TypeDescription
InstanceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDisplayName()

public String getDisplayName()

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

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

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

string display_name = 2;

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<InstanceConfig> getParserForType()
Returns
TypeDescription
Parser<InstanceConfig>
Overrides

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
NameDescription
indexint
Returns
TypeDescription
ReplicaInfo

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static InstanceConfig.Builder newBuilder()
Returns
TypeDescription
InstanceConfig.Builder

newBuilder(InstanceConfig prototype)

public static InstanceConfig.Builder newBuilder(InstanceConfig prototype)
Parameter
NameDescription
prototypeInstanceConfig
Returns
TypeDescription
InstanceConfig.Builder

newBuilderForType()

public InstanceConfig.Builder newBuilderForType()
Returns
TypeDescription
InstanceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InstanceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static InstanceConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InstanceConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstanceConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstanceConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InstanceConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InstanceConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InstanceConfig> parser()
Returns
TypeDescription
Parser<InstanceConfig>

toBuilder()

public InstanceConfig.Builder toBuilder()
Returns
TypeDescription
InstanceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException