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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/storage_v1/classes.rb,
generated/google/apis/storage_v1/representations.rb,
generated/google/apis/storage_v1/representations.rb

Overview

An object.

Defined Under Namespace

Classes: CustomerEncryption, Owner

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Object

Returns a new instance of Object



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

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

Instance Attribute Details

#aclArray<Google::Apis::StorageV1::ObjectAccessControl>

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



1293
1294
1295
# File 'generated/google/apis/storage_v1/classes.rb', line 1293

def acl
  @acl
end

#bucketString

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

Returns:

  • (String)


1298
1299
1300
# File 'generated/google/apis/storage_v1/classes.rb', line 1298

def bucket
  @bucket
end

#cache_controlString

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)


1304
1305
1306
# File 'generated/google/apis/storage_v1/classes.rb', line 1304

def cache_control
  @cache_control
end

#component_countFixnum

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

Returns:

  • (Fixnum)


1310
1311
1312
# File 'generated/google/apis/storage_v1/classes.rb', line 1310

def component_count
  @component_count
end

#content_dispositionString

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

Returns:

  • (String)


1315
1316
1317
# File 'generated/google/apis/storage_v1/classes.rb', line 1315

def content_disposition
  @content_disposition
end

#content_encodingString

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

Returns:

  • (String)


1320
1321
1322
# File 'generated/google/apis/storage_v1/classes.rb', line 1320

def content_encoding
  @content_encoding
end

#content_languageString

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

Returns:

  • (String)


1325
1326
1327
# File 'generated/google/apis/storage_v1/classes.rb', line 1325

def content_language
  @content_language
end

#content_typeString

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)


1331
1332
1333
# File 'generated/google/apis/storage_v1/classes.rb', line 1331

def content_type
  @content_type
end

#crc32cString

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)


1338
1339
1340
# File 'generated/google/apis/storage_v1/classes.rb', line 1338

def crc32c
  @crc32c
end

#customer_encryptionGoogle::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



1344
1345
1346
# File 'generated/google/apis/storage_v1/classes.rb', line 1344

def customer_encryption
  @customer_encryption
end

#etagString

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

Returns:

  • (String)


1349
1350
1351
# File 'generated/google/apis/storage_v1/classes.rb', line 1349

def etag
  @etag
end

#event_based_holdBoolean 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)


1364
1365
1366
# File 'generated/google/apis/storage_v1/classes.rb', line 1364

def event_based_hold
  @event_based_hold
end

#generationFixnum

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

Returns:

  • (Fixnum)


1370
1371
1372
# File 'generated/google/apis/storage_v1/classes.rb', line 1370

def generation
  @generation
end

#idString

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

Returns:

  • (String)


1376
1377
1378
# File 'generated/google/apis/storage_v1/classes.rb', line 1376

def id
  @id
end

#kindString

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

Returns:

  • (String)


1381
1382
1383
# File 'generated/google/apis/storage_v1/classes.rb', line 1381

def kind
  @kind
end

#kms_key_nameString

Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key. Corresponds to the JSON property kmsKeyName

Returns:

  • (String)


1387
1388
1389
# File 'generated/google/apis/storage_v1/classes.rb', line 1387

def kms_key_name
  @kms_key_name
end

#md5_hashString

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)


1393
1394
1395
# File 'generated/google/apis/storage_v1/classes.rb', line 1393

def md5_hash
  @md5_hash
end

Media download link. Corresponds to the JSON property mediaLink

Returns:

  • (String)


1398
1399
1400
# File 'generated/google/apis/storage_v1/classes.rb', line 1398

def media_link
  @media_link
end

#metadataHash<String,String>

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

Returns:

  • (Hash<String,String>)


1403
1404
1405
# File 'generated/google/apis/storage_v1/classes.rb', line 1403

def 
  @metadata
end

#metagenerationFixnum

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)


1411
1412
1413
# File 'generated/google/apis/storage_v1/classes.rb', line 1411

def metageneration
  @metageneration
end

#nameString

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

Returns:

  • (String)


1416
1417
1418
# File 'generated/google/apis/storage_v1/classes.rb', line 1416

def name
  @name
end

#ownerGoogle::Apis::StorageV1::Object::Owner

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



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

def owner
  @owner
end

#retention_expiration_timeDateTime

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)


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

def retention_expiration_time
  @retention_expiration_time
end

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

Returns:

  • (String)


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

def self_link
  @self_link
end

#sizeFixnum

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

Returns:

  • (Fixnum)


1441
1442
1443
# File 'generated/google/apis/storage_v1/classes.rb', line 1441

def size
  @size
end

#storage_classString

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

Returns:

  • (String)


1446
1447
1448
# File 'generated/google/apis/storage_v1/classes.rb', line 1446

def storage_class
  @storage_class
end

#temporary_holdBoolean 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)


1455
1456
1457
# File 'generated/google/apis/storage_v1/classes.rb', line 1455

def temporary_hold
  @temporary_hold
end

#time_createdDateTime

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

Returns:

  • (DateTime)


1461
1462
1463
# File 'generated/google/apis/storage_v1/classes.rb', line 1461

def time_created
  @time_created
end

#time_deletedDateTime

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)


1467
1468
1469
# File 'generated/google/apis/storage_v1/classes.rb', line 1467

def time_deleted
  @time_deleted
end

#time_storage_class_updatedDateTime

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)


1473
1474
1475
# File 'generated/google/apis/storage_v1/classes.rb', line 1473

def time_storage_class_updated
  @time_storage_class_updated
end

#updatedDateTime

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

Returns:

  • (DateTime)


1478
1479
1480
# File 'generated/google/apis/storage_v1/classes.rb', line 1478

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
# File 'generated/google/apis/storage_v1/classes.rb', line 1485

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)
  @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