Interface InstanceOrBuilder (2.14.0)

Version 2.14.0

• 2.37.0 (latest)
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

Name	Description
key	String

Returns

Type	Description
boolean

getCreateTime()

public abstract 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

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract 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

Type	Description
TimestampOrBuilder

getDisplayName()

public abstract 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

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for displayName.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract 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

Type	Description
int

getLabelsMap()

public abstract 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

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract 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

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract 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

Name	Description
key	String

Returns

Type	Description
String

getName()

public abstract 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

Type	Description
String	The name.

getNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for name.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

Output only. Reserved for future use.

optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	The satisfiesPzs.

getState()

public abstract Instance.State getState()

(OutputOnly) The current state of the instance.

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

Returns

Type	Description
Instance.State	The state.

getStateValue()

public abstract int getStateValue()

(OutputOnly) The current state of the instance.

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

Returns

Type	Description
int	The enum numeric value on the wire for state.

getType()

public abstract Instance.Type getType()

The type of the instance. Defaults to PRODUCTION.

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

Returns

Type	Description
Instance.Type	The type.

getTypeValue()

public abstract int getTypeValue()

The type of the instance. Defaults to PRODUCTION.

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

Returns

Type	Description
int	The enum numeric value on the wire for type.

hasCreateTime()

public abstract 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

Type	Description
boolean	Whether the createTime field is set.

hasSatisfiesPzs()

public abstract boolean hasSatisfiesPzs()

Output only. Reserved for future use.

optional bool satisfies_pzs = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the satisfiesPzs field is set.