Class: Ansible::Ruby::Modules::Rax_files

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Rax_files

Defined in:

lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files.rb

Overview

Manipulate Rackspace Cloud Files Containers

Instance Method Summary

• #clear_meta ⇒ :yes, ...

  Optionally clear existing metadata when applying metadata to existing containers.

• #container ⇒ Object

  The container to use for container or metadata operations.

• #meta ⇒ Object^?

  A hash of items to set as metadata values on a container.

• #private ⇒ Object^?

  Used to set a container as private, removing it from the CDN.

• #public ⇒ Object^?

  Used to set a container as public, available via the Cloud Files CDN.

• #region ⇒ String^?

  Region to create an instance in.

• #state ⇒ :present, ...

  Indicate desired state of the resource.

• #ttl ⇒ Object^?

  In seconds, set a container-wide TTL for all objects cached on CDN edge nodes.

• #type ⇒ :file, ...

  Type of object to do work on, i.e.

• #web_error ⇒ Object^?

  Sets an object to be presented as the HTTP error page when accessed by the CDN URL.

• #web_index ⇒ Object^?

  Sets an object to be presented as the HTTP index page when accessed by the CDN URL.

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 containers. Selecting this option is only appropriate when setting type=meta.

Returns:

• (:yes, :no, nil) —

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

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

attribute :clear_meta

#container ⇒ Object

Returns The container to use for container or metadata operations.

Returns:

• (Object) —

  The container to use for container or metadata operations.

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

attribute :container

#meta ⇒ Object^?

Returns A hash of items to set as metadata values on a container.

Returns:

• (Object, nil) —

  A hash of items to set as metadata values on a container

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

attribute :meta

#private ⇒ Object^?

Returns Used to set a container as private, removing it from the CDN. B(Warning!) Private containers, if previously made public, can have live objects available until the TTL on cached objects expires.

Returns:

• (Object, nil) —

  Used to set a container as private, removing it from the CDN. B(Warning!) Private containers, if previously made public, can have live objects available until the TTL on cached objects expires

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

attribute :private

#public ⇒ Object^?

Returns Used to set a container as public, available via the Cloud Files CDN.

Returns:

• (Object, nil) —

  Used to set a container as public, available via the Cloud Files CDN

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

attribute :public

#region ⇒ String^?

Returns Region to create an instance in.

Returns:

• (String, nil) —

  Region to create an instance in

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

attribute :region

#state ⇒ :present, ...

Returns Indicate desired state of the resource.

Returns:

• (:present, :absent, nil) —

  Indicate desired state of the resource

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

attribute :state

#ttl ⇒ Object^?

Returns In seconds, set a container-wide TTL for all objects cached on CDN edge nodes. Setting a TTL is only appropriate for containers that are public.

Returns:

• (Object, nil) —

  In seconds, set a container-wide TTL for all objects cached on CDN edge nodes. Setting a TTL is only appropriate for containers that are public

# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files.rb', line 37

attribute :ttl

#type ⇒ :file, ...

Returns Type of object to do work on, i.e. metadata object or a container object.

Returns:

• (:file, :meta, nil) —

  Type of object to do work on, i.e. metadata object or a container object

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

attribute :type

#web_error ⇒ Object^?

Returns Sets an object to be presented as the HTTP error page when accessed by the CDN URL.

Returns:

• (Object, nil) —

  Sets an object to be presented as the HTTP error page when accessed by the CDN URL

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

attribute :web_error

#web_index ⇒ Object^?

Returns Sets an object to be presented as the HTTP index page when accessed by the CDN URL.

Returns:

• (Object, nil) —

  Sets an object to be presented as the HTTP index page when accessed by the CDN URL

# File 'lib/ansible/ruby/modules/generated/cloud/rackspace/rax_files.rb', line 47

attribute :web_index