public interface ObjectOrBuilder
extends com.google.protobuf.MessageOrBuilder
Modifier and Type | Method and Description |
---|---|
boolean |
containsMetadata(String key)
User-provided metadata, in key/value pairs.
|
ObjectAccessControl |
getAcl(int index)
Access controls on the object.
|
int |
getAclCount()
Access controls on the object.
|
List<ObjectAccessControl> |
getAclList()
Access controls on the object.
|
ObjectAccessControlOrBuilder |
getAclOrBuilder(int index)
Access controls on the object.
|
List<? extends ObjectAccessControlOrBuilder> |
getAclOrBuilderList()
Access controls on the object.
|
String |
getBucket()
Immutable.
|
com.google.protobuf.ByteString |
getBucketBytes()
Immutable.
|
String |
getCacheControl()
Cache-Control directive for the object data, matching
[https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
|
com.google.protobuf.ByteString |
getCacheControlBytes()
Cache-Control directive for the object data, matching
[https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
|
ObjectChecksums |
getChecksums()
Output only.
|
ObjectChecksumsOrBuilder |
getChecksumsOrBuilder()
Output only.
|
int |
getComponentCount()
Output only.
|
String |
getContentDisposition()
Content-Disposition of the object data, matching
[https://tools.ietf.org/html/rfc6266][RFC 6266].
|
com.google.protobuf.ByteString |
getContentDispositionBytes()
Content-Disposition of the object data, matching
[https://tools.ietf.org/html/rfc6266][RFC 6266].
|
String |
getContentEncoding()
Content-Encoding of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
|
com.google.protobuf.ByteString |
getContentEncodingBytes()
Content-Encoding of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
|
String |
getContentLanguage()
Content-Language of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
|
com.google.protobuf.ByteString |
getContentLanguageBytes()
Content-Language of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
|
String |
getContentType()
Content-Type of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
|
com.google.protobuf.ByteString |
getContentTypeBytes()
Content-Type of the object data, matching
[https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
CustomerEncryption |
getCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
such a key.
|
CustomerEncryptionOrBuilder |
getCustomerEncryptionOrBuilder()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
such a key.
|
com.google.protobuf.Timestamp |
getCustomTime()
A user-specified timestamp set on an object.
|
com.google.protobuf.TimestampOrBuilder |
getCustomTimeOrBuilder()
A user-specified timestamp set on an object.
|
com.google.protobuf.Timestamp |
getDeleteTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getDeleteTimeOrBuilder()
Output only.
|
String |
getEtag()
The etag of the object.
|
com.google.protobuf.ByteString |
getEtagBytes()
The etag of the object.
|
boolean |
getEventBasedHold()
Whether an object is under event-based hold.
|
long |
getGeneration()
Immutable.
|
String |
getKmsKey()
Cloud KMS Key used to encrypt this object, if the object is encrypted by
such a key.
|
com.google.protobuf.ByteString |
getKmsKeyBytes()
Cloud KMS Key used to encrypt this object, if the object is encrypted by
such a key.
|
Map<String,String> |
getMetadata()
Deprecated.
|
int |
getMetadataCount()
User-provided metadata, in key/value pairs.
|
Map<String,String> |
getMetadataMap()
User-provided metadata, in key/value pairs.
|
String |
getMetadataOrDefault(String key,
String defaultValue)
User-provided metadata, in key/value pairs.
|
String |
getMetadataOrThrow(String key)
User-provided metadata, in key/value pairs.
|
long |
getMetageneration()
Output only.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
Owner |
getOwner()
Output only.
|
OwnerOrBuilder |
getOwnerOrBuilder()
Output only.
|
com.google.protobuf.Timestamp |
getRetentionExpireTime()
A server-determined value that specifies the earliest time that the
object's retention period expires.
|
com.google.protobuf.TimestampOrBuilder |
getRetentionExpireTimeOrBuilder()
A server-determined value that specifies the earliest time that the
object's retention period expires.
|
long |
getSize()
Output only.
|
String |
getStorageClass()
Storage class of the object.
|
com.google.protobuf.ByteString |
getStorageClassBytes()
Storage class of the object.
|
boolean |
getTemporaryHold()
Whether an object is under temporary hold.
|
com.google.protobuf.Timestamp |
getUpdateStorageClassTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateStorageClassTimeOrBuilder()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasChecksums()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
such a key.
|
boolean |
hasCustomTime()
A user-specified timestamp set on an object.
|
boolean |
hasDeleteTime()
Output only.
|
boolean |
hasEventBasedHold()
Whether an object is under event-based hold.
|
boolean |
hasOwner()
Output only.
|
boolean |
hasRetentionExpireTime()
A server-determined value that specifies the earliest time that the
object's retention period expires.
|
boolean |
hasUpdateStorageClassTime()
Output only.
|
boolean |
hasUpdateTime()
Output only.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
String getName()
Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See [Guidelines](https://cloud.google.com/storage/docs/objects#naming). 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];
com.google.protobuf.ByteString getNameBytes()
Immutable. The name of this object. Nearly any sequence of unicode characters is valid. See [Guidelines](https://cloud.google.com/storage/docs/objects#naming). 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];
String getBucket()
Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
com.google.protobuf.ByteString getBucketBytes()
Immutable. The name of the bucket containing this object.
string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
String getEtag()
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;
com.google.protobuf.ByteString getEtagBytes()
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;
long getGeneration()
Immutable. The content generation of this object. Used for object versioning. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];
long getMetageneration()
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][google.rpc.BadRequest.FieldViolation].
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
String getStorageClass()
Storage class of the object.
string storage_class = 5;
com.google.protobuf.ByteString getStorageClassBytes()
Storage class of the object.
string storage_class = 5;
long getSize()
Output only. Content-Length of the object data in bytes, matching [https://tools.ietf.org/html/rfc7230#section-3.3.2][RFC 7230 §3.3.2]. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
String getContentEncoding()
Content-Encoding of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
string content_encoding = 7;
com.google.protobuf.ByteString getContentEncodingBytes()
Content-Encoding of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
string content_encoding = 7;
String getContentDisposition()
Content-Disposition of the object data, matching [https://tools.ietf.org/html/rfc6266][RFC 6266].
string content_disposition = 8;
com.google.protobuf.ByteString getContentDispositionBytes()
Content-Disposition of the object data, matching [https://tools.ietf.org/html/rfc6266][RFC 6266].
string content_disposition = 8;
String getCacheControl()
Cache-Control directive for the object data, matching [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §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;
com.google.protobuf.ByteString getCacheControlBytes()
Cache-Control directive for the object data, matching [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §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;
List<ObjectAccessControl> getAclList()
Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl acl = 10;
ObjectAccessControl getAcl(int index)
Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl acl = 10;
int getAclCount()
Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl acl = 10;
List<? extends ObjectAccessControlOrBuilder> getAclOrBuilderList()
Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl acl = 10;
ObjectAccessControlOrBuilder getAclOrBuilder(int index)
Access controls on the object. If iam_config.uniform_bucket_level_access is enabled on the parent bucket, requests to set, read, or modify acl is an error.
repeated .google.storage.v2.ObjectAccessControl acl = 10;
String getContentLanguage()
Content-Language of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
string content_language = 11;
com.google.protobuf.ByteString getContentLanguageBytes()
Content-Language of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
string content_language = 11;
boolean hasDeleteTime()
Output only. If this object is noncurrent, this is the time when the object became noncurrent. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getDeleteTime()
Output only. If this object is noncurrent, this is the time when the object became noncurrent. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
Output only. If this object is noncurrent, this is the time when the object became noncurrent. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
String getContentType()
Content-Type of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5]. If an object is stored without a Content-Type, it is served as `application/octet-stream`.
string content_type = 13;
com.google.protobuf.ByteString getContentTypeBytes()
Content-Type of the object data, matching [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5]. If an object is stored without a Content-Type, it is served as `application/octet-stream`.
string content_type = 13;
boolean hasCreateTime()
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getCreateTime()
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time of the object. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
int getComponentCount()
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][google.rpc.BadRequest.FieldViolation].
int32 component_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasChecksums()
Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests.
.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
ObjectChecksums getChecksums()
Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests.
.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
ObjectChecksumsOrBuilder getChecksumsOrBuilder()
Output only. Hashes for the data part of this object. This field is used for output only and will be silently ignored if provided in requests.
.google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasUpdateTime()
Output only. The modification time of the object metadata. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getUpdateTime()
Output only. The modification time of the object metadata. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The modification time of the object metadata. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
String getKmsKey()
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) = { ... }
com.google.protobuf.ByteString getKmsKeyBytes()
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) = { ... }
boolean hasUpdateStorageClassTime()
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.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getUpdateStorageClassTime()
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.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getUpdateStorageClassTimeOrBuilder()
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.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean getTemporaryHold()
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;
boolean hasRetentionExpireTime()
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;
com.google.protobuf.Timestamp getRetentionExpireTime()
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;
com.google.protobuf.TimestampOrBuilder getRetentionExpireTimeOrBuilder()
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;
int getMetadataCount()
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
boolean containsMetadata(String key)
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
@Deprecated Map<String,String> getMetadata()
getMetadataMap()
instead.Map<String,String> getMetadataMap()
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
String getMetadataOrDefault(String key, String defaultValue)
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
String getMetadataOrThrow(String key)
User-provided metadata, in key/value pairs.
map<string, string> metadata = 22;
boolean hasEventBasedHold()
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;
boolean getEventBasedHold()
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;
boolean hasOwner()
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.rpc.BadRequest.FieldViolation].
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
Owner getOwner()
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.rpc.BadRequest.FieldViolation].
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
OwnerOrBuilder getOwnerOrBuilder()
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.rpc.BadRequest.FieldViolation].
.google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean hasCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
CustomerEncryption getCustomerEncryption()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()
Metadata of Customer-Supplied Encryption Key, if the object is encrypted by such a key.
.google.storage.v2.CustomerEncryption customer_encryption = 25;
boolean hasCustomTime()
A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
com.google.protobuf.Timestamp getCustomTime()
A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
com.google.protobuf.TimestampOrBuilder getCustomTimeOrBuilder()
A user-specified timestamp set on an object.
.google.protobuf.Timestamp custom_time = 26;
Copyright © 2023 Google LLC. All rights reserved.