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
LEADER_OPTIONS_FIELD_NUMBER
public static final int LEADER_OPTIONS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
REPLICAS_FIELD_NUMBER
public static final int REPLICAS_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static InstanceConfig getDefaultInstance()
Returns
getDefaultInstanceForType()
public InstanceConfig getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDisplayName()
public String getDisplayName()
The name of this instance configuration as it appears in UIs.
string display_name = 2;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The name of this instance configuration as it appears in UIs.
string display_name = 2;
| 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;
| 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;
| 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;
| 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;
getName()
A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/a-z*
string name = 1;
| 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;
getParserForType()
public Parser<InstanceConfig> getParserForType()
Returns
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static InstanceConfig.Builder newBuilder()
Returns
newBuilder(InstanceConfig prototype)
public static InstanceConfig.Builder newBuilder(InstanceConfig prototype)
Parameter
Returns
newBuilderForType()
public InstanceConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static InstanceConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static InstanceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static InstanceConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static InstanceConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static InstanceConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static InstanceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static InstanceConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static InstanceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static InstanceConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<InstanceConfig> parser()
Returns
toBuilder()
public InstanceConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
