GoogleApi.Spanner.V1.Model.Instance (google_api_spanner v0.32.0) View Source

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

Attributes

  • config (type: String.t, default: nil) - Required. The name of the instance's configuration. Values are of the form projects//instanceConfigs/. See also InstanceConfig and ListInstanceConfigs.
  • displayName (type: String.t, default: nil) - 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.
  • endpointUris (type: list(String.t), default: nil) - Deprecated. This field is not populated.
  • labels (type: map(), default: nil) - 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?)?`. * 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.
  • name (type: String.t, default: nil) - Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects//instances/a-z*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.
  • nodeCount (type: integer(), default: nil) - 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.
  • processingUnits (type: integer(), default: nil) - 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.
  • state (type: String.t, default: nil) - 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Spanner.V1.Model.Instance{
  config: String.t() | nil,
  displayName: String.t() | nil,
  endpointUris: [String.t()] | nil,
  labels: map() | nil,
  name: String.t() | nil,
  nodeCount: integer() | nil,
  processingUnits: integer() | nil,
  state: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.