Cloud Spanner Instance Admin V1 API - Class Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig (v0.9.0)

Reference documentation and code samples for the Cloud Spanner Instance Admin V1 API class Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig.

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#base_config

def base_config() -> ::String
Returns
  • (::String) — Base configuration name, e.g. projects/

#base_config=

def base_config=(value) -> ::String
Parameter
  • value (::String) — Base configuration name, e.g. projects/
Returns
  • (::String) — Base configuration name, e.g. projects/

#config_type

def config_type() -> ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig::Type
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — The name of this instance configuration as it appears in UIs.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The name of this instance configuration as it appears in UIs.
Returns
  • (::String) — The name of this instance configuration as it appears in UIs.

#etag

def etag() -> ::String
Returns
  • (::String) — etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
Returns
  • (::String) — etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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_-]{0,62}.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
    • 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. Therefore, 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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_-]{0,62}.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
    • 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. Therefore, 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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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_-]{0,62}.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
    • 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. Therefore, 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.

#leader_options

def leader_options() -> ::Array<::String>
Returns
  • (::Array<::String>) — Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.

#leader_options=

def leader_options=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
Returns
  • (::Array<::String>) — Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.

#name

def name() -> ::String
Returns
  • (::String) — A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*.
Returns
  • (::String) — A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*.

#optional_replicas

def optional_replicas() -> ::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>
Returns

#reconciling

def reconciling() -> ::Boolean
Returns
  • (::Boolean) — Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.

#replicas

def replicas() -> ::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>
Returns

#replicas=

def replicas=(value) -> ::Array<::Google::Cloud::Spanner::Admin::Instance::V1::ReplicaInfo>
Parameter
Returns

#state

def state() -> ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig::State
Returns