Package com.google.bigtable.admin.v2

Class Instance

  • All Implemented Interfaces:
    InstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Instance
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Instance.Builder
      A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and the resources that serve them.
      static class  Instance.State
      Possible states of an instance.
      static class  Instance.Type
      The type of the instance.

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method 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 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.
      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 getSatisfiesPzs()
      Output only.
      int getSerializedSize()  
      Instance.State getState()
      (`OutputOnly`) The current state of the instance.
      int getStateValue()
      (`OutputOnly`) The current state of the instance.
      Instance.Type getType()
      The type of the instance.
      int getTypeValue()
      The type of the instance.
      boolean hasCreateTime()
      Output only.
      int hashCode()  
      boolean hasSatisfiesPzs()
      Output only.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      boolean isInitialized()  
      static Instance.Builder newBuilder()  
      static Instance.Builder newBuilder​(Instance prototype)  
      Instance.Builder newBuilderForType()  
      protected Instance.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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​(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 Instance parseFrom​(ByteBuffer data)  
      static Instance parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Instance> parser()  
      Instance.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public 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;
        Specified by:
        getName in interface InstanceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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;
        Specified by:
        getNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public 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];
        Specified by:
        getDisplayName in interface InstanceOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public 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];
        Specified by:
        getDisplayNameBytes in interface InstanceOrBuilder
        Returns:
        The bytes for displayName.

      • getStateValue

        public int getStateValue()
         (`OutputOnly`)
 The current state of the instance.
        .google.bigtable.admin.v2.Instance.State state = 3;
        Specified by:
        getStateValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getState

        public Instance.State getState()
         (`OutputOnly`)
 The current state of the instance.
        .google.bigtable.admin.v2.Instance.State state = 3;
        Specified by:
        getState in interface InstanceOrBuilder
        Returns:
        The state.

      • getTypeValue

        public int getTypeValue()
         The type of the instance. Defaults to `PRODUCTION`.
        .google.bigtable.admin.v2.Instance.Type type = 4;
        Specified by:
        getTypeValue in interface InstanceOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public Instance.Type getType()
         The type of the instance. Defaults to `PRODUCTION`.
        .google.bigtable.admin.v2.Instance.Type type = 4;
        Specified by:
        getType in interface InstanceOrBuilder
        Returns:
        The type.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: 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;
        Specified by:
        getLabelsCount in interface InstanceOrBuilder

      • containsLabels

        public 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;
        Specified by:
        containsLabels in interface InstanceOrBuilder

      • getLabelsMap

        public 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;
        Specified by:
        getLabelsMap in interface InstanceOrBuilder

      • getLabelsOrDefault

        public 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;
        Specified by:
        getLabelsOrDefault in interface InstanceOrBuilder

      • getLabelsOrThrow

        public 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;
        Specified by:
        getLabelsOrThrow in interface InstanceOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. A server-assigned 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];
        Specified by:
        hasCreateTime in interface InstanceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. A server-assigned 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];
        Specified by:
        getCreateTime in interface InstanceOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. A server-assigned 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];
        Specified by:
        getCreateTimeOrBuilder in interface InstanceOrBuilder

      • hasSatisfiesPzs

        public boolean hasSatisfiesPzs()
         Output only. Reserved for future use.
        optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSatisfiesPzs in interface InstanceOrBuilder
        Returns:
        Whether the satisfiesPzs field is set.

      • getSatisfiesPzs

        public boolean getSatisfiesPzs()
         Output only. Reserved for future use.
        optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSatisfiesPzs in interface InstanceOrBuilder
        Returns:
        The satisfiesPzs.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Instance parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Instance.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Instance.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Instance.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Instance getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Instance> parser()

      • getParserForType

        public com.google.protobuf.Parser<Instance> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Instance getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder