Package com.google.bigtable.admin.v2

Interface InstanceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Instance, Instance.Builder
public interface InstanceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    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.
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    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.
    boolean
    getSatisfiesPzs()
    Output only.
    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.
    boolean
    hasSatisfiesPzs()
    Output only.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getDisplayName

      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];
      Returns:
      The displayName.

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getStateValue

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

    • getState

      Instance.State getState()
       (`OutputOnly`)
 The current state of the instance.
      .google.bigtable.admin.v2.Instance.State state = 3;
      Returns:
      The state.

    • getTypeValue

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

    • getType

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

    • getLabelsCount

      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. 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

      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;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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;

    • getLabelsOrDefault

      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;

    • getLabelsOrThrow

      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;

    • hasCreateTime

      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];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasSatisfiesPzs

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

    • getSatisfiesPzs

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