Class: Ansible::Ruby::Modules::Gc_storage

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb

Overview

This module allows users to manage their objects/buckets in Google Cloud Storage. It allows upload and download operations and can set some canned permissions. It also allows retrieval of URLs for objects for use in playbooks, and retrieval of string contents of objects. This module requires setting the default project in GCS prior to playbook usage. See U(developers.google.com/storage/docs/reference/v1/apiversion1) for information about setting the default project.

Instance Method Summary

• #bucket ⇒ String

  Bucket name.

• #dest ⇒ String^?

  The destination file path when downloading an object/key with a GET operation.

• #expiration ⇒ Object^?

  Time limit (in seconds) for the URL generated and returned by GCA when performing a mode=put or mode=get_url operation.

• #force ⇒ :yes, ...

  Forces an overwrite either locally on the filesystem or remotely with the object/key.

• #gs_access_key ⇒ Object

  GS access key.

• #gs_secret_key ⇒ Object

  GS secret key.

• #headers ⇒ Object^?

  Headers to attach to object.

• #mode ⇒ :get, ...

  Switches the module behaviour between upload, download, get_url (return download url) , get_str (download object as string), create (bucket) and delete (bucket).

• #object ⇒ String^?

  Keyname of the object inside the bucket.

• #permission ⇒ String^?

  This option let’s the user set the canned permissions on the object/bucket that are created.

• #region ⇒ String^?

  The gs region to use.

• #src ⇒ String^?

  The source file path when performing a PUT operation.

• #versioning ⇒ Symbol^?

  Whether versioning is enabled or disabled (note that once versioning is enabled, it can only be suspended).

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

#bucket ⇒ String

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

attribute :bucket

#dest ⇒ String^?

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

attribute :dest

#expiration ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 39

attribute :expiration

#force ⇒ :yes, ...

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

attribute :force

#gs_access_key ⇒ Object

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 50

attribute :gs_access_key

#gs_secret_key ⇒ Object

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 46

attribute :gs_secret_key

#headers ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 36

attribute :headers

#mode ⇒ :get, ...

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 42

attribute :mode

#object ⇒ String^?

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

attribute :object

#permission ⇒ String^?

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

attribute :permission

#region ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 54

attribute :region

#src ⇒ String^?

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

attribute :src

#versioning ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gc_storage.rb', line 58

attribute :versioning