Class Object (2.9.3)

An object.

Protobuf type google.storage.v2.Object

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Access controls on the object. If iamConfig.uniformBucketLevelAccess is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Access controls on the object. If iamConfig.uniformBucketLevelAccess is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Access controls on the object. If iamConfig.uniformBucketLevelAccess is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Access controls on the object. If iamConfig.uniformBucketLevelAccess is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Access controls on the object. If iamConfig.uniformBucketLevelAccess is enabled on the parent bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl acl = 10;

Immutable. The name of the bucket containing this object.

string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Immutable. The name of the bucket containing this object.

string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Cache-Control directive for the object data, matching https://tools.ietf.org/html/rfc7234#section-5.2 " . If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600 .

string cache_control = 9;

Cache-Control directive for the object data, matching https://tools.ietf.org/html/rfc7234#section-5.2 " . If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600 .

string cache_control = 9;

Output only. Hashes for the data part of this object.

.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Hashes for the data part of this object.

.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Number of underlying components that make up this object. Components are accumulated by compose operations. Attempting to set or update this field will result in a FieldViolation .

int32 component_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266 .

string content_disposition = 8;

Content-Disposition of the object data, matching https://tools.ietf.org/html/rfc6266 .

string content_disposition = 8;

Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2

string content_encoding = 7;

Content-Encoding of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.2.2

string content_encoding = 7;

Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2 .

string content_language = 11;

Content-Language of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.3.2 .

string content_language = 11;

Content-Type of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.1.5 . If an object is stored without a Content-Type, it is served as application/octet-stream .

string content_type = 13;

Content-Type of the object data, matching https://tools.ietf.org/html/rfc7231#section-3.1.1.5 . If an object is stored without a Content-Type, it is served as application/octet-stream .

string content_type = 13;

Output only. The creation time of the object. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The creation time of the object. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.

.google.storage.v2.CustomerEncryption customer_encryption = 25;

Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.

.google.storage.v2.CustomerEncryption customer_encryption = 25;

Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

The etag of the object. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object.

string etag = 27;

The etag of the object. If included in the metadata of an update or delete request message, the operation will only be performed if the etag matches that of the live object.

string etag = 27;

Whether an object is under event-based hold. An event-based hold is a way to force the retention of an object until after some event occurs. Once the hold is released by explicitly setting this field to false, the object will become subject to any bucket-level retention policy, except that the retention duration will be calculated from the time the event based hold was lifted, rather than the time the object was created. In a WriteObject request, not setting this field implies that the value should be taken from the parent bucket's "default_event_based_hold" field. In a response, this field will always be set to true or false.

optional bool event_based_hold = 23;

Immutable. The content generation of this object. Used for object versioning. Attempting to set or update this field will result in a FieldViolation .

int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];

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

string kms_key = 18 [(.google.api.resource_reference) = { ... }

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

string kms_key = 18 [(.google.api.resource_reference) = { ... }

Use #getMetadataMap() instead.

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Output only. The version of the metadata for this generation of this object. 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. Attempting to set or update this field will result in a FieldViolation .

int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See Guidelines . Example: test.txt The name field by itself does not uniquely identify a Cloud Storage object. A Cloud Storage object is uniquely identified by the tuple of (bucket, object, generation).

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See Guidelines . Example: test.txt The name field by itself does not uniquely identify a Cloud Storage object. A Cloud Storage object is uniquely identified by the tuple of (bucket, object, generation).

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a FieldViolation .

.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a FieldViolation .

.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

A server-determined value that specifies the earliest time that the object's retention period expires. 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).

.google.protobuf.Timestamp retention_expire_time = 21;

A server-determined value that specifies the earliest time that the object's retention period expires. 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).

.google.protobuf.Timestamp retention_expire_time = 21;

Output only. Content-Length of the object data in bytes, matching https://tools.ietf.org/html/rfc7230#section-3.3.2 . Attempting to set or update this field will result in a FieldViolation .

int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Storage class of the object.

string storage_class = 5;

Storage class of the object.

string storage_class = 5;

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.

bool temporary_hold = 20;

Output only. The time at which the object's storage class was last changed. When the object is initially created, it will be set to time_created. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The time at which the object's storage class was last changed. When the object is initially created, it will be set to time_created. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The modification time of the object metadata. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The modification time of the object metadata. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. Hashes for the data part of this object.

.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The creation time of the object. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.

.google.storage.v2.CustomerEncryption customer_encryption = 25;

Output only. The deletion time of the object. Will be returned if and only if this version of the object has been deleted. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Whether an object is under event-based hold. An event-based hold is a way to force the retention of an object until after some event occurs. Once the hold is released by explicitly setting this field to false, the object will become subject to any bucket-level retention policy, except that the retention duration will be calculated from the time the event based hold was lifted, rather than the time the object was created. In a WriteObject request, not setting this field implies that the value should be taken from the parent bucket's "default_event_based_hold" field. In a response, this field will always be set to true or false.

optional bool event_based_hold = 23;

Output only. The owner of the object. This will always be the uploader of the object. Attempting to set or update this field will result in a FieldViolation .

.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

A server-determined value that specifies the earliest time that the object's retention period expires. 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).

.google.protobuf.Timestamp retention_expire_time = 21;

Output only. The time at which the object's storage class was last changed. When the object is initially created, it will be set to time_created. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Output only. The modification time of the object metadata. Attempting to set or update this field will result in a FieldViolation .

.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];