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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceConfigImplements
InstanceConfigOrBuilderStatic Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Type | Description |
int |
LEADER_OPTIONS_FIELD_NUMBER
public static final int LEADER_OPTIONS_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
REPLICAS_FIELD_NUMBER
public static final int REPLICAS_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static InstanceConfig getDefaultInstance()
Type | Description |
InstanceConfig |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static InstanceConfig.Builder newBuilder()
Type | Description |
InstanceConfig.Builder |
newBuilder(InstanceConfig prototype)
public static InstanceConfig.Builder newBuilder(InstanceConfig prototype)
Name | Description |
prototype | InstanceConfig |
Type | Description |
InstanceConfig.Builder |
parseDelimitedFrom(InputStream input)
public static InstanceConfig parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
InstanceConfig |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
InstanceConfig |
Type | Description |
IOException |
parseFrom(byte[] data)
public static InstanceConfig parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
InstanceConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
InstanceConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static InstanceConfig parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
InstanceConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
InstanceConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static InstanceConfig parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
InstanceConfig |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
InstanceConfig |
Type | Description |
IOException |
parseFrom(InputStream input)
public static InstanceConfig parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
InstanceConfig |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
InstanceConfig |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static InstanceConfig parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
InstanceConfig |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
InstanceConfig |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<InstanceConfig> parser()
Type | Description |
Parser<InstanceConfig> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getDefaultInstanceForType()
public InstanceConfig getDefaultInstanceForType()
Type | Description |
InstanceConfig |
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. |
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. |
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;
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;
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;
Type | Description |
ByteString | The bytes for name. |
getParserForType()
public Parser<InstanceConfig> getParserForType()
Type | Description |
Parser<InstanceConfig> |
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;
Name | Description |
index | int |
Type | Description |
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;
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;
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;
Name | Description |
index | int |
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;
Type | Description |
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder> |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public InstanceConfig.Builder newBuilderForType()
Type | Description |
InstanceConfig.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
InstanceConfig.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public InstanceConfig.Builder toBuilder()
Type | Description |
InstanceConfig.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |