Class: Google::Apis::StorageV1::Bucket

Inherits:
Object
  • Object
show all
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, CustomPlacementConfig, Encryption, HierarchicalNamespace, IamConfiguration, IpFilter, Lifecycle, Logging, ObjectRetention, Owner, RetentionPolicy, SoftDeletePolicy, Versioning, Website

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Bucket

Returns a new instance of Bucket.



357
358
359
 
# File 'lib/google/apis/storage_v1/classes.rb', line 357

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

Returns:



153
154
155
 
# File 'lib/google/apis/storage_v1/classes.rb', line 153

def acl
  @acl
end

#autoclass ⇒ Google::Apis::StorageV1::Bucket::Autoclass

The bucket's Autoclass configuration. Corresponds to the JSON property autoclass

Returns:



158
159
160
 
# File 'lib/google/apis/storage_v1/classes.rb', line 158

def autoclass
  @autoclass
end

#billing ⇒ Google::Apis::StorageV1::Bucket::Billing

The bucket's billing configuration. Corresponds to the JSON property billing

Returns:



163
164
165
 
# File 'lib/google/apis/storage_v1/classes.rb', line 163

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

Returns:



168
169
170
 
# File 'lib/google/apis/storage_v1/classes.rb', line 168

def cors_configurations
  @cors_configurations
end

#custom_placement_config ⇒ Google::Apis::StorageV1::Bucket::CustomPlacementConfig

The bucket's custom placement configuration for Custom Dual Regions. Corresponds to the JSON property customPlacementConfig

Returns:



173
174
175
 
# File 'lib/google/apis/storage_v1/classes.rb', line 173

def custom_placement_config
  @custom_placement_config
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

Returns:

  • (Boolean) 


189
190
191
 
# File 'lib/google/apis/storage_v1/classes.rb', line 189

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

Returns:



195
196
197
 
# File 'lib/google/apis/storage_v1/classes.rb', line 195

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

Returns:



200
201
202
 
# File 'lib/google/apis/storage_v1/classes.rb', line 200

def encryption
  @encryption
end

#etag ⇒ String

HTTP 1.1 Entity tag for the bucket. Corresponds to the JSON property etag

Returns:

  • (String) 


205
206
207
 
# File 'lib/google/apis/storage_v1/classes.rb', line 205

def etag
  @etag
end

#hierarchical_namespace ⇒ Google::Apis::StorageV1::Bucket::HierarchicalNamespace

The bucket's hierarchical namespace configuration. Corresponds to the JSON property hierarchicalNamespace

Returns:



210
211
212
 
# File 'lib/google/apis/storage_v1/classes.rb', line 210

def hierarchical_namespace
  @hierarchical_namespace
end

#iam_configuration ⇒ Google::Apis::StorageV1::Bucket::IamConfiguration

The bucket's IAM configuration. Corresponds to the JSON property iamConfiguration

Returns:



215
216
217
 
# File 'lib/google/apis/storage_v1/classes.rb', line 215

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

Returns:

  • (String) 


220
221
222
 
# File 'lib/google/apis/storage_v1/classes.rb', line 220

def id
  @id
end

#ip_filter ⇒ Google::Apis::StorageV1::Bucket::IpFilter

The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'. Corresponds to the JSON property ipFilter

Returns:



227
228
229
 
# File 'lib/google/apis/storage_v1/classes.rb', line 227

def ip_filter
  @ip_filter
end

#kind ⇒ String

The kind of item this is. For buckets, this is always storage#bucket. Corresponds to the JSON property kind

Returns:

  • (String) 


232
233
234
 
# File 'lib/google/apis/storage_v1/classes.rb', line 232

def kind
  @kind
end

#labels ⇒ Hash<String,String>

User-provided labels, in key/value pairs. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


237
238
239
 
# File 'lib/google/apis/storage_v1/classes.rb', line 237

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

Returns:



243
244
245
 
# File 'lib/google/apis/storage_v1/classes.rb', line 243

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

Returns:

  • (String) 


250
251
252
 
# File 'lib/google/apis/storage_v1/classes.rb', line 250

def location
  @location
end

#location_type ⇒ String

The type of the bucket location. Corresponds to the JSON property locationType

Returns:

  • (String) 


255
256
257
 
# File 'lib/google/apis/storage_v1/classes.rb', line 255

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

Returns:



261
262
263
 
# File 'lib/google/apis/storage_v1/classes.rb', line 261

def logging
  @logging
end

#metageneration ⇒ Fixnum

The metadata generation of this bucket. Corresponds to the JSON property metageneration

Returns:

  • (Fixnum) 


266
267
268
 
# File 'lib/google/apis/storage_v1/classes.rb', line 266

def metageneration
  @metageneration
end

#name ⇒ String

The name of the bucket. Corresponds to the JSON property name

Returns:

  • (String) 


271
272
273
 
# File 'lib/google/apis/storage_v1/classes.rb', line 271

def name
  @name
end

#object_retention ⇒ Google::Apis::StorageV1::Bucket::ObjectRetention

The bucket's object retention config. Corresponds to the JSON property objectRetention

Returns:



276
277
278
 
# File 'lib/google/apis/storage_v1/classes.rb', line 276

def object_retention
  @object_retention
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

Returns:



281
282
283
 
# File 'lib/google/apis/storage_v1/classes.rb', line 281

def owner
  @owner
end

#project_number ⇒ Fixnum

The project number of the project the bucket belongs to. Corresponds to the JSON property projectNumber

Returns:

  • (Fixnum) 


286
287
288
 
# File 'lib/google/apis/storage_v1/classes.rb', line 286

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

Returns:



299
300
301
 
# File 'lib/google/apis/storage_v1/classes.rb', line 299

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

Returns:

  • (String) 


305
306
307
 
# File 'lib/google/apis/storage_v1/classes.rb', line 305

def rpo
  @rpo
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Reserved for future use. Corresponds to the JSON property satisfiesPZS

Returns:

  • (Boolean) 


310
311
312
 
# File 'lib/google/apis/storage_v1/classes.rb', line 310

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

The URI of this bucket. Corresponds to the JSON property selfLink

Returns:

  • (String) 


316
317
318
 
# File 'lib/google/apis/storage_v1/classes.rb', line 316

def self_link
  @self_link
end

#soft_delete_policy ⇒ Google::Apis::StorageV1::Bucket::SoftDeletePolicy

The bucket's soft delete policy, which defines the period of time that soft- deleted objects will be retained, and cannot be permanently deleted. Corresponds to the JSON property softDeletePolicy

Returns:



322
323
324
 
# File 'lib/google/apis/storage_v1/classes.rb', line 322

def soft_delete_policy
  @soft_delete_policy
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

Returns:

  • (String) 


333
334
335
 
# File 'lib/google/apis/storage_v1/classes.rb', line 333

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

Returns:

  • (DateTime) 


338
339
340
 
# File 'lib/google/apis/storage_v1/classes.rb', line 338

def time_created
  @time_created
end

#updated ⇒ DateTime

The modification time of the bucket in RFC 3339 format. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


343
344
345
 
# File 'lib/google/apis/storage_v1/classes.rb', line 343

def updated
  @updated
end

#versioning ⇒ Google::Apis::StorageV1::Bucket::Versioning

The bucket's versioning configuration. Corresponds to the JSON property versioning

Returns:



348
349
350
 
# File 'lib/google/apis/storage_v1/classes.rb', line 348

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

Returns:



355
356
357
 
# File 'lib/google/apis/storage_v1/classes.rb', line 355

def website
  @website
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/google/apis/storage_v1/classes.rb', line 362

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)
  @custom_placement_config = args[:custom_placement_config] if args.key?(:custom_placement_config)
  @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)
  @hierarchical_namespace = args[:hierarchical_namespace] if args.key?(:hierarchical_namespace)
  @iam_configuration = args[:iam_configuration] if args.key?(:iam_configuration)
  @id = args[:id] if args.key?(:id)
  @ip_filter = args[:ip_filter] if args.key?(:ip_filter)
  @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)
  @object_retention = args[:object_retention] if args.key?(:object_retention)
  @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)
  @soft_delete_policy = args[:soft_delete_policy] if args.key?(:soft_delete_policy)
  @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