public final class Instance extends GeneratedMessageV3 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
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Instance getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Instance.Builder newBuilder()
Returns
newBuilder(Instance prototype)
public static Instance.Builder newBuilder(Instance prototype)
Parameter
Returns
public static Instance parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Instance parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Instance parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instance parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Instance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Instance parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Instance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Instance parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Instance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Instance> parser()
Returns
Methods
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
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];
getDefaultInstanceForType()
public Instance getDefaultInstanceForType()
Returns
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()
Returns
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;
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;
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;
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;
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;
getParserForType()
public Parser<Instance> getParserForType()
Returns
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public Instance.State getState()
(OutputOnly)
The current state of the instance.
.google.bigtable.admin.v2.Instance.State state = 3;
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;
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Instance.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Instance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Instance.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
