Class Instance.Builder (2.11.0)

public static final class Instance.Builder extends GeneratedMessageV3.Builder<Instance.Builder> implements InstanceOrBuilder

A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

Protobuf type google.bigtable.admin.v2.Instance

Implements

InstanceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

build()

public Instance build()
Returns
TypeDescription
Instance

buildPartial()

public Instance buildPartial()
Returns
TypeDescription
Instance

clear()

public Instance.Builder clear()
Returns
TypeDescription
Instance.Builder
Overrides

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

Returns
TypeDescription
Instance.Builder

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Instance.Builder
Overrides

clearLabels()

public Instance.Builder clearLabels()
Returns
TypeDescription
Instance.Builder

clearName()

public Instance.Builder clearName()

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

string name = 1;

Returns
TypeDescription
Instance.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Instance.Builder
Overrides

clearState()

public Instance.Builder clearState()

(OutputOnly) The current state of the instance.

.google.bigtable.admin.v2.Instance.State state = 3;

Returns
TypeDescription
Instance.Builder

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

This builder for chaining.

clone()

public Instance.Builder clone()
Returns
TypeDescription
Instance.Builder
Overrides

containsLabels(String key)

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}{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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Instance getDefaultInstanceForType()
Returns
TypeDescription
Instance

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public 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
TypeDescription
ByteString

The bytes for displayName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public 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}{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;

Returns
TypeDescription
int

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}{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;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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}{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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

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}{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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getState()

public Instance.State getState()

(OutputOnly) The current state of the instance.

.google.bigtable.admin.v2.Instance.State state = 3;

Returns
TypeDescription
Instance.State

The state.

getStateValue()

public int getStateValue()

(OutputOnly) The current state of the instance.

.google.bigtable.admin.v2.Instance.State state = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getType()

public Instance.Type getType()

The type of the instance. Defaults to PRODUCTION.

.google.bigtable.admin.v2.Instance.Type type = 4;

Returns
TypeDescription
Instance.Type

The type.

getTypeValue()

public int getTypeValue()

The type of the instance. Defaults to PRODUCTION.

.google.bigtable.admin.v2.Instance.Type type = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Instance.Builder

mergeFrom(Instance other)

public Instance.Builder mergeFrom(Instance other)
Parameter
NameDescription
otherInstance
Returns
TypeDescription
Instance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Instance.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Instance.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Instance.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Instance.Builder
Overrides

putAllLabels(Map<String,String> values)

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}{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;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Instance.Builder

putLabels(String key, String value)

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}{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;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Instance.Builder

removeLabels(String key)

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}{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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Instance.Builder

setCreateTime(Timestamp value)

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Instance.Builder

setCreateTime(Timestamp.Builder builderForValue)

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Instance.Builder

setDisplayName(String value)

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

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Instance.Builder setNameBytes(ByteString value)

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Instance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Instance.Builder
Overrides

setState(Instance.State value)

public Instance.Builder setState(Instance.State value)

(OutputOnly) The current state of the instance.

.google.bigtable.admin.v2.Instance.State state = 3;

Parameter
NameDescription
valueInstance.State

The state to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setStateValue(int value)

public Instance.Builder setStateValue(int value)

(OutputOnly) The current state of the instance.

.google.bigtable.admin.v2.Instance.State state = 3;

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setType(Instance.Type value)

public Instance.Builder setType(Instance.Type value)

The type of the instance. Defaults to PRODUCTION.

.google.bigtable.admin.v2.Instance.Type type = 4;

Parameter
NameDescription
valueInstance.Type

The type to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setTypeValue(int value)

public Instance.Builder setTypeValue(int value)

The type of the instance. Defaults to PRODUCTION.

.google.bigtable.admin.v2.Instance.Type type = 4;

Parameter
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
Instance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Instance.Builder
Overrides