Class: Ansible::Ruby::Modules::Rax_files_objects

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

Overview

Upload, download, and delete objects in Rackspace Cloud Files

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

#clear_meta ⇒ :yes, ...

Returns Optionally clear existing metadata when applying metadata to existing objects. Selecting this option is only appropriate when setting type=meta.

Returns:

  • (:yes, :no, nil) —

    Optionally clear existing metadata when applying metadata to existing objects. Selecting this option is only appropriate when setting type=meta



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 12

attribute :clear_meta

#container ⇒ Object

Returns The container to use for file object operations.

Returns:

  • (Object) —

    The container to use for file object operations.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 16

attribute :container

#dest ⇒ Object?

Returns The destination of a “get” operation; i.e. a local directory, “/home/user/myfolder”. Used to specify the destination of an operation on a remote object; i.e. a file name, “file1”, or a comma-separated list of remote objects, “file1,file2,file17”.

Returns:

  • (Object, nil) —

    The destination of a “get” operation; i.e. a local directory, “/home/user/myfolder”. Used to specify the destination of an operation on a remote object; i.e. a file name, “file1”, or a comma-separated list of remote objects, “file1,file2,file17”



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 20

attribute :dest

#expires ⇒ Object?

Returns Used to set an expiration on a file or folder uploaded to Cloud Files. Requires an integer, specifying expiration in seconds.

Returns:

  • (Object, nil) —

    Used to set an expiration on a file or folder uploaded to Cloud Files. Requires an integer, specifying expiration in seconds



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 23

attribute :expires

#meta ⇒ Object?

Returns A hash of items to set as metadata values on an uploaded file or folder.

Returns:

  • (Object, nil) —

    A hash of items to set as metadata values on an uploaded file or folder



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 26

attribute :meta

#method ⇒ :get, ...

Returns The method of operation to be performed. For example, put to upload files to Cloud Files, get to download files from Cloud Files or delete to delete remote objects in Cloud Files.

Returns:

  • (:get, :put, :delete, nil) —

    The method of operation to be performed. For example, put to upload files to Cloud Files, get to download files from Cloud Files or delete to delete remote objects in Cloud Files



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 29

attribute :method

#src ⇒ Object?

Returns Source from which to upload files. Used to specify a remote object as a source for an operation, i.e. a file name, “file1”, or a comma-separated list of remote objects, “file1,file2,file17”. src and dest are mutually exclusive on remote-only object operations.

Returns:

  • (Object, nil) —

    Source from which to upload files. Used to specify a remote object as a source for an operation, i.e. a file name, “file1”, or a comma-separated list of remote objects, “file1,file2,file17”. src and dest are mutually exclusive on remote-only object operations



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 33

attribute :src

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

  • (:present, :absent, nil) —

    Indicate desired state of the resource



40
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 40

attribute :state

#structure ⇒ :yes, ...

Returns Used to specify whether to maintain nested directory structure when downloading objects from Cloud Files. Setting to false downloads the contents of a container to a single, flat directory.

Returns:

  • (:yes, :no, nil) —

    Used to specify whether to maintain nested directory structure when downloading objects from Cloud Files. Setting to false downloads the contents of a container to a single, flat directory



36
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 36

attribute :structure

#type ⇒ :file, ...

Returns Type of object to do work on,Metadata object or a file object.

Returns:

  • (:file, :meta, nil) —

    Type of object to do work on,Metadata object or a file object



44
 
# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files_objects.rb', line 44

attribute :type