Class: Google::Apis::StorageV1::Object

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

An object.

Defined Under Namespace

Classes: CustomerEncryption, Owner

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Object

Returns a new instance of Object.



1596
1597
1598
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1596

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acl ⇒ Array<Google::Apis::StorageV1::ObjectAccessControl>

Access controls on the object. Corresponds to the JSON property acl

Returns:



1404
1405
1406
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1404

def acl
  @acl
end

#bucket ⇒ String

The name of the bucket containing this object. Corresponds to the JSON property bucket

Returns:

  • (String) 


1409
1410
1411
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1409

def bucket
  @bucket
end

#cache_control ⇒ String

Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. Corresponds to the JSON property cacheControl

Returns:

  • (String) 


1415
1416
1417
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1415

def cache_control
  @cache_control
end

#component_count ⇒ Fixnum

Number of underlying components that make up this object. Components are accumulated by compose operations. Corresponds to the JSON property componentCount

Returns:

  • (Fixnum) 


1421
1422
1423
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1421

def component_count
  @component_count
end

#content_disposition ⇒ String

Content-Disposition of the object data. Corresponds to the JSON property contentDisposition

Returns:

  • (String) 


1426
1427
1428
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1426

def content_disposition
  @content_disposition
end

#content_encoding ⇒ String

Content-Encoding of the object data. Corresponds to the JSON property contentEncoding

Returns:

  • (String) 


1431
1432
1433
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1431

def content_encoding
  @content_encoding
end

#content_language ⇒ String

Content-Language of the object data. Corresponds to the JSON property contentLanguage

Returns:

  • (String) 


1436
1437
1438
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1436

def content_language
  @content_language
end

#content_type ⇒ String

Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. Corresponds to the JSON property contentType

Returns:

  • (String) 


1442
1443
1444
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1442

def content_type
  @content_type
end

#crc32c ⇒ String

CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. Corresponds to the JSON property crc32c

Returns:

  • (String) 


1449
1450
1451
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1449

def crc32c
  @crc32c
end

#custom_time ⇒ DateTime

A timestamp in RFC 3339 format specified by the user for an object. Corresponds to the JSON property customTime

Returns:

  • (DateTime) 


1454
1455
1456
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1454

def custom_time
  @custom_time
end

#customer_encryption ⇒ Google::Apis::StorageV1::Object::CustomerEncryption

Metadata of customer-supplied encryption key, if the object is encrypted by such a key. Corresponds to the JSON property customerEncryption

Returns:



1460
1461
1462
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1460

def customer_encryption
  @customer_encryption
end

#etag ⇒ String

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

Returns:

  • (String) 


1465
1466
1467
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1465

def etag
  @etag
end

#event_based_hold ⇒ Boolean Also known as: event_based_hold?

Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), 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 the 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. Corresponds to the JSON property eventBasedHold

Returns:

  • (Boolean) 


1480
1481
1482
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1480

def event_based_hold
  @event_based_hold
end

#generation ⇒ Fixnum

The content generation of this object. Used for object versioning. Corresponds to the JSON property generation

Returns:

  • (Fixnum) 


1486
1487
1488
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1486

def generation
  @generation
end

#id ⇒ String

The ID of the object, including the bucket name, object name, and generation number. Corresponds to the JSON property id

Returns:

  • (String) 


1492
1493
1494
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1492

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


1497
1498
1499
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1497

def kind
  @kind
end

#kms_key_name ⇒ String

Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request. Corresponds to the JSON property kmsKeyName

Returns:

  • (String) 


1503
1504
1505
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1503

def kms_key_name
  @kms_key_name
end

#md5_hash ⇒ String

MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. Corresponds to the JSON property md5Hash

Returns:

  • (String) 


1509
1510
1511
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1509

def md5_hash
  @md5_hash
end

#media_link ⇒ String

Media download link. Corresponds to the JSON property mediaLink

Returns:

  • (String) 


1514
1515
1516
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1514

def media_link
  @media_link
end

#metadata ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1519
1520
1521
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1519

def metadata
  @metadata
end

#metageneration ⇒ Fixnum

The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. Corresponds to the JSON property metageneration

Returns:

  • (Fixnum) 


1527
1528
1529
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1527

def metageneration
  @metageneration
end

#name ⇒ String

The name of the object. Required if not specified by URL parameter. Corresponds to the JSON property name

Returns:

  • (String) 


1532
1533
1534
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1532

def name
  @name
end

#owner ⇒ Google::Apis::StorageV1::Object::Owner

The owner of the object. This will always be the uploader of the object. Corresponds to the JSON property owner

Returns:



1537
1538
1539
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1537

def owner
  @owner
end

#retention_expiration_time ⇒ DateTime

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold). Corresponds to the JSON property retentionExpirationTime

Returns:

  • (DateTime) 


1547
1548
1549
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1547

def retention_expiration_time
  @retention_expiration_time
end

#self_link ⇒ String

The link to this object. Corresponds to the JSON property selfLink

Returns:

  • (String) 


1552
1553
1554
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1552

def self_link
  @self_link
end

#size ⇒ Fixnum

Content-Length of the data in bytes. Corresponds to the JSON property size

Returns:

  • (Fixnum) 


1557
1558
1559
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1557

def size
  @size
end

#storage_class ⇒ String

Storage class of the object. Corresponds to the JSON property storageClass

Returns:

  • (String) 


1562
1563
1564
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1562

def storage_class
  @storage_class
end

#temporary_hold ⇒ Boolean Also known as: temporary_hold?

Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object. Corresponds to the JSON property temporaryHold

Returns:

  • (Boolean) 


1571
1572
1573
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1571

def temporary_hold
  @temporary_hold
end

#time_created ⇒ DateTime

The creation time of the object in RFC 3339 format. Corresponds to the JSON property timeCreated

Returns:

  • (DateTime) 


1577
1578
1579
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1577

def time_created
  @time_created
end

#time_deleted ⇒ DateTime

The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. Corresponds to the JSON property timeDeleted

Returns:

  • (DateTime) 


1583
1584
1585
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1583

def time_deleted
  @time_deleted
end

#time_storage_class_updated ⇒ DateTime

The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. Corresponds to the JSON property timeStorageClassUpdated

Returns:

  • (DateTime) 


1589
1590
1591
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1589

def time_storage_class_updated
  @time_storage_class_updated
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


1594
1595
1596
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1594

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/google/apis/storage_v1/classes.rb', line 1601

def update!(**args)
  @acl = args[:acl] if args.key?(:acl)
  @bucket = args[:bucket] if args.key?(:bucket)
  @cache_control = args[:cache_control] if args.key?(:cache_control)
  @component_count = args[:component_count] if args.key?(:component_count)
  @content_disposition = args[:content_disposition] if args.key?(:content_disposition)
  @content_encoding = args[:content_encoding] if args.key?(:content_encoding)
  @content_language = args[:content_language] if args.key?(:content_language)
  @content_type = args[:content_type] if args.key?(:content_type)
  @crc32c = args[:crc32c] if args.key?(:crc32c)
  @custom_time = args[:custom_time] if args.key?(:custom_time)
  @customer_encryption = args[:customer_encryption] if args.key?(:customer_encryption)
  @etag = args[:etag] if args.key?(:etag)
  @event_based_hold = args[:event_based_hold] if args.key?(:event_based_hold)
  @generation = args[:generation] if args.key?(:generation)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @md5_hash = args[:md5_hash] if args.key?(:md5_hash)
  @media_link = args[:media_link] if args.key?(:media_link)
  @metadata = args[:metadata] if args.key?(:metadata)
  @metageneration = args[:metageneration] if args.key?(:metageneration)
  @name = args[:name] if args.key?(:name)
  @owner = args[:owner] if args.key?(:owner)
  @retention_expiration_time = args[:retention_expiration_time] if args.key?(:retention_expiration_time)
  @self_link = args[:self_link] if args.key?(:self_link)
  @size = args[:size] if args.key?(:size)
  @storage_class = args[:storage_class] if args.key?(:storage_class)
  @temporary_hold = args[:temporary_hold] if args.key?(:temporary_hold)
  @time_created = args[:time_created] if args.key?(:time_created)
  @time_deleted = args[:time_deleted] if args.key?(:time_deleted)
  @time_storage_class_updated = args[:time_storage_class_updated] if args.key?(:time_storage_class_updated)
  @updated = args[:updated] if args.key?(:updated)
end