Package com.google.bigtable.admin.v2

Class Instance.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>
com.google.bigtable.admin.v2.Instance.Builder
All Implemented Interfaces:
InstanceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Instance
public static final class Instance.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder> 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

  • Method Details

    • 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.Builder<Instance.Builder>

    • internalGetMutableMapField

      protected com.google.protobuf.MapField internalGetMutableMapField(int number)
      Overrides:
      internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public Instance.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • clearField

      public Instance.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • clearOneof

      public Instance.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • setRepeatedField

      public Instance.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • addRepeatedField

      public Instance.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • mergeFrom

      public Instance.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Instance.Builder>

    • mergeFrom

      public Instance.Builder mergeFrom(Instance other)

    • isInitialized

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

    • mergeFrom

      public Instance.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Instance.Builder>
      Throws:
      IOException

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

    • setName

      public Instance.Builder setName(String value)
       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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Instance.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public Instance.Builder setNameBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

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

    • setDisplayName

      public Instance.Builder setDisplayName(String value)
       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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public Instance.Builder clearDisplayName()
       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:
      This builder for chaining.

    • setDisplayNameBytes

      public Instance.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

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

    • setStateValue

      public Instance.Builder setStateValue(int value)
       (`OutputOnly`)
 The current state of the instance.
      .google.bigtable.admin.v2.Instance.State state = 3;
      Parameters:
      value - The enum numeric value on the wire for state to set.
      Returns:
      This builder for chaining.

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

    • setState

      public Instance.Builder setState(Instance.State value)
       (`OutputOnly`)
 The current state of the instance.
      .google.bigtable.admin.v2.Instance.State state = 3;
      Parameters:
      value - The state to set.
      Returns:
      This builder for chaining.

    • clearState

      public Instance.Builder clearState()
       (`OutputOnly`)
 The current state of the instance.
      .google.bigtable.admin.v2.Instance.State state = 3;
      Returns:
      This builder for chaining.

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

    • setTypeValue

      public Instance.Builder setTypeValue(int value)
       The type of the instance. Defaults to `PRODUCTION`.
      .google.bigtable.admin.v2.Instance.Type type = 4;
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

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

    • setType

      public Instance.Builder setType(Instance.Type value)
       The type of the instance. Defaults to `PRODUCTION`.
      .google.bigtable.admin.v2.Instance.Type type = 4;
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public Instance.Builder clearType()
       The type of the instance. Defaults to `PRODUCTION`.
      .google.bigtable.admin.v2.Instance.Type type = 4;
      Returns:
      This builder for chaining.

    • 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

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels 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

    • clearLabels

      public Instance.Builder clearLabels()

    • removeLabels

      public Instance.Builder removeLabels(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;

    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.

    • putLabels

      public Instance.Builder putLabels(String key, String value)
       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;

    • putAllLabels

      public Instance.Builder putAllLabels(Map<String,String> values)
       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

      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.

    • setCreateTime

      public Instance.Builder setCreateTime(com.google.protobuf.Timestamp value)
       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];

    • setCreateTime

      public Instance.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeCreateTime

      public Instance.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       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];

    • clearCreateTime

      public Instance.Builder clearCreateTime()
       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];

    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       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];

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

    • setSatisfiesPzs

      public Instance.Builder setSatisfiesPzs(boolean value)
       Output only. Reserved for future use.
      optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzs to set.
      Returns:
      This builder for chaining.

    • clearSatisfiesPzs

      public Instance.Builder clearSatisfiesPzs()
       Output only. Reserved for future use.
      optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Instance.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>

    • mergeUnknownFields

      public final Instance.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Instance.Builder>