com.google.spanner.admin.instance.v1

Interface InstanceOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Instance, Instance.Builder

public interface InstanceOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.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.
java.lang.String	getConfig() Required.
ByteString	getConfigBytes() Required.
java.lang.String	getDisplayName() Required.
ByteString	getDisplayNameBytes() Required.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
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.
java.util.Map<java.lang.String,java.lang.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.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.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.
java.lang.String	getLabelsOrThrow(java.lang.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.
java.lang.String	getName() Required.
ByteString	getNameBytes() Required.
int	getNodeCount() Required.
Instance.State	getState() Output only.
int	getStateValue() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

java.lang.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]*[a-z0-9]`. The final
 segment of the name must be between 6 and 30 characters in length.
 

string name = 1;

getNameBytes

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]*[a-z0-9]`. The final
 segment of the name must be between 6 and 30 characters in length.
 

string name = 1;

getConfig

java.lang.String getConfig()

 Required. The name of the instance's configuration. Values are of the form
 `projects/<project>/instanceConfigs/<configuration>`. See
 also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
 [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
 

string config = 2;

getConfigBytes

ByteString getConfigBytes()

 Required. The name of the instance's configuration. Values are of the form
 `projects/<project>/instanceConfigs/<configuration>`. See
 also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
 [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
 

string config = 2;

getDisplayName

java.lang.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;

getDisplayNameBytes

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;

getNodeCount

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](https://cloud.google.com/spanner/docs/instances#node_count)
 for more information about nodes.
 

int32 node_count = 5;

getStateValue

int getStateValue()

 Output only. The current instance state. For
 [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
 either omitted or set to `CREATING`. For
 [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
 either omitted or set to `READY`.
 

.google.spanner.admin.instance.v1.Instance.State state = 6;

getState

Instance.State getState()

 Output only. The current instance state. For
 [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
 either omitted or set to `CREATING`. For
 [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
 either omitted or set to `READY`.
 

.google.spanner.admin.instance.v1.Instance.State state = 6;

getLabelsCount

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]([-a-z0-9]*[a-z0-9])?`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
  * 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;

containsLabels

boolean containsLabels(java.lang.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]([-a-z0-9]*[a-z0-9])?`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
  * 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;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.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]([-a-z0-9]*[a-z0-9])?`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
  * 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;

getLabelsOrDefault

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.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]([-a-z0-9]*[a-z0-9])?`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
  * 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;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.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]([-a-z0-9]*[a-z0-9])?`.
  * Label values must be between 0 and 63 characters long and must conform
    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
  * 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;