Class: Ansible::Ruby::Modules::Gcp_spanner_instance

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#config ⇒ String?

Returns A reference to the instance configuration.

Returns:

  • (String, nil) —

    A reference to the instance configuration.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb', line 20

attribute :config

#display_name ⇒ String

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

Returns:

  • (String) —

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



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb', line 24

attribute :display_name

#labels ⇒ Hash?

Returns 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])?`.,Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z](*[a-z0-9])?)?`.,No more than 64 labels can be associated with a given resource.,See U(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.,An object containing a list of “key”: value pairs.,Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.

Returns:

  • (Hash, 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])?`.,Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z](*[a-z0-9])?)?`.,No more than 64 labels can be associated with a given resource.,See U(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.,An object containing a list of “key”: value pairs.,Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.



32
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb', line 32

attribute :labels

#name ⇒ String?

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

Returns:

  • (String, nil) —

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



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb', line 16

attribute :name

#node_count ⇒ Integer?

Returns The number of nodes allocated to this instance.

Returns:

  • (Integer, nil) —

    The number of nodes allocated to this instance.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb', line 28

attribute :node_count

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_spanner_instance.rb', line 12

attribute :state