Interface ObjectOrBuilder (2.2.3)

public interface ObjectOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAcl(int index)

public abstract ObjectAccessControl getAcl(int index)

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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ObjectAccessControl

getAclCount()

public abstract int getAclCount()

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;

Returns

Type	Description
int

getAclList()

public abstract List<ObjectAccessControl> getAclList()

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;

Returns

Type	Description
List<ObjectAccessControl>

getAclOrBuilder(int index)

public abstract ObjectAccessControlOrBuilder getAclOrBuilder(int index)

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;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ObjectAccessControlOrBuilder

getAclOrBuilderList()

public abstract List<? extends ObjectAccessControlOrBuilder> getAclOrBuilderList()

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;

Returns

Type	Description
List<? extends com.google.storage.v2.ObjectAccessControlOrBuilder>

getBucket()

public abstract String getBucket()

Immutable. The name of the bucket containing this object.

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

Returns

Type	Description
String	The bucket.

getBucketBytes()

public abstract ByteString getBucketBytes()

Immutable. The name of the bucket containing this object.

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

Returns

Type	Description
ByteString	The bytes for bucket.

getCacheControl()

public abstract String getCacheControl()

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;

Returns

Type	Description
String	The cacheControl.

getCacheControlBytes()

public abstract ByteString getCacheControlBytes()

string cache_control = 9;

Returns

Type	Description
ByteString	The bytes for cacheControl.

getChecksums()

public abstract ObjectChecksums getChecksums()

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

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

Returns

Type	Description
ObjectChecksums	The checksums.

getChecksumsOrBuilder()

public abstract ObjectChecksumsOrBuilder getChecksumsOrBuilder()

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

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

Returns

Type	Description
ObjectChecksumsOrBuilder

getComponentCount()

public abstract 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.

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

Returns

Type	Description
int	The componentCount.

getContentDisposition()

public abstract String getContentDisposition()

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

string content_disposition = 8;

Returns

Type	Description
String	The contentDisposition.

getContentDispositionBytes()

public abstract ByteString getContentDispositionBytes()

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

string content_disposition = 8;

Returns

Type	Description
ByteString	The bytes for contentDisposition.

getContentEncoding()

public abstract String getContentEncoding()

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

string content_encoding = 7;

Returns

Type	Description
String	The contentEncoding.

getContentEncodingBytes()

public abstract ByteString getContentEncodingBytes()

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

string content_encoding = 7;

Returns

Type	Description
ByteString	The bytes for contentEncoding.

getContentLanguage()

public abstract String getContentLanguage()

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

string content_language = 11;

Returns

Type	Description
String	The contentLanguage.

getContentLanguageBytes()

public abstract ByteString getContentLanguageBytes()

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

string content_language = 11;

Returns

Type	Description
ByteString	The bytes for contentLanguage.

getContentType()

public abstract String getContentType()

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;

Returns

Type	Description
String	The contentType.

getContentTypeBytes()

public abstract ByteString getContentTypeBytes()

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;

Returns

Type	Description
ByteString	The bytes for contentType.

getCreateTime()

public abstract Timestamp getCreateTime()

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];

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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];

Returns

Type	Description
TimestampOrBuilder

getCustomTime()

public abstract Timestamp getCustomTime()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns

Type	Description
Timestamp	The customTime.

getCustomTimeOrBuilder()

public abstract TimestampOrBuilder getCustomTimeOrBuilder()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns

Type	Description
TimestampOrBuilder

getCustomerEncryption()

public abstract Object.CustomerEncryption getCustomerEncryption()

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

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

Returns

Type	Description
Object.CustomerEncryption	The customerEncryption.

getCustomerEncryptionOrBuilder()

public abstract Object.CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

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

Returns

Type	Description
Object.CustomerEncryptionOrBuilder

getDeleteTime()

public abstract Timestamp getDeleteTime()

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];

Returns

Type	Description
Timestamp	The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

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];

Returns

