class

GoogleCloudStorage::Object

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

An object.

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

acl

Access controls on the object.

Source

Custom attribute writer method checking allowed values (enum). @param [Object] acl Object to be assigned

Source
bucket

The name of the bucket containing this object.

Source
bucket=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] bucket Object to be assigned

Source
cache_control

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.

Source
cache_control=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cache_control Object to be assigned

Source
component_count

Number of underlying components that make up this object. Components are accumulated by compose operations.

Source
component_count=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] component_count Object to be assigned

Source
content_disposition

Content-Disposition of the object data.

Source
content_disposition=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] content_disposition Object to be assigned

Source
content_encoding

Content-Encoding of the object data.

Source
content_encoding=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] content_encoding Object to be assigned

Source
content_language

Content-Language of the object data.

Source
content_language=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] content_language Object to be assigned

Source
content_type

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

Source
content_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] content_type Object to be assigned

Source
crc32c

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.

Source
crc32c=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] crc32c Object to be assigned

Source
custom_time

A timestamp in RFC 3339 format specified by the user for an object.

Source
custom_time=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] custom_time Object to be assigned

Source
customer_encryption
Source
customer_encryption=(new_value : GoogleCloudStorage::ObjectCustomerEncryption | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] customer_encryption Object to be assigned

Source
etag

HTTP 1.1 Entity tag for the object.

Source
etag=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] etag Object to be assigned

Source
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.

Source
event_based_hold=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] event_based_hold Object to be assigned

Source
generation

The content generation of this object. Used for object versioning.

Source
generation=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] generation Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

The ID of the object, including the bucket name, object name, and generation number.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
kind

The kind of item this is. For objects, this is always storage#object.

Source
kind=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] kind Object to be assigned

Source
kms_key_name

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

Source
kms_key_name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] kms_key_name Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
md5_hash

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

Source
md5_hash=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] md5_hash Object to be assigned

Source
metadata

User-provided metadata, in key/value pairs.

Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
metageneration

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.

Source
metageneration=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metageneration Object to be assigned

Source
name

The name of the object. Required if not specified by URL parameter.

Source
name=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned

Source
owner
Source
owner=(new_value : GoogleCloudStorage::ObjectOwner | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] owner Object to be assigned

Source
retention_expiration_time

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

Source
retention_expiration_time=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] retention_expiration_time Object to be assigned

Source
size

Content-Length of the data in bytes.

Source
size=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] size Object to be assigned

Source
storage_class

Storage class of the object.

Source
storage_class=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] storage_class Object to be assigned

Source
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.

Source
temporary_hold=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] temporary_hold Object to be assigned

Source
time_created

The creation time of the object in RFC 3339 format.

Source
time_created=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] time_created Object to be assigned

Source
time_deleted

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.

Source
time_deleted=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] time_deleted Object to be assigned

Source
time_storage_class_updated

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

Source
time_storage_class_updated=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] time_storage_class_updated Object to be assigned

Source
updated

The modification time of the object metadata in RFC 3339 format.

Source
updated=(new_value : Time | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] updated Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source