class

GoogleCloudStorage::Bucket

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

A bucket.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, acl : Array(GoogleCloudStorage::BucketAccessControl) | Nil = nil, autoclass : GoogleCloudStorage::BucketAutoclass | Nil = nil, billing : GoogleCloudStorage::BucketBilling | Nil = nil, cors : Array(GoogleCloudStorage::BucketCorsInner) | Nil = nil, default_event_based_hold : Bool | Nil = nil, default_object_acl : Array(GoogleCloudStorage::ObjectAccessControl) | Nil = nil, encryption : GoogleCloudStorage::BucketEncryption | Nil = nil, etag : String | Nil = nil, iam_configuration : GoogleCloudStorage::BucketIamConfiguration | Nil = nil, id : String | Nil = nil, kind : String | Nil = "storage#bucket", labels : Hash(String, String) | Nil = nil, lifecycle : GoogleCloudStorage::BucketLifecycle | Nil = nil, location : String | Nil = nil, location_type : String | Nil = nil, logging : GoogleCloudStorage::BucketLogging | Nil = nil, metageneration : String | Nil = nil, name : String | Nil = nil, owner : GoogleCloudStorage::BucketOwner | Nil = nil, project_number : String | Nil = nil, retention_policy : GoogleCloudStorage::BucketRetentionPolicy | Nil = nil, rpo : String | Nil = nil, satisfies_pzs : Bool | Nil = nil, self_link : String | Nil = nil, storage_class : String | Nil = nil, time_created : Time | Nil = nil, updated : Time | Nil = nil, versioning : GoogleCloudStorage::BucketVersioning | Nil = nil, website : GoogleCloudStorage::BucketWebsite | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

acl

Access controls on the bucket.

Source
acl=(new_value : Array(GoogleCloudStorage::BucketAccessControl) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] acl Object to be assigned

Source
autoclass
Source
autoclass=(new_value : GoogleCloudStorage::BucketAutoclass | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] autoclass Object to be assigned

Source
billing
Source
billing=(new_value : GoogleCloudStorage::BucketBilling | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] billing Object to be assigned

Source
cors

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

Source
cors=(new_value : Array(GoogleCloudStorage::BucketCorsInner) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cors Object to be assigned

Source
default_event_based_hold

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.

Source
default_event_based_hold=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_event_based_hold Object to be assigned

Source
default_object_acl

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

Source
default_object_acl=(new_value : Array(GoogleCloudStorage::ObjectAccessControl) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_object_acl Object to be assigned

Source
encryption
Source
encryption=(new_value : GoogleCloudStorage::BucketEncryption | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] encryption Object to be assigned

Source
etag

HTTP 1.1 Entity tag for the bucket.

Source
etag=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] etag Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

iam_configuration
Source
iam_configuration=(new_value : GoogleCloudStorage::BucketIamConfiguration | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] iam_configuration Object to be assigned

Source
id

The ID of the bucket. For buckets, the id and name properties are the same.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
kind

The kind of item this is. For buckets, this is always storage#bucket.

Source
kind=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] kind Object to be assigned

Source
labels

User-provided labels, in key/value pairs.

Source
labels=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] labels Object to be assigned

Source
lifecycle
Source
lifecycle=(new_value : GoogleCloudStorage::BucketLifecycle | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
location

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.

Source
location=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] location Object to be assigned

Source
location_type

The type of the bucket location.

Source
location_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] location_type Object to be assigned

Source
logging
Source
logging=(new_value : GoogleCloudStorage::BucketLogging | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] logging Object to be assigned

Source
metageneration

The metadata generation of this bucket.

Source
metageneration=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metageneration Object to be assigned

Source
name

The name of the bucket.

Source
name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

Source
owner
Source
owner=(new_value : GoogleCloudStorage::BucketOwner | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] owner Object to be assigned

Source
project_number

The project number of the project the bucket belongs to.

Source
project_number=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] project_number Object to be assigned

Source
retention_policy
Source
retention_policy=(new_value : GoogleCloudStorage::BucketRetentionPolicy | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] retention_policy Object to be assigned

Source
rpo

The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.

Source
rpo=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] rpo Object to be assigned

Source
satisfies_pzs

Reserved for future use.

Source
satisfies_pzs=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] satisfies_pzs Object to be assigned

Source
self_link=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] self_link Object to be assigned

Source
storage_class

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, ARCHIVE, 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.

Source
storage_class=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] storage_class Object to be assigned

Source
time_created

The creation time of the bucket in RFC 3339 format.

Source
time_created=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] time_created Object to be assigned

Source
updated

The modification time of the bucket in RFC 3339 format.

Source
updated=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] updated Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source
versioning
Source
versioning=(new_value : GoogleCloudStorage::BucketVersioning | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] versioning Object to be assigned

Source
website
Source
website=(new_value : GoogleCloudStorage::BucketWebsite | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] website Object to be assigned

Source