Interface InstanceOrBuilder (6.25.1)

Version 6.25.1

• 6.80.1 (latest)
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public interface InstanceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.
• No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

map<string, string> labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getConfig()

public abstract String getConfig()

Required. The name of the instance's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.

string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The config.

getConfigBytes()

public abstract ByteString getConfigBytes()

Required. The name of the instance's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.

string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for config.

getDisplayName()

public abstract String getDisplayName()

Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

string display_name = 3 [(.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. Must be unique per project and between 4 and 30 characters in length.

string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEndpointUris(int index)

public abstract String getEndpointUris(int index)

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The endpointUris at the given index.

getEndpointUrisBytes(int index)

public abstract ByteString getEndpointUrisBytes(int index)

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the endpointUris at the given index.

getEndpointUrisCount()

public abstract int getEndpointUrisCount()

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Returns
Type	Description
int	The count of endpointUris.

getEndpointUrisList()

public abstract List<String> getEndpointUrisList()

Deprecated. This field is not populated.

repeated string endpoint_uris = 8;

Returns
Type	Description
List<String>	A list containing the endpointUris.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.
• No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

map<string, string> labels = 7;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.
• No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

map<string, string> labels = 7;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.
• No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

map<string, string> labels = 7;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

• Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?.
• Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.
• No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

map<string, string> labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for name.

getNodeCount()

public abstract int getNodeCount()

Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state READY. See the documentation for more information about nodes.

int32 node_count = 5;

Returns
Type	Description
int	The nodeCount.

getProcessingUnits()

public abstract int getProcessingUnits()

The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for instances that are not yet in state READY.

int32 processing_units = 9;

Returns
Type	Description
int	The processingUnits.

getState()

public abstract Instance.State getState()

Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY.

.google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Instance.State	The state.

getStateValue()

public abstract int getStateValue()

Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY.

.google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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