@Generated public final class Instance extends com.google.protobuf.GeneratedMessage implements InstanceOrBuilder
A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and the resources that serve them. All tables in an instance are served from all [Clusters][google.bigtable.admin.v2.Cluster] in the instance.Protobuf type
google.bigtable.admin.v2.Instance| Modifier and Type | Class and Description |
|---|---|
static class |
Instance.Builder
A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and
the resources that serve them.
|
static class |
Instance.Edition
Possible editions of an instance.
|
static class |
Instance.State
Possible states of an instance.
|
static class |
Instance.Type
The type of the instance.
|
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
EDITION_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SATISFIES_PZI_FIELD_NUMBER |
static int |
SATISFIES_PZS_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
TAGS_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies.
|
boolean |
containsTags(String key)
Optional.
|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Instance |
getDefaultInstance() |
Instance |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
Instance.Edition |
getEdition()
Optional.
|
int |
getEditionValue()
Optional.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
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()
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)
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)
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()
The unique name of the instance.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique name of the instance.
|
com.google.protobuf.Parser<Instance> |
getParserForType() |
boolean |
getSatisfiesPzi()
Output only.
|
boolean |
getSatisfiesPzs()
Output only.
|
int |
getSerializedSize() |
Instance.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
Map<String,String> |
getTags()
Deprecated.
|
int |
getTagsCount()
Optional.
|
Map<String,String> |
getTagsMap()
Optional.
|
String |
getTagsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getTagsOrThrow(String key)
Optional.
|
Instance.Type |
getType()
The type of the instance.
|
int |
getTypeValue()
The type of the instance.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasSatisfiesPzi()
Output only.
|
boolean |
hasSatisfiesPzs()
Output only.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static Instance.Builder |
newBuilder() |
static Instance.Builder |
newBuilder(Instance prototype) |
Instance.Builder |
newBuilderForType() |
protected Instance.Builder |
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) |
static Instance |
parseDelimitedFrom(InputStream input) |
static Instance |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(byte[] data) |
static Instance |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(ByteBuffer data) |
static Instance |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(com.google.protobuf.ByteString data) |
static Instance |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Instance |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Instance |
parseFrom(InputStream input) |
static Instance |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Instance> |
parser() |
Instance.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
public static final int EDITION_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageprotected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic String getName()
The unique name of the instance. Values are of the form
`projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
string name = 1;getName in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The unique name of the instance. Values are of the form
`projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
string name = 1;getNameBytes in interface InstanceOrBuilderpublic String getDisplayName()
Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface InstanceOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface InstanceOrBuilderpublic int getStateValue()
Output only. The current state of the instance.
.google.bigtable.admin.v2.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface InstanceOrBuilderpublic Instance.State getState()
Output only. The current state of the instance.
.google.bigtable.admin.v2.Instance.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface InstanceOrBuilderpublic int getTypeValue()
The type of the instance. Defaults to `PRODUCTION`.
.google.bigtable.admin.v2.Instance.Type type = 4;getTypeValue in interface InstanceOrBuilderpublic Instance.Type getType()
The type of the instance. Defaults to `PRODUCTION`.
.google.bigtable.admin.v2.Instance.Type type = 4;getType in interface InstanceOrBuilderpublic int getEditionValue()
Optional. The edition of the instance. See [Edition][google.bigtable.admin.v2.Instance.Edition] for details.
.google.bigtable.admin.v2.Instance.Edition edition = 14 [(.google.api.field_behavior) = OPTIONAL];
getEditionValue in interface InstanceOrBuilderpublic Instance.Edition getEdition()
Optional. The edition of the instance. See [Edition][google.bigtable.admin.v2.Instance.Edition] for details.
.google.bigtable.admin.v2.Instance.Edition edition = 14 [(.google.api.field_behavior) = OPTIONAL];
getEdition in interface InstanceOrBuilderpublic int getLabelsCount()
InstanceOrBuilder
Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. They can be used to filter resources and aggregate
metrics.
* Label keys must be between 1 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
* Keys and values must both be under 128 bytes.
map<string, string> labels = 5;getLabelsCount in interface InstanceOrBuilderpublic boolean containsLabels(String key)
Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. They can be used to filter resources and aggregate
metrics.
* Label keys must be between 1 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
* Keys and values must both be under 128 bytes.
map<string, string> labels = 5;containsLabels in interface InstanceOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface InstanceOrBuilderpublic Map<String,String> getLabelsMap()
Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. They can be used to filter resources and aggregate
metrics.
* Label keys must be between 1 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
* Keys and values must both be under 128 bytes.
map<string, string> labels = 5;getLabelsMap in interface InstanceOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. They can be used to filter resources and aggregate
metrics.
* Label keys must be between 1 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
* Keys and values must both be under 128 bytes.
map<string, string> labels = 5;getLabelsOrDefault in interface InstanceOrBuilderpublic String getLabelsOrThrow(String key)
Labels are a flexible and lightweight mechanism for organizing cloud
resources into groups that reflect a customer's organizational needs and
deployment strategies. They can be used to filter resources and aggregate
metrics.
* Label keys must be between 1 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
* Label values must be between 0 and 63 characters long and must conform to
the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
* No more than 64 labels can be associated with a given resource.
* Keys and values must both be under 128 bytes.
map<string, string> labels = 5;getLabelsOrThrow in interface InstanceOrBuilderpublic boolean hasCreateTime()
Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface InstanceOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface InstanceOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface InstanceOrBuilderpublic boolean hasSatisfiesPzs()
Output only. Reserved for future use.
optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];hasSatisfiesPzs in interface InstanceOrBuilderpublic boolean getSatisfiesPzs()
Output only. Reserved for future use.
optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzs in interface InstanceOrBuilderpublic boolean hasSatisfiesPzi()
Output only. Reserved for future use.
optional bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];hasSatisfiesPzi in interface InstanceOrBuilderpublic boolean getSatisfiesPzi()
Output only. Reserved for future use.
optional bool satisfies_pzi = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];getSatisfiesPzi in interface InstanceOrBuilderpublic int getTagsCount()
InstanceOrBuilderOptional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
map<string, string> tags = 12 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getTagsCount in interface InstanceOrBuilderpublic boolean containsTags(String key)
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
map<string, string> tags = 12 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
containsTags in interface InstanceOrBuilder@Deprecated public Map<String,String> getTags()
getTagsMap() instead.getTags in interface InstanceOrBuilderpublic Map<String,String> getTagsMap()
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
map<string, string> tags = 12 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getTagsMap in interface InstanceOrBuilderpublic String getTagsOrDefault(String key, String defaultValue)
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
map<string, string> tags = 12 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getTagsOrDefault in interface InstanceOrBuilderpublic String getTagsOrThrow(String key)
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
map<string, string> tags = 12 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getTagsOrThrow in interface InstanceOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Instance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Instance parseFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Instance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Instance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Instance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Instance.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Instance.Builder newBuilder()
public static Instance.Builder newBuilder(Instance prototype)
public Instance.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Instance.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static Instance getDefaultInstance()
public static com.google.protobuf.Parser<Instance> parser()
public com.google.protobuf.Parser<Instance> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic Instance getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.