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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Instance.BuilderImplements
InstanceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Instance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Instance.Builder |
build()
public Instance build()
Type | Description |
Instance |
buildPartial()
public Instance buildPartial()
Type | Description |
Instance |
clear()
public Instance.Builder clear()
Type | Description |
Instance.Builder |
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];
Type | Description |
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];
Type | Description |
Instance.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Instance.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
Instance.Builder |
clearLabels()
public Instance.Builder clearLabels()
Type | Description |
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;
Type | Description |
Instance.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Instance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
Instance.Builder |
clearSatisfiesPzs()
public Instance.Builder clearSatisfiesPzs()
Output only. Reserved for future use.
optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
Instance.Builder | This builder for chaining. |
clearState()
public Instance.Builder clearState()
(OutputOnly
)
The current state of the instance.
.google.bigtable.admin.v2.Instance.State state = 3;
Type | Description |
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;
Type | Description |
Instance.Builder | This builder for chaining. |
clone()
public Instance.Builder clone()
Type | Description |
Instance.Builder |
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;
Name | Description |
key | String |
Type | Description |
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];
Type | Description |
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];
Type | Description |
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];
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
Type | Description |
Instance |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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];
Type | Description |
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];
Type | Description |
ByteString | The bytes for displayName. |
getLabels()
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
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;
Name | Description |
key | String |
defaultValue | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
String |
getMutableLabels()
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Type | Description |
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;
Type | Description |
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;
Type | Description |
ByteString | The bytes for name. |
getSatisfiesPzs()
public boolean getSatisfiesPzs()
Output only. Reserved for future use.
optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
boolean | The satisfiesPzs. |
getState()
public Instance.State getState()
(OutputOnly
)
The current state of the instance.
.google.bigtable.admin.v2.Instance.State state = 3;
Type | Description |
Instance.State | The state. |
getStateValue()
public int getStateValue()
(OutputOnly
)
The current state of the instance.
.google.bigtable.admin.v2.Instance.State state = 3;
Type | Description |
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;
Type | Description |
Instance.Type | The type. |
getTypeValue()
public int getTypeValue()
The type of the instance. Defaults to PRODUCTION
.
.google.bigtable.admin.v2.Instance.Type type = 4;
Type | Description |
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];
Type | Description |
boolean | Whether the createTime field is set. |
hasSatisfiesPzs()
public boolean hasSatisfiesPzs()
Output only. Reserved for future use.
optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
boolean | Whether the satisfiesPzs field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
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];
Name | Description |
value | Timestamp |
Type | Description |
Instance.Builder |
mergeFrom(Instance other)
public Instance.Builder mergeFrom(Instance other)
Name | Description |
other | Instance |
Type | Description |
Instance.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Instance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Instance.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public Instance.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
Instance.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Instance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Instance.Builder |
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;
Name | Description |
values | Map<String,String> |
Type | Description |
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;
Name | Description |
key | String |
value | String |
Type | Description |
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;
Name | Description |
key | String |
Type | Description |
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];
Name | Description |
value | Timestamp |
Type | Description |
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];
Name | Description |
builderForValue | Builder |
Type | Description |
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];
Name | Description |
value | String The displayName to set. |
Type | Description |
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];
Name | Description |
value | ByteString The bytes for displayName to set. |
Type | Description |
Instance.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Instance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Instance.Builder |
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;
Name | Description |
value | String The name to set. |
Type | Description |
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;
Name | Description |
value | ByteString The bytes for name to set. |
Type | Description |
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)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
Instance.Builder |
setSatisfiesPzs(boolean value)
public Instance.Builder setSatisfiesPzs(boolean value)
Output only. Reserved for future use.
optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Name | Description |
value | boolean The satisfiesPzs to set. |
Type | Description |
Instance.Builder | This builder for chaining. |
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;
Name | Description |
value | Instance.State The state to set. |
Type | Description |
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;
Name | Description |
value | int The enum numeric value on the wire for state to set. |
Type | Description |
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;
Name | Description |
value | Instance.Type The type to set. |
Type | Description |
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;
Name | Description |
value | int The enum numeric value on the wire for type to set. |
Type | Description |
Instance.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Instance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Instance.Builder |