Type	Description
TimestampOrBuilder

getEventBasedHold()

public abstract 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;

Returns

Type	Description
boolean	The eventBasedHold.

getGeneration()

public abstract 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.

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

Returns

Type	Description
long	The generation.

getKmsKey()

public abstract 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) = { ... }

Returns

Type	Description
String	The kmsKey.

getKmsKeyBytes()

public abstract 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) = { ... }

Returns

Type	Description
ByteString	The bytes for kmsKey.

getMetadata()

public abstract Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns

Type	Description
Map<String,String>

getMetadataCount()

public abstract int getMetadataCount()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Returns

Type	Description
int

getMetadataMap()

public abstract Map<String,String> getMetadataMap()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Returns

Type	Description
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public abstract String getMetadataOrDefault(String key, String defaultValue)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getMetadataOrThrow(String key)

public abstract String getMetadataOrThrow(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getMetageneration()

public abstract 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.

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

Returns

Type	Description
long	The metageneration.

getName()

public abstract String getName()

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];

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

Returns

Type	Description
ByteString	The bytes for name.

getOwner()

public abstract 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.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Owner	The owner.

getOwnerOrBuilder()

public abstract 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.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
OwnerOrBuilder

getRetentionExpireTime()

public abstract Timestamp getRetentionExpireTime()

A server-determined value that specifies the earliest time that the object's retention period expires. This value is in https://tools.ietf.org/html/rfc3339 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).

.google.protobuf.Timestamp retention_expire_time = 21;

Returns

Type	Description
Timestamp	The retentionExpireTime.

getRetentionExpireTimeOrBuilder()

public abstract TimestampOrBuilder getRetentionExpireTimeOrBuilder()

.google.protobuf.Timestamp retention_expire_time = 21;

Returns

Type	Description
TimestampOrBuilder

getSize()

public abstract long getSize()

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];

Returns

Type	Description
long	The size.

getStorageClass()

public abstract String getStorageClass()

Storage class of the object.

string storage_class = 5;

Returns

Type	Description
String	The storageClass.

getStorageClassBytes()

public abstract ByteString getStorageClassBytes()

Storage class of the object.

string storage_class = 5;

Returns

Type	Description
ByteString	The bytes for storageClass.

getTemporaryHold()

public abstract 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;

Returns

Type	Description
boolean	The temporaryHold.

getUpdateStorageClassTime()

public abstract 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.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The updateStorageClassTime.

getUpdateStorageClassTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateStorageClassTimeOrBuilder()

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

Returns

Type	Description
TimestampOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

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];

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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];

Returns

Type	Description
TimestampOrBuilder

hasChecksums()

public abstract boolean hasChecksums()

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

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

Returns

Type	Description
boolean	Whether the checksums field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

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];

Returns

Type	Description
boolean	Whether the createTime field is set.

hasCustomTime()

public abstract boolean hasCustomTime()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns

Type	Description
boolean	Whether the customTime field is set.

hasCustomerEncryption()

public abstract boolean hasCustomerEncryption()

Metadata of customer-supplied encryption key, if the object is encrypted by such a key.

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

Returns

Type	Description
boolean	Whether the customerEncryption field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

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];

Returns

Type	Description
boolean	Whether the deleteTime field is set.

hasEventBasedHold()

public abstract boolean hasEventBasedHold()

optional bool event_based_hold = 23;

Returns

Type	Description
boolean	Whether the eventBasedHold field is set.

hasOwner()

public abstract 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.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the owner field is set.

hasRetentionExpireTime()

public abstract boolean hasRetentionExpireTime()

.google.protobuf.Timestamp retention_expire_time = 21;

Returns

Type	Description
boolean	Whether the retentionExpireTime field is set.

hasUpdateStorageClassTime()

public abstract boolean hasUpdateStorageClassTime()

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

Returns

Type	Description
boolean	Whether the updateStorageClassTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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];

Returns

Type	Description
boolean	Whether the updateTime field is set.