Class: Ansible::Ruby::Modules::Gcspanner

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

Overview

Create and Delete Instances/Databases on Spanner. See U(cloud.google.com/spanner/docs) for an overview.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#configuration ⇒ String

Returns Configuration the instance should use.,Examples are us-central1, asia-east1 and europe-west1.

Returns:

  • (String) —

    Configuration the instance should use.,Examples are us-central1, asia-east1 and europe-west1.



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

attribute :configuration

#database_name ⇒ String?

Returns Name of database contained on the instance.

Returns:

  • (String, nil) —

    Name of database contained on the instance.



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

attribute :database_name

#force_instance_delete ⇒ :yes, ...

Returns To delete an instance, this argument must exist and be true (along with state being equal to absent).

Returns:

  • (:yes, :no, nil) —

    To delete an instance, this argument must exist and be true (along with state being equal to absent).



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

attribute :force_instance_delete

#instance_display_name ⇒ Object?

Returns Name of Instance to display.,If not specified, instance_id will be used instead.

Returns:

  • (Object, nil) —

    Name of Instance to display.,If not specified, instance_id will be used instead.



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

attribute :instance_display_name

#instance_id ⇒ String

Returns GCP spanner instance name.

Returns:

  • (String) —

    GCP spanner instance name.



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

attribute :instance_id

#node_count ⇒ Integer?

Returns Number of nodes in the instance.

Returns:

  • (Integer, nil) —

    Number of nodes in the instance.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcspanner.rb', line 31

attribute :node_count

#state ⇒ :absent, ...

Returns State of the instance or database. Applies to the most granular resource.,If a C(database_name) is specified we remove it.,If only C(instance_id) is specified, that is what is removed.

Returns:

  • (:absent, :present, nil) —

    State of the instance or database. Applies to the most granular resource.,If a C(database_name) is specified we remove it.,If only C(instance_id) is specified, that is what is removed.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcspanner.rb', line 35

attribute :state