Class: Google::Apis::StorageV1::Bucket
- Inherits:
-
Object
- Object
- Google::Apis::StorageV1::Bucket
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/storage_v1/classes.rb,
lib/google/apis/storage_v1/representations.rb,
lib/google/apis/storage_v1/representations.rb
Overview
A bucket.
Defined Under Namespace
Classes: Autoclass, Billing, CorsConfiguration, Encryption, IamConfiguration, Lifecycle, Logging, Owner, RetentionPolicy, Versioning, Website
Instance Attribute Summary collapse
-
#acl ⇒ Array<Google::Apis::StorageV1::BucketAccessControl>
Access controls on the bucket.
-
#autoclass ⇒ Google::Apis::StorageV1::Bucket::Autoclass
The bucket's Autoclass configuration.
-
#billing ⇒ Google::Apis::StorageV1::Bucket::Billing
The bucket's billing configuration.
-
#cors_configurations ⇒ Array<Google::Apis::StorageV1::Bucket::CorsConfiguration>
The bucket's Cross-Origin Resource Sharing (CORS) configuration.
-
#default_event_based_hold ⇒ Boolean
(also: #default_event_based_hold?)
The default value for event-based hold on newly created objects in this bucket.
-
#default_object_acl ⇒ Array<Google::Apis::StorageV1::ObjectAccessControl>
Default access controls to apply to new objects when no ACL is provided.
-
#encryption ⇒ Google::Apis::StorageV1::Bucket::Encryption
Encryption configuration for a bucket.
-
#etag ⇒ String
HTTP 1.1 Entity tag for the bucket.
-
#iam_configuration ⇒ Google::Apis::StorageV1::Bucket::IamConfiguration
The bucket's IAM configuration.
-
#id ⇒ String
The ID of the bucket.
-
#kind ⇒ String
The kind of item this is.
-
#labels ⇒ Hash<String,String>
User-provided labels, in key/value pairs.
-
#lifecycle ⇒ Google::Apis::StorageV1::Bucket::Lifecycle
The bucket's lifecycle configuration.
-
#location ⇒ String
The location of the bucket.
-
#location_type ⇒ String
The type of the bucket location.
-
#logging ⇒ Google::Apis::StorageV1::Bucket::Logging
The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
-
#metageneration ⇒ Fixnum
The metadata generation of this bucket.
-
#name ⇒ String
The name of the bucket.
-
#owner ⇒ Google::Apis::StorageV1::Bucket::Owner
The owner of the bucket.
-
#project_number ⇒ Fixnum
The project number of the project the bucket belongs to.
-
#retention_policy ⇒ Google::Apis::StorageV1::Bucket::RetentionPolicy
The bucket's retention policy.
-
#rpo ⇒ String
The Recovery Point Objective (RPO) of this bucket.
-
#satisfies_pzs ⇒ Boolean
(also: #satisfies_pzs?)
Reserved for future use.
-
#self_link ⇒ String
The URI of this bucket.
-
#storage_class ⇒ String
The bucket's default storage class, used whenever no storageClass is specified for a newly-created object.
-
#time_created ⇒ DateTime
The creation time of the bucket in RFC 3339 format.
-
#updated ⇒ DateTime
The modification time of the bucket in RFC 3339 format.
-
#versioning ⇒ Google::Apis::StorageV1::Bucket::Versioning
The bucket's versioning configuration.
-
#website ⇒ Google::Apis::StorageV1::Bucket::Website
The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Bucket
constructor
A new instance of Bucket.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Bucket
Returns a new instance of Bucket.
208 209 210 |
# File 'lib/google/apis/storage_v1/classes.rb', line 208 def initialize(**args) update!(**args) end |
Instance Attribute Details
#acl ⇒ Array<Google::Apis::StorageV1::BucketAccessControl>
Access controls on the bucket.
Corresponds to the JSON property acl
32 33 34 |
# File 'lib/google/apis/storage_v1/classes.rb', line 32 def acl @acl end |
#autoclass ⇒ Google::Apis::StorageV1::Bucket::Autoclass
The bucket's Autoclass configuration.
Corresponds to the JSON property autoclass
37 38 39 |
# File 'lib/google/apis/storage_v1/classes.rb', line 37 def autoclass @autoclass end |
#billing ⇒ Google::Apis::StorageV1::Bucket::Billing
The bucket's billing configuration.
Corresponds to the JSON property billing
42 43 44 |
# File 'lib/google/apis/storage_v1/classes.rb', line 42 def billing @billing end |
#cors_configurations ⇒ Array<Google::Apis::StorageV1::Bucket::CorsConfiguration>
The bucket's Cross-Origin Resource Sharing (CORS) configuration.
Corresponds to the JSON property cors
47 48 49 |
# File 'lib/google/apis/storage_v1/classes.rb', line 47 def cors_configurations @cors_configurations end |
#default_event_based_hold ⇒ Boolean Also known as: 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.
Corresponds to the JSON property defaultEventBasedHold
63 64 65 |
# File 'lib/google/apis/storage_v1/classes.rb', line 63 def default_event_based_hold @default_event_based_hold end |
#default_object_acl ⇒ Array<Google::Apis::StorageV1::ObjectAccessControl>
Default access controls to apply to new objects when no ACL is provided.
Corresponds to the JSON property defaultObjectAcl
69 70 71 |
# File 'lib/google/apis/storage_v1/classes.rb', line 69 def default_object_acl @default_object_acl end |
#encryption ⇒ Google::Apis::StorageV1::Bucket::Encryption
Encryption configuration for a bucket.
Corresponds to the JSON property encryption
74 75 76 |
# File 'lib/google/apis/storage_v1/classes.rb', line 74 def encryption @encryption end |
#etag ⇒ String
HTTP 1.1 Entity tag for the bucket.
Corresponds to the JSON property etag
79 80 81 |
# File 'lib/google/apis/storage_v1/classes.rb', line 79 def etag @etag end |
#iam_configuration ⇒ Google::Apis::StorageV1::Bucket::IamConfiguration
The bucket's IAM configuration.
Corresponds to the JSON property iamConfiguration
84 85 86 |
# File 'lib/google/apis/storage_v1/classes.rb', line 84 def iam_configuration @iam_configuration end |
#id ⇒ String
The ID of the bucket. For buckets, the id and name properties are the same.
Corresponds to the JSON property id
89 90 91 |
# File 'lib/google/apis/storage_v1/classes.rb', line 89 def id @id end |
#kind ⇒ String
The kind of item this is. For buckets, this is always storage#bucket.
Corresponds to the JSON property kind
94 95 96 |
# File 'lib/google/apis/storage_v1/classes.rb', line 94 def kind @kind end |
#labels ⇒ Hash<String,String>
User-provided labels, in key/value pairs.
Corresponds to the JSON property labels
99 100 101 |
# File 'lib/google/apis/storage_v1/classes.rb', line 99 def labels @labels end |
#lifecycle ⇒ Google::Apis::StorageV1::Bucket::Lifecycle
The bucket's lifecycle configuration. See lifecycle management for more
information.
Corresponds to the JSON property lifecycle
105 106 107 |
# File 'lib/google/apis/storage_v1/classes.rb', line 105 def lifecycle @lifecycle end |
#location ⇒ String
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.
Corresponds to the JSON property location
112 113 114 |
# File 'lib/google/apis/storage_v1/classes.rb', line 112 def location @location end |
#location_type ⇒ String
The type of the bucket location.
Corresponds to the JSON property locationType
117 118 119 |
# File 'lib/google/apis/storage_v1/classes.rb', line 117 def location_type @location_type end |
#logging ⇒ Google::Apis::StorageV1::Bucket::Logging
The bucket's logging configuration, which defines the destination bucket and
optional name prefix for the current bucket's logs.
Corresponds to the JSON property logging
123 124 125 |
# File 'lib/google/apis/storage_v1/classes.rb', line 123 def logging @logging end |
#metageneration ⇒ Fixnum
The metadata generation of this bucket.
Corresponds to the JSON property metageneration
128 129 130 |
# File 'lib/google/apis/storage_v1/classes.rb', line 128 def @metageneration end |
#name ⇒ String
The name of the bucket.
Corresponds to the JSON property name
133 134 135 |
# File 'lib/google/apis/storage_v1/classes.rb', line 133 def name @name end |
#owner ⇒ Google::Apis::StorageV1::Bucket::Owner
The owner of the bucket. This is always the project team's owner group.
Corresponds to the JSON property owner
138 139 140 |
# File 'lib/google/apis/storage_v1/classes.rb', line 138 def owner @owner end |
#project_number ⇒ Fixnum
The project number of the project the bucket belongs to.
Corresponds to the JSON property projectNumber
143 144 145 |
# File 'lib/google/apis/storage_v1/classes.rb', line 143 def project_number @project_number end |
#retention_policy ⇒ Google::Apis::StorageV1::Bucket::RetentionPolicy
The bucket's retention policy. The retention policy enforces a minimum
retention time for all objects contained in the bucket, based on their
creation time. Any attempt to overwrite or delete objects younger than the
retention period will result in a PERMISSION_DENIED error. An unlocked
retention policy can be modified or removed from the bucket via a storage.
buckets.update operation. A locked retention policy cannot be removed or
shortened in duration for the lifetime of the bucket. Attempting to remove or
decrease period of a locked retention policy will result in a
PERMISSION_DENIED error.
Corresponds to the JSON property retentionPolicy
156 157 158 |
# File 'lib/google/apis/storage_v1/classes.rb', line 156 def retention_policy @retention_policy end |
#rpo ⇒ String
The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn
on Turbo Replication on a bucket.
Corresponds to the JSON property rpo
162 163 164 |
# File 'lib/google/apis/storage_v1/classes.rb', line 162 def rpo @rpo end |
#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?
Reserved for future use.
Corresponds to the JSON property satisfiesPZS
167 168 169 |
# File 'lib/google/apis/storage_v1/classes.rb', line 167 def satisfies_pzs @satisfies_pzs end |
#self_link ⇒ String
The URI of this bucket.
Corresponds to the JSON property selfLink
173 174 175 |
# File 'lib/google/apis/storage_v1/classes.rb', line 173 def self_link @self_link end |
#storage_class ⇒ String
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.
Corresponds to the JSON property storageClass
184 185 186 |
# File 'lib/google/apis/storage_v1/classes.rb', line 184 def storage_class @storage_class end |
#time_created ⇒ DateTime
The creation time of the bucket in RFC 3339 format.
Corresponds to the JSON property timeCreated
189 190 191 |
# File 'lib/google/apis/storage_v1/classes.rb', line 189 def time_created @time_created end |
#updated ⇒ DateTime
The modification time of the bucket in RFC 3339 format.
Corresponds to the JSON property updated
194 195 196 |
# File 'lib/google/apis/storage_v1/classes.rb', line 194 def updated @updated end |
#versioning ⇒ Google::Apis::StorageV1::Bucket::Versioning
The bucket's versioning configuration.
Corresponds to the JSON property versioning
199 200 201 |
# File 'lib/google/apis/storage_v1/classes.rb', line 199 def versioning @versioning end |
#website ⇒ Google::Apis::StorageV1::Bucket::Website
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.
Corresponds to the JSON property website
206 207 208 |
# File 'lib/google/apis/storage_v1/classes.rb', line 206 def website @website end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'lib/google/apis/storage_v1/classes.rb', line 213 def update!(**args) @acl = args[:acl] if args.key?(:acl) @autoclass = args[:autoclass] if args.key?(:autoclass) @billing = args[:billing] if args.key?(:billing) @cors_configurations = args[:cors_configurations] if args.key?(:cors_configurations) @default_event_based_hold = args[:default_event_based_hold] if args.key?(:default_event_based_hold) @default_object_acl = args[:default_object_acl] if args.key?(:default_object_acl) @encryption = args[:encryption] if args.key?(:encryption) @etag = args[:etag] if args.key?(:etag) @iam_configuration = args[:iam_configuration] if args.key?(:iam_configuration) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @labels = args[:labels] if args.key?(:labels) @lifecycle = args[:lifecycle] if args.key?(:lifecycle) @location = args[:location] if args.key?(:location) @location_type = args[:location_type] if args.key?(:location_type) @logging = args[:logging] if args.key?(:logging) @metageneration = args[:metageneration] if args.key?(:metageneration) @name = args[:name] if args.key?(:name) @owner = args[:owner] if args.key?(:owner) @project_number = args[:project_number] if args.key?(:project_number) @retention_policy = args[:retention_policy] if args.key?(:retention_policy) @rpo = args[:rpo] if args.key?(:rpo) @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @self_link = args[:self_link] if args.key?(:self_link) @storage_class = args[:storage_class] if args.key?(:storage_class) @time_created = args[:time_created] if args.key?(:time_created) @updated = args[:updated] if args.key?(:updated) @versioning = args[:versioning] if args.key?(:versioning) @website = args[:website] if args.key?(:website) end |