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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BASE_CONFIG_FIELD_NUMBER
public static final int BASE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONFIG_TYPE_FIELD_NUMBER
public static final int CONFIG_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LEADER_OPTIONS_FIELD_NUMBER
public static final int LEADER_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OPTIONAL_REPLICAS_FIELD_NUMBER
public static final int OPTIONAL_REPLICAS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REPLICAS_FIELD_NUMBER
public static final int REPLICAS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static InstanceConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static InstanceConfig.Builder newBuilder()
newBuilder(InstanceConfig prototype)
public static InstanceConfig.Builder newBuilder(InstanceConfig prototype)
public static InstanceConfig parseDelimitedFrom(InputStream input)
public static InstanceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static InstanceConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static InstanceConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(CodedInputStream input)
public static InstanceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(InputStream input)
public static InstanceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static InstanceConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<InstanceConfig> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
a-z{0,62}.
- Label values must be between 0 and 63 characters long and must conform
to the regular expression
[a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. Therefore, you are advised to use
an internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "" + value would prove problematic if we were to
allow "" in a future release.
map<string, string> labels = 8;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBaseConfig()
public String getBaseConfig()
Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
based on which this configuration is created. Only set for user managed
configurations. base_config must refer to a configuration of type
GOOGLE_MANAGED in the same project as this configuration.
string base_config = 7 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The baseConfig.
|
getBaseConfigBytes()
public ByteString getBaseConfigBytes()
Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
based on which this configuration is created. Only set for user managed
configurations. base_config must refer to a configuration of type
GOOGLE_MANAGED in the same project as this configuration.
string base_config = 7 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for baseConfig.
|
getConfigType()
public InstanceConfig.Type getConfigType()
Output only. Whether this instance configuration is a Google-managed or
user-managed configuration.
.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getConfigTypeValue()
public int getConfigTypeValue()
Output only. Whether this instance configuration is a Google-managed or
user-managed configuration.
.google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for configType.
|
getDefaultInstanceForType()
public InstanceConfig getDefaultInstanceForType()
getDisplayName()
public String getDisplayName()
The name of this instance configuration as it appears in UIs.
string display_name = 2;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The name of this instance configuration as it appears in UIs.
string display_name = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getEtag()
etag is used for optimistic concurrency control as a way
to help prevent simultaneous updates of a instance configuration from
overwriting each other. It is strongly suggested that systems make use of
the etag in the read-modify-write cycle to perform instance configuration
updates in order to avoid race conditions: An etag is returned in the
response which contains instance configurations, and systems are expected
to put that etag in the request to update instance configuration to ensure
that their change is applied to the same version of the instance
configuration. If no etag is provided in the call to update the instance
configuration, then the existing instance configuration is overwritten
blindly.
string etag = 9;
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
etag is used for optimistic concurrency control as a way
to help prevent simultaneous updates of a instance configuration from
overwriting each other. It is strongly suggested that systems make use of
the etag in the read-modify-write cycle to perform instance configuration
updates in order to avoid race conditions: An etag is returned in the
response which contains instance configurations, and systems are expected
to put that etag in the request to update instance configuration to ensure
that their change is applied to the same version of the instance
configuration. If no etag is provided in the call to update the instance
configuration, then the existing instance configuration is overwritten
blindly.
string etag = 9;
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
a-z{0,62}.
- Label values must be between 0 and 63 characters long and must conform
to the regular expression
[a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. Therefore, you are advised to use
an internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "" + value would prove problematic if we were to
allow "" in a future release.
map<string, string> labels = 8;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
a-z{0,62}.
- Label values must be between 0 and 63 characters long and must conform
to the regular expression
[a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. Therefore, you are advised to use
an internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "" + value would prove problematic if we were to
allow "" in a future release.
map<string, string> labels = 8;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
a-z{0,62}.
- Label values must be between 0 and 63 characters long and must conform
to the regular expression
[a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. Therefore, you are advised to use
an internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "" + value would prove problematic if we were to
allow "" in a future release.
map<string, string> labels = 8;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Cloud Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. Cloud Labels can be used to filter collections of
resources. They can be used to control how resource metrics are aggregated.
And they can be used as arguments to policy management rules (e.g. route,
firewall, load balancing, etc.).
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
a-z{0,62}.
- Label values must be between 0 and 63 characters long and must conform
to the regular expression
[a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource.
See https://goo.gl/xmQnxf for more information on and examples of labels.
If you plan to use labels in your own code, please note that additional
characters may be allowed in the future. Therefore, you are advised to use
an internal label representation, such as JSON, which doesn't rely upon
specific characters being disallowed. For example, representing labels
as the string: name + "" + value would prove problematic if we were to
allow "" in a future release.
map<string, string> labels = 8;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getLeaderOptions(int index)
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;
| Parameter |
| 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 "default_leader" schema option for databases in
instances that use this instance configuration.
repeated string leader_options = 4;
| Parameter |
| 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 "default_leader" schema option for databases in
instances that use this instance configuration.
repeated string leader_options = 4;
| Returns |
| Type |
Description |
int |
The count of leaderOptions.
|
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;
getName()
A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/a-z*.
User instance configuration must start with custom-.
string name = 1;
| Returns |
| 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*.
User instance configuration must start with custom-.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getOptionalReplicas(int index)
public ReplicaInfo getOptionalReplicas(int index)
Output only. The available optional replicas to choose from for user
managed configurations. Populated for Google managed configurations.
repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
getOptionalReplicasCount()
public int getOptionalReplicasCount()
Output only. The available optional replicas to choose from for user
managed configurations. Populated for Google managed configurations.
repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
getOptionalReplicasList()
public List<ReplicaInfo> getOptionalReplicasList()
Output only. The available optional replicas to choose from for user
managed configurations. Populated for Google managed configurations.
repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getOptionalReplicasOrBuilder(int index)
public ReplicaInfoOrBuilder getOptionalReplicasOrBuilder(int index)
Output only. The available optional replicas to choose from for user
managed configurations. Populated for Google managed configurations.
repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
|
getOptionalReplicasOrBuilderList()
public List<? extends ReplicaInfoOrBuilder> getOptionalReplicasOrBuilderList()
Output only. The available optional replicas to choose from for user
managed configurations. Populated for Google managed configurations.
repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder> |
|
getParserForType()
public Parser<InstanceConfig> getParserForType()
Overrides
getReconciling()
public boolean getReconciling()
Output only. If true, the instance configuration is being created or
updated. If false, there are no ongoing operations for the instance
configuration.
bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
The reconciling.
|
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 |
| Name |
Description |
index |
int
|
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 |
| 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;
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 |
| Name |
Description |
index |
int
|
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 |
| Type |
Description |
List<? extends com.google.spanner.admin.instance.v1.ReplicaInfoOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public InstanceConfig.State getState()
Output only. The current instance configuration state. Applicable only for
USER_MANAGED configurations.
.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The current instance configuration state. Applicable only for
USER_MANAGED configurations.
.google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public InstanceConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public InstanceConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
