Class: Google::Apis::StorageV1::Object
- Inherits:
-
Object
- Object
- Google::Apis::StorageV1::Object
- 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
-
#acl ⇒ Array<Google::Apis::StorageV1::ObjectAccessControl>
Access controls on the object.
-
#bucket ⇒ String
The name of the bucket containing this object.
-
#cache_control ⇒ String
Cache-Control directive for the object data.
-
#component_count ⇒ Fixnum
Number of underlying components that make up this object.
-
#content_disposition ⇒ String
Content-Disposition of the object data.
-
#content_encoding ⇒ String
Content-Encoding of the object data.
-
#content_language ⇒ String
Content-Language of the object data.
-
#content_type ⇒ String
Content-Type of the object data.
-
#crc32c ⇒ String
CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order.
-
#custom_time ⇒ DateTime
A timestamp in RFC 3339 format specified by the user for an object.
-
#customer_encryption ⇒ Google::Apis::StorageV1::Object::CustomerEncryption
Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
-
#etag ⇒ String
HTTP 1.1 Entity tag for the object.
-
#event_based_hold ⇒ Boolean
(also: #event_based_hold?)
Whether an object is under event-based hold.
-
#generation ⇒ Fixnum
The content generation of this object.
-
#id ⇒ String
The ID of the object, including the bucket name, object name, and generation number.
-
#kind ⇒ String
The kind of item this is.
-
#kms_key_name ⇒ String
Not currently supported.
-
#md5_hash ⇒ String
MD5 hash of the data; encoded using base64.
-
#media_link ⇒ String
Media download link.
-
#metadata ⇒ Hash<String,String>
User-provided metadata, in key/value pairs.
-
#metageneration ⇒ Fixnum
The version of the metadata for this object at this generation.
-
#name ⇒ String
The name of the object.
-
#owner ⇒ Google::Apis::StorageV1::Object::Owner
The owner of the object.
-
#retention_expiration_time ⇒ DateTime
A server-determined value that specifies the earliest time that the object's retention period expires.
-
#self_link ⇒ String
The link to this object.
-
#size ⇒ Fixnum
Content-Length of the data in bytes.
-
#storage_class ⇒ String
Storage class of the object.
-
#temporary_hold ⇒ Boolean
(also: #temporary_hold?)
Whether an object is under temporary hold.
-
#time_created ⇒ DateTime
The creation time of the object in RFC 3339 format.
-
#time_deleted ⇒ DateTime
The deletion time of the object in RFC 3339 format.
-
#time_storage_class_updated ⇒ DateTime
The time at which the object's storage class was last changed.
-
#updated ⇒ DateTime
The modification time of the object metadata in RFC 3339 format.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Object
constructor
A new instance of Object.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Object
Returns a new instance of Object.
1607 1608 1609 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1607 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
1415 1416 1417 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1415 def acl @acl end |
#bucket ⇒ String
The name of the bucket containing this object.
Corresponds to the JSON property bucket
1420 1421 1422 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1420 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
1426 1427 1428 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1426 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
1432 1433 1434 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1432 def component_count @component_count end |
#content_disposition ⇒ String
Content-Disposition of the object data.
Corresponds to the JSON property contentDisposition
1437 1438 1439 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1437 def content_disposition @content_disposition end |
#content_encoding ⇒ String
Content-Encoding of the object data.
Corresponds to the JSON property contentEncoding
1442 1443 1444 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1442 def content_encoding @content_encoding end |
#content_language ⇒ String
Content-Language of the object data.
Corresponds to the JSON property contentLanguage
1447 1448 1449 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1447 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
1453 1454 1455 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1453 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
1460 1461 1462 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1460 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
1465 1466 1467 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1465 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
1471 1472 1473 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1471 def customer_encryption @customer_encryption end |
#etag ⇒ String
HTTP 1.1 Entity tag for the object.
Corresponds to the JSON property etag
1476 1477 1478 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1476 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
1491 1492 1493 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1491 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
1497 1498 1499 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1497 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
1503 1504 1505 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1503 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
1508 1509 1510 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1508 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
1514 1515 1516 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1514 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
1520 1521 1522 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1520 def md5_hash @md5_hash end |
#media_link ⇒ String
Media download link.
Corresponds to the JSON property mediaLink
1525 1526 1527 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1525 def media_link @media_link end |
#metadata ⇒ Hash<String,String>
User-provided metadata, in key/value pairs.
Corresponds to the JSON property metadata
1530 1531 1532 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1530 def @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
1538 1539 1540 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1538 def @metageneration end |
#name ⇒ String
The name of the object. Required if not specified by URL parameter.
Corresponds to the JSON property name
1543 1544 1545 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1543 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
1548 1549 1550 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1548 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
1558 1559 1560 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1558 def retention_expiration_time @retention_expiration_time end |
#self_link ⇒ String
The link to this object.
Corresponds to the JSON property selfLink
1563 1564 1565 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1563 def self_link @self_link end |
#size ⇒ Fixnum
Content-Length of the data in bytes.
Corresponds to the JSON property size
1568 1569 1570 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1568 def size @size end |
#storage_class ⇒ String
Storage class of the object.
Corresponds to the JSON property storageClass
1573 1574 1575 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1573 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
1582 1583 1584 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1582 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
1588 1589 1590 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1588 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
1594 1595 1596 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1594 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
1600 1601 1602 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1600 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
1605 1606 1607 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1605 def updated @updated end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 |
# File 'lib/google/apis/storage_v1/classes.rb', line 1612 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 |