final case class Instance(name: String = "", config: String = "", displayName: String = "", nodeCount: Int = 0, state: State = ..., labels: Map[String, String] = ..., endpointUris: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Instance] with Product with Serializable

An isolated set of Cloud Spanner resources on which databases can be hosted.

name

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 2 and 64 characters in length.

config

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].

displayName

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.

nodeCount

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.

state

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.

labels

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.

endpointUris

Deprecated. This field is not populated.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[Instance], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Instance
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Instance(name: String = "", config: String = "", displayName: String = "", nodeCount: Int = 0, state: State = ..., labels: Map[String, String] = ..., endpointUris: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    name

    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 2 and 64 characters in length.

    config

    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].

    displayName

    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.

    nodeCount

    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.

    state

    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.

    labels

    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.

    endpointUris

    Deprecated. This field is not populated.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllEndpointUris(__vs: Iterable[String]): Instance
  5. def addAllLabels(__vs: Iterable[(String, String)]): Instance
  6. def addEndpointUris(__vs: String*): Instance
  7. def addLabels(__vs: (String, String)*): Instance
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearEndpointUris: Instance
  10. def clearLabels: Instance
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. def companion: Instance.type
    Definition Classes
    Instance → GeneratedMessage
  13. val config: String
  14. def discardUnknownFields: Instance
  15. val displayName: String
  16. val endpointUris: Seq[String]
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Instance → GeneratedMessage
  21. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Instance → GeneratedMessage
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val labels: Map[String, String]
  24. val name: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. val nodeCount: Int
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def serializedSize: Int
    Definition Classes
    Instance → GeneratedMessage
  30. val state: State
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  33. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  34. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  35. def toProtoString: String
    Definition Classes
    Instance → GeneratedMessage
  36. val unknownFields: UnknownFieldSet
  37. def update(ms: (Lens[Instance, Instance]) ⇒ Mutation[Instance]*): Instance
    Definition Classes
    Updatable
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  41. def withConfig(__v: String): Instance
  42. def withDisplayName(__v: String): Instance
  43. def withEndpointUris(__v: Seq[String]): Instance
  44. def withLabels(__v: Map[String, String]): Instance
  45. def withName(__v: String): Instance
  46. def withNodeCount(__v: Int): Instance
  47. def withState(__v: State): Instance
  48. def withUnknownFields(__v: UnknownFieldSet): Instance
  49. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  50. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Instance → GeneratedMessage
  51. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[Instance]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped