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:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,InstanceConfigOrBuilder,Serializable
public final class InstanceConfig
extends com.google.protobuf.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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA possible configuration for a Cloud Spanner instance.static enumDescribes the availability for free instances to be created in an instance configuration.static enumIndicates the quorum type of this instance configuration.static enumIndicates the current state of the instance configuration.static enumThe type of this configuration.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(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.booleanBase configuration name, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this configuration is created.com.google.protobuf.ByteStringBase configuration name, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this configuration is created.Output only.intOutput only.static InstanceConfigstatic final com.google.protobuf.Descriptors.DescriptorThe name of this instance configuration as it appears in UIs.com.google.protobuf.ByteStringThe name of this instance configuration as it appears in UIs.getEtag()etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other.com.google.protobuf.ByteStringetag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other.Output only.intOutput only.Deprecated.intCloud 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 are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies.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.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.getLeaderOptions(int index) Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.com.google.protobuf.ByteStringgetLeaderOptionsBytes(int index) Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.intAllowed values of the "default_leader" schema option for databases in instances that use this instance configuration.com.google.protobuf.ProtocolStringListAllowed values of the "default_leader" schema option for databases in instances that use this instance configuration.getName()A unique identifier for the instance configuration.com.google.protobuf.ByteStringA unique identifier for the instance configuration.getOptionalReplicas(int index) Output only.intOutput only.Output only.getOptionalReplicasOrBuilder(int index) Output only.List<? extends ReplicaInfoOrBuilder>Output only.com.google.protobuf.Parser<InstanceConfig>Output only.intOutput only.booleanOutput only.getReplicas(int index) The geographic placement of nodes in this instance configuration and their replication properties.intThe geographic placement of nodes in this instance configuration and their replication properties.The geographic placement of nodes in this instance configuration and their replication properties.getReplicasOrBuilder(int index) The geographic placement of nodes in this instance configuration and their replication properties.List<? extends ReplicaInfoOrBuilder>The geographic placement of nodes in this instance configuration and their replication properties.intgetState()Output only.intOutput only.longOutput only.inthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic InstanceConfig.Builderstatic InstanceConfig.BuildernewBuilder(InstanceConfig prototype) protected InstanceConfig.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static InstanceConfigparseDelimitedFrom(InputStream input) static InstanceConfigparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InstanceConfigparseFrom(byte[] data) static InstanceConfigparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InstanceConfigparseFrom(com.google.protobuf.ByteString data) static InstanceConfigparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InstanceConfigparseFrom(com.google.protobuf.CodedInputStream input) static InstanceConfigparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InstanceConfigparseFrom(InputStream input) static InstanceConfigparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static InstanceConfigparseFrom(ByteBuffer data) static InstanceConfigparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<InstanceConfig>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
CONFIG_TYPE_FIELD_NUMBER
public static final int CONFIG_TYPE_FIELD_NUMBER- See Also:
-
REPLICAS_FIELD_NUMBER
public static final int REPLICAS_FIELD_NUMBER- See Also:
-
OPTIONAL_REPLICAS_FIELD_NUMBER
public static final int OPTIONAL_REPLICAS_FIELD_NUMBER- See Also:
-
BASE_CONFIG_FIELD_NUMBER
public static final int BASE_CONFIG_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER- See Also:
-
LEADER_OPTIONS_FIELD_NUMBER
public static final int LEADER_OPTIONS_FIELD_NUMBER- See Also:
-
RECONCILING_FIELD_NUMBER
public static final int RECONCILING_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
FREE_INSTANCE_AVAILABILITY_FIELD_NUMBER
public static final int FREE_INSTANCE_AVAILABILITY_FIELD_NUMBER- See Also:
-
QUORUM_TYPE_FIELD_NUMBER
public static final int QUORUM_TYPE_FIELD_NUMBER- See Also:
-
STORAGE_LIMIT_PER_PROCESSING_UNIT_FIELD_NUMBER
public static final int STORAGE_LIMIT_PER_PROCESSING_UNIT_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getName
A unique identifier for the instance configuration. Values are of the form `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`. User instance configuration must start with `custom-`.
string name = 1;- Specified by:
getNamein interfaceInstanceConfigOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()A unique identifier for the instance configuration. Values are of the form `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`. User instance configuration must start with `custom-`.
string name = 1;- Specified by:
getNameBytesin interfaceInstanceConfigOrBuilder- Returns:
- The bytes for name.
-
getDisplayName
The name of this instance configuration as it appears in UIs.
string display_name = 2;- Specified by:
getDisplayNamein interfaceInstanceConfigOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()The name of this instance configuration as it appears in UIs.
string display_name = 2;- Specified by:
getDisplayNameBytesin interfaceInstanceConfigOrBuilder- Returns:
- The bytes for displayName.
-
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];- Specified by:
getConfigTypeValuein interfaceInstanceConfigOrBuilder- Returns:
- The enum numeric value on the wire for configType.
-
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];- Specified by:
getConfigTypein interfaceInstanceConfigOrBuilder- Returns:
- The configType.
-
getReplicasList
The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;- Specified by:
getReplicasListin interfaceInstanceConfigOrBuilder
-
getReplicasOrBuilderList
The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;- Specified by:
getReplicasOrBuilderListin interfaceInstanceConfigOrBuilder
-
getReplicasCount
public int getReplicasCount()The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;- Specified by:
getReplicasCountin interfaceInstanceConfigOrBuilder
-
getReplicas
The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;- Specified by:
getReplicasin interfaceInstanceConfigOrBuilder
-
getReplicasOrBuilder
The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.
repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;- Specified by:
getReplicasOrBuilderin interfaceInstanceConfigOrBuilder
-
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];- Specified by:
getOptionalReplicasListin interfaceInstanceConfigOrBuilder
-
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];- Specified by:
getOptionalReplicasOrBuilderListin interfaceInstanceConfigOrBuilder
-
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];- Specified by:
getOptionalReplicasCountin interfaceInstanceConfigOrBuilder
-
getOptionalReplicas
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];- Specified by:
getOptionalReplicasin interfaceInstanceConfigOrBuilder
-
getOptionalReplicasOrBuilder
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];- Specified by:
getOptionalReplicasOrBuilderin interfaceInstanceConfigOrBuilder
-
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) = { ... }- Specified by:
getBaseConfigin interfaceInstanceConfigOrBuilder- Returns:
- The baseConfig.
-
getBaseConfigBytes
public com.google.protobuf.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) = { ... }- Specified by:
getBaseConfigBytesin interfaceInstanceConfigOrBuilder- Returns:
- The bytes for baseConfig.
-
getLabelsCount
public int getLabelsCount()Description copied from interface:InstanceConfigOrBuilderCloud 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][a-z0-9_-]{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;- Specified by:
getLabelsCountin interfaceInstanceConfigOrBuilder
-
containsLabels
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][a-z0-9_-]{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;- Specified by:
containsLabelsin interfaceInstanceConfigOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceInstanceConfigOrBuilder
-
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][a-z0-9_-]{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;- Specified by:
getLabelsMapin interfaceInstanceConfigOrBuilder
-
getLabelsOrDefault
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][a-z0-9_-]{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;- Specified by:
getLabelsOrDefaultin interfaceInstanceConfigOrBuilder
-
getLabelsOrThrow
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][a-z0-9_-]{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;- Specified by:
getLabelsOrThrowin interfaceInstanceConfigOrBuilder
-
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;- Specified by:
getEtagin interfaceInstanceConfigOrBuilder- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.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;- Specified by:
getEtagBytesin interfaceInstanceConfigOrBuilder- Returns:
- The bytes for etag.
-
getLeaderOptionsList
public com.google.protobuf.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:
getLeaderOptionsListin interfaceInstanceConfigOrBuilder- 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:
getLeaderOptionsCountin interfaceInstanceConfigOrBuilder- Returns:
- The count of leaderOptions.
-
getLeaderOptions
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
repeated string leader_options = 4;- Specified by:
getLeaderOptionsin interfaceInstanceConfigOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The leaderOptions at the given index.
-
getLeaderOptionsBytes
public com.google.protobuf.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:
getLeaderOptionsBytesin interfaceInstanceConfigOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the leaderOptions at the given index.
-
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];- Specified by:
getReconcilingin interfaceInstanceConfigOrBuilder- Returns:
- The reconciling.
-
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];- Specified by:
getStateValuein interfaceInstanceConfigOrBuilder- Returns:
- The enum numeric value on the wire for 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];- Specified by:
getStatein interfaceInstanceConfigOrBuilder- Returns:
- The state.
-
getFreeInstanceAvailabilityValue
public int getFreeInstanceAvailabilityValue()Output only. Describes whether free instances are available to be created in this instance configuration.
.google.spanner.admin.instance.v1.InstanceConfig.FreeInstanceAvailability free_instance_availability = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getFreeInstanceAvailabilityValuein interfaceInstanceConfigOrBuilder- Returns:
- The enum numeric value on the wire for freeInstanceAvailability.
-
getFreeInstanceAvailability
Output only. Describes whether free instances are available to be created in this instance configuration.
.google.spanner.admin.instance.v1.InstanceConfig.FreeInstanceAvailability free_instance_availability = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getFreeInstanceAvailabilityin interfaceInstanceConfigOrBuilder- Returns:
- The freeInstanceAvailability.
-
getQuorumTypeValue
public int getQuorumTypeValue()Output only. The `QuorumType` of the instance configuration.
.google.spanner.admin.instance.v1.InstanceConfig.QuorumType quorum_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getQuorumTypeValuein interfaceInstanceConfigOrBuilder- Returns:
- The enum numeric value on the wire for quorumType.
-
getQuorumType
Output only. The `QuorumType` of the instance configuration.
.google.spanner.admin.instance.v1.InstanceConfig.QuorumType quorum_type = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getQuorumTypein interfaceInstanceConfigOrBuilder- Returns:
- The quorumType.
-
getStorageLimitPerProcessingUnit
public long getStorageLimitPerProcessingUnit()Output only. The storage limit in bytes per processing unit.
int64 storage_limit_per_processing_unit = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStorageLimitPerProcessingUnitin interfaceInstanceConfigOrBuilder- Returns:
- The storageLimitPerProcessingUnit.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static InstanceConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InstanceConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InstanceConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InstanceConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InstanceConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static InstanceConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static InstanceConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static InstanceConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static InstanceConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static InstanceConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected InstanceConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-