Class: Ansible::Ruby::Modules::Gcp_storage_bucket

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

Overview

The Buckets resource represents a bucket in Google Cloud Storage. There is a single global namespace shared by all buckets. For more information, see Bucket Name Requirements. Buckets contain objects which can be accessed by their own methods. In addition to the acl property, buckets contain bucketAccessControls, for use in fine-grained manipulation of an existing bucket’s access controls. A bucket is always owned by the project team owners group.

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

#acl ⇒ Object?

Returns Access controls on the bucket.

Returns:

  • (Object, nil) —

    Access controls on the bucket.



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

attribute :acl

#cors ⇒ Object?

Returns The bucket’s Cross-Origin Resource Sharing (CORS) configuration.

Returns:

  • (Object, nil) —

    The bucket’s Cross-Origin Resource Sharing (CORS) configuration.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 21

attribute :cors

#default_object_acl ⇒ Object?

Returns Default access controls to apply to new objects when no ACL is provided.

Returns:

  • (Object, nil) —

    Default access controls to apply to new objects when no ACL is provided.



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

attribute :default_object_acl

#lifecycle ⇒ Object?

Returns The bucket’s lifecycle configuration.,See U(developers.google.com/storage/docs/lifecycle) for more information.

Returns:



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 27

attribute :lifecycle

#location ⇒ Object?

Returns The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer’s guide for the authoritative list.

Returns:

  • (Object, nil) —

    The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer’s guide for the authoritative list.



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

attribute :location

#logging ⇒ Object?

Returns The bucket’s logging configuration, which defines the destination bucket and optional name prefix for the current bucket’s logs.

Returns:

  • (Object, nil) —

    The bucket’s logging configuration, which defines the destination bucket and optional name prefix for the current bucket’s logs.



33
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 33

attribute :logging

#metageneration ⇒ Object?

Returns The metadata generation of this bucket.

Returns:

  • (Object, nil) —

    The metadata generation of this bucket.



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

attribute :metageneration

#name ⇒ String?

Returns The name of the bucket.

Returns:

  • (String, nil) —

    The name of the bucket.



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

attribute :name

#owner ⇒ Object?

Returns The owner of the bucket. This is always the project team’s owner group.

Returns:

  • (Object, nil) —

    The owner of the bucket. This is always the project team’s owner group.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 43

attribute :owner

#predefined_default_object_acl ⇒ :authenticatedRead, ...

Returns Apply a predefined set of default object access controls to this bucket.,Acceptable values are: - “authenticatedRead”: Object owner gets OWNER access, and allAuthenticatedUsers get READER access.,- “bucketOwnerFullControl”: Object owner gets OWNER access, and project team owners get OWNER access.,- “bucketOwnerRead”: Object owner gets OWNER access, and project team owners get READER access.,- “private”: Object owner gets OWNER access.,- “projectPrivate”: Object owner gets OWNER access, and project team members get access according to their roles.,- “publicRead”: Object owner gets OWNER access, and allUsers get READER access.

Returns:

  • (:authenticatedRead, :bucketOwnerFullControl, :bucketOwnerRead, :private, :projectPrivate, :publicRead, nil) —

    Apply a predefined set of default object access controls to this bucket.,Acceptable values are: - “authenticatedRead”: Object owner gets OWNER access, and allAuthenticatedUsers get READER access.,- “bucketOwnerFullControl”: Object owner gets OWNER access, and project team owners get OWNER access.,- “bucketOwnerRead”: Object owner gets OWNER access, and project team owners get READER access.,- “private”: Object owner gets OWNER access.,- “projectPrivate”: Object owner gets OWNER access, and project team members get access according to their roles.,- “publicRead”: Object owner gets OWNER access, and allUsers get READER access.



60
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 60

attribute :predefined_default_object_acl

#project ⇒ String?

Returns A valid API project identifier.

Returns:

  • (String, nil) —

    A valid API project identifier.



56
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 56

attribute :project

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



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

attribute :state

#storage_class ⇒ :MULTI_REGIONAL, ...

Returns The bucket’s default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage.,Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.

Returns:

  • (:MULTI_REGIONAL, :REGIONAL, :STANDARD, :NEARLINE, :COLDLINE, :DURABLE_REDUCED_AVAILABILITY, nil) —

    The bucket’s default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage.,Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.



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

attribute :storage_class

#versioning ⇒ Object?

Returns The bucket’s versioning configuration.

Returns:

  • (Object, nil) —

    The bucket’s versioning configuration.



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

attribute :versioning

#website ⇒ Object?

Returns The bucket’s website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

Returns:

  • (Object, nil) —

    The bucket’s website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.



53
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket.rb', line 53

attribute :website