Class: Ansible::Ruby::Modules::Gce_labels

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

Overview

Create, Update or Destroy GCE Labels on instances, disks, snapshots, etc. When specifying the GCE resource, users may specifiy the full URL for the resource (its ‘self_link’), or the individual parameters of the resource (type, location, name). Examples for the two options can be seen in the documentaion. See U(cloud.google.com/compute/docs/label-or-tag-resources) for more information about GCE Labels. Labels are gradually being added to more GCE resources, so this module will need to be updated as new resources are added to the GCE (v1) API.

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

#labels ⇒ Hash?

Returns A list of labels (key/value pairs) to add or remove for the resource.

Returns:

  • (Hash, nil) —

    A list of labels (key/value pairs) to add or remove for the resource.



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

attribute :labels

#resource_location ⇒ String?

Returns The location of resource (global, us-central1-f, etc.).

Returns:

  • (String, nil) —

    The location of resource (global, us-central1-f, etc.)



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

attribute :resource_location

#resource_name ⇒ String?

Returns The name of resource.

Returns:

  • (String, nil) —

    The name of resource.



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

attribute :resource_name

#resource_type ⇒ String?

Returns The type of resource (instances, disks, snapshots, images).

Returns:

  • (String, nil) —

    The type of resource (instances, disks, snapshots, images)



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

attribute :resource_type

#resource_url ⇒ String?

Returns The ‘self_link’ for the resource (instance, disk, snapshot, etc).

Returns:

  • (String, nil) —

    The ‘self_link’ for the resource (instance, disk, snapshot, etc)



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

attribute :resource_url