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

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

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#bucket ⇒ String

Returns Bucket name.

Returns:

  • (String) —

    Bucket name.



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

attribute :bucket

#dest ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :dest

#expiration ⇒ Object?

Returns Time limit (in seconds) for the URL generated and returned by GCA when performing a mode=put or mode=get_url operation. This url is only available when public-read is the acl for the object.

Returns:

  • (Object, nil) —

    Time limit (in seconds) for the URL generated and returned by GCA when performing a mode=put or mode=get_url operation. This url is only available when public-read is the acl for the object.



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

attribute :expiration

#force ⇒ Boolean?

Returns Forces an overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.

Returns:

  • (Boolean, nil) —

    Forces an overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.



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

attribute :force

#gs_access_key ⇒ Object

Returns GS access key. If not set then the value of the GS_ACCESS_KEY_ID environment variable is used.

Returns:

  • (Object) —

    GS access key. If not set then the value of the GS_ACCESS_KEY_ID environment variable is used.



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

attribute :gs_access_key

#gs_secret_key ⇒ Object

Returns GS secret key. If not set then the value of the GS_SECRET_ACCESS_KEY environment variable is used.

Returns:

  • (Object) —

    GS secret key. If not set then the value of the GS_SECRET_ACCESS_KEY environment variable is used.



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

attribute :gs_secret_key

#headers ⇒ Hash?

Returns Headers to attach to object.

Returns:

  • (Hash, nil) —

    Headers to attach to object.



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

attribute :headers

#mode ⇒ :get, ...

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

Returns:

  • (:get, :put, :get_url, :get_str, :delete, :create) —

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



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

attribute :mode

#object ⇒ String?

Returns Keyname of the object inside the bucket. Can be also be used to create “virtual directories” (see examples).

Returns:

  • (String, nil) —

    Keyname of the object inside the bucket. Can be also be used to create “virtual directories” (see examples).



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

attribute :object

#permission ⇒ String?

Returns This option let’s the user set the canned permissions on the object/bucket that are created. The permissions that can be set are ‘private’, ‘public-read’, ‘authenticated-read’.

Returns:

  • (String, nil) —

    This option let’s the user set the canned permissions on the object/bucket that are created. The permissions that can be set are ‘private’, ‘public-read’, ‘authenticated-read’.



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

attribute :permission

#src ⇒ String?

Returns The source file path when performing a PUT operation.

Returns:

  • (String, nil) —

    The source file path when performing a PUT operation.



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

attribute :src