public final class Instance extends GeneratedMessageV3 implements InstanceOrBuilder
An isolated set of Cloud Spanner resources on which databases can be hosted.Protobuf type
google.spanner.admin.instance.v1.Instance| Modifier and Type | Class and Description |
|---|---|
static class |
Instance.Builder
An isolated set of Cloud Spanner resources on which databases can be hosted.
|
static class |
Instance.State
Indicates the current state of the instance.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
CONFIG_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
ENDPOINT_URIS_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
NODE_COUNT_FIELD_NUMBER |
static int |
PROCESSING_UNITS_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCode| Modifier and Type | Method and Description |
|---|---|
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.
|
boolean |
equals(Object obj) |
String |
getConfig()
Required.
|
ByteString |
getConfigBytes()
Required.
|
static Instance |
getDefaultInstance() |
Instance |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
ByteString |
getDisplayNameBytes()
Required.
|
String |
getEndpointUris(int index)
Deprecated.
|
ByteString |
getEndpointUrisBytes(int index)
Deprecated.
|
int |
getEndpointUrisCount()
Deprecated.
|
ProtocolStringList |
getEndpointUrisList()
Deprecated.
|
Map<String,String> |
getLabels()
Deprecated.
|
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.
|
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.
|
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.
|
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.
|
String |
getName()
Required.
|
ByteString |
getNameBytes()
Required.
|
int |
getNodeCount()
Required.
|
Parser<Instance> |
getParserForType() |
int |
getProcessingUnits()
The number of processing units allocated to this instance.
|
int |
getSerializedSize() |
Instance.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Instance.Builder |
newBuilder() |
static Instance.Builder |
newBuilder(Instance prototype) |
Instance.Builder |
newBuilderForType() |
protected Instance.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) |
static Instance |
parseDelimitedFrom(InputStream input) |
static Instance |
parseDelimitedFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(byte[] data) |
static Instance |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(ByteBuffer data) |
static Instance |
parseFrom(ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(ByteString data) |
static Instance |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(CodedInputStream input) |
static Instance |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(InputStream input) |
static Instance |
parseFrom(InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<Instance> |
parser() |
Instance.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int NAME_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int NODE_COUNT_FIELD_NUMBER
public static final int PROCESSING_UNITS_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ENDPOINT_URIS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public String getName()
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getName in interface InstanceOrBuilderpublic ByteString getNameBytes()
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getNameBytes in interface InstanceOrBuilderpublic String getConfig()
Required. The name of the instance's configuration. Values are of the form `projects/<project>/instanceConfigs/<configuration>`. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getConfig in interface InstanceOrBuilderpublic ByteString getConfigBytes()
Required. The name of the instance's configuration. Values are of the form `projects/<project>/instanceConfigs/<configuration>`. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getConfigBytes in interface InstanceOrBuilderpublic String getDisplayName()
Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface InstanceOrBuilderpublic ByteString getDisplayNameBytes()
Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
string display_name = 3 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface InstanceOrBuilderpublic int getNodeCount()
Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/instances#node_count) for more information about nodes.
int32 node_count = 5;getNodeCount in interface InstanceOrBuilderpublic int getProcessingUnits()
The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for instances that are not yet in state `READY`.
int32 processing_units = 9;getProcessingUnits in interface InstanceOrBuilderpublic int getStateValue()
Output only. The current instance state. For [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be either omitted or set to `CREATING`. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set to `READY`.
.google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface InstanceOrBuilderpublic Instance.State getState()
Output only. The current instance state. For [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be either omitted or set to `CREATING`. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set to `READY`.
.google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface InstanceOrBuilderpublic int getLabelsCount()
InstanceOrBuilder
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]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* 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. And so 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 = 7;getLabelsCount in interface InstanceOrBuilderpublic 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]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* 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. And so 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 = 7;containsLabels in interface InstanceOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface InstanceOrBuilderpublic 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]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* 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. And so 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 = 7;getLabelsMap in interface InstanceOrBuilderpublic 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]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* 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. And so 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 = 7;getLabelsOrDefault in interface InstanceOrBuilderpublic 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]([-a-z0-9]*[a-z0-9])?`.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
* 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. And so 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 = 7;getLabelsOrThrow in interface InstanceOrBuilderpublic ProtocolStringList getEndpointUrisList()
Deprecated. This field is not populated.
repeated string endpoint_uris = 8;getEndpointUrisList in interface InstanceOrBuilderpublic int getEndpointUrisCount()
Deprecated. This field is not populated.
repeated string endpoint_uris = 8;getEndpointUrisCount in interface InstanceOrBuilderpublic String getEndpointUris(int index)
Deprecated. This field is not populated.
repeated string endpoint_uris = 8;getEndpointUris in interface InstanceOrBuilderindex - The index of the element to return.public ByteString getEndpointUrisBytes(int index)
Deprecated. This field is not populated.
repeated string endpoint_uris = 8;getEndpointUrisBytes in interface InstanceOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static Instance parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Instance parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Instance parseFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Instance.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static Instance.Builder newBuilder()
public static Instance.Builder newBuilder(Instance prototype)
public Instance.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static Instance getDefaultInstance()
public Parser<Instance> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public Instance getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.