Class Object (2.20.1)

public final class Object extends GeneratedMessageV3 implements ObjectOrBuilder

An object.

Protobuf type google.storage.v2.Object

Implements

ObjectOrBuilder

Static Fields

ACL_FIELD_NUMBER

public static final int ACL_FIELD_NUMBER
Field Value
TypeDescription
int

BUCKET_FIELD_NUMBER

public static final int BUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

CACHE_CONTROL_FIELD_NUMBER

public static final int CACHE_CONTROL_FIELD_NUMBER
Field Value
TypeDescription
int

CHECKSUMS_FIELD_NUMBER

public static final int CHECKSUMS_FIELD_NUMBER
Field Value
TypeDescription
int

COMPONENT_COUNT_FIELD_NUMBER

public static final int COMPONENT_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

CONTENT_DISPOSITION_FIELD_NUMBER

public static final int CONTENT_DISPOSITION_FIELD_NUMBER
Field Value
TypeDescription
int

CONTENT_ENCODING_FIELD_NUMBER

public static final int CONTENT_ENCODING_FIELD_NUMBER
Field Value
TypeDescription
int

CONTENT_LANGUAGE_FIELD_NUMBER

public static final int CONTENT_LANGUAGE_FIELD_NUMBER
Field Value
TypeDescription
int

CONTENT_TYPE_FIELD_NUMBER

public static final int CONTENT_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOMER_ENCRYPTION_FIELD_NUMBER

public static final int CUSTOMER_ENCRYPTION_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_TIME_FIELD_NUMBER

public static final int CUSTOM_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_BASED_HOLD_FIELD_NUMBER

public static final int EVENT_BASED_HOLD_FIELD_NUMBER
Field Value
TypeDescription
int

GENERATION_FIELD_NUMBER

public static final int GENERATION_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

METAGENERATION_FIELD_NUMBER

public static final int METAGENERATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OWNER_FIELD_NUMBER

public static final int OWNER_FIELD_NUMBER
Field Value
TypeDescription
int

RETENTION_EXPIRE_TIME_FIELD_NUMBER

public static final int RETENTION_EXPIRE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

SIZE_FIELD_NUMBER

public static final int SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

STORAGE_CLASS_FIELD_NUMBER

public static final int STORAGE_CLASS_FIELD_NUMBER
Field Value
TypeDescription
int

TEMPORARY_HOLD_FIELD_NUMBER

public static final int TEMPORARY_HOLD_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER

public static final int UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Object getDefaultInstance()
Returns
TypeDescription
Object

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Object.Builder newBuilder()
Returns
TypeDescription
Object.Builder

newBuilder(Object prototype)

public static Object.Builder newBuilder(Object prototype)
Parameter
NameDescription
prototypeObject
Returns
TypeDescription
Object.Builder

parseDelimitedFrom(InputStream input)

public static Object parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Object
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Object parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Object
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Object parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Object
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Object
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Object parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Object
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Object
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Object parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Object
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Object
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Object parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Object
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Object
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Object parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Object
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Object parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Object
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Object> parser()
Returns
TypeDescription
Parser<Object>

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAcl(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ObjectAccessControl

getAclCount()

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

Returns
TypeDescription
int

getAclList()

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

Returns
TypeDescription
List<ObjectAccessControl>

getAclOrBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ObjectAccessControlOrBuilder

getAclOrBuilderList()

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

Returns
TypeDescription
List<? extends com.google.storage.v2.ObjectAccessControlOrBuilder>

getBucket()

public String getBucket()

Immutable. The name of the bucket containing this object.

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

Returns
TypeDescription
String

The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Immutable. The name of the bucket containing this object.

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

Returns
TypeDescription
ByteString

The bytes for bucket.

getCacheControl()

public 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
TypeDescription
String

The cacheControl.

getCacheControlBytes()

public ByteString getCacheControlBytes()

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
TypeDescription
ByteString

The bytes for cacheControl.

getChecksums()

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

Returns
TypeDescription
ObjectChecksums

The checksums.

getChecksumsOrBuilder()

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

Returns
TypeDescription
ObjectChecksumsOrBuilder

getComponentCount()

public 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
TypeDescription
int

The componentCount.

getContentDisposition()

public String getContentDisposition()

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

string content_disposition = 8;

Returns
TypeDescription
String

The contentDisposition.

getContentDispositionBytes()

public ByteString getContentDispositionBytes()

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

string content_disposition = 8;

Returns
TypeDescription
ByteString

The bytes for contentDisposition.

getContentEncoding()

public 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
TypeDescription
String

The contentEncoding.

getContentEncodingBytes()

public 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
TypeDescription
ByteString

The bytes for contentEncoding.

getContentLanguage()

public 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
TypeDescription
String

The contentLanguage.

getContentLanguageBytes()

public 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
TypeDescription
ByteString

The bytes for contentLanguage.

getContentType()

public 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
TypeDescription
String

The contentType.

getContentTypeBytes()

public 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
TypeDescription
ByteString

The bytes for contentType.

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getCustomTime()

public Timestamp getCustomTime()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns
TypeDescription
Timestamp

The customTime.

getCustomTimeOrBuilder()

public TimestampOrBuilder getCustomTimeOrBuilder()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns
TypeDescription
TimestampOrBuilder

getCustomerEncryption()

public CustomerEncryption getCustomerEncryption()

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

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

Returns
TypeDescription
CustomerEncryption

The customerEncryption.

getCustomerEncryptionOrBuilder()

public CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()

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

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

Returns
TypeDescription
CustomerEncryptionOrBuilder

getDefaultInstanceForType()

public Object getDefaultInstanceForType()
Returns
TypeDescription
Object

getDeleteTime()

public 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
TypeDescription
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getEtag()

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

Returns
TypeDescription
String

The etag.

getEtagBytes()

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

Returns
TypeDescription
ByteString

The bytes for etag.

getEventBasedHold()

public 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
TypeDescription
boolean

The eventBasedHold.

getGeneration()

public 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
TypeDescription
long

The generation.

getKmsKey()

public 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
TypeDescription
String

The kmsKey.

getKmsKeyBytes()

public 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
TypeDescription
ByteString

The bytes for kmsKey.

getMetadata()

public Map<String,String> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,String>

getMetadataCount()

public int getMetadataCount()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Returns
TypeDescription
int

getMetadataMap()

public Map<String,String> getMetadataMap()

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Returns
TypeDescription
Map<String,String>

getMetadataOrDefault(String key, String defaultValue)

public String getMetadataOrDefault(String key, String defaultValue)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getMetadataOrThrow(String key)

public String getMetadataOrThrow(String key)

User-provided metadata, in key/value pairs.

map<string, string> metadata = 22;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMetageneration()

public 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
TypeDescription
long

The metageneration.

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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
TypeDescription
ByteString

The bytes for name.

getOwner()

public 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
TypeDescription
Owner

The owner.

getOwnerOrBuilder()

public 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
TypeDescription
OwnerOrBuilder

getParserForType()

public Parser<Object> getParserForType()
Returns
TypeDescription
Parser<Object>
Overrides

getRetentionExpireTime()

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

Returns
TypeDescription
Timestamp

The retentionExpireTime.

getRetentionExpireTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSize()

public 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
TypeDescription
long

The size.

getStorageClass()

public String getStorageClass()

Storage class of the object.

string storage_class = 5;

Returns
TypeDescription
String

The storageClass.

getStorageClassBytes()

public ByteString getStorageClassBytes()

Storage class of the object.

string storage_class = 5;

Returns
TypeDescription
ByteString

The bytes for storageClass.

getTemporaryHold()

public 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
TypeDescription
boolean

The temporaryHold.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateStorageClassTime()

public 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
TypeDescription
Timestamp

The updateStorageClassTime.

getUpdateStorageClassTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

getUpdateTime()

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

hasChecksums()

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

Returns
TypeDescription
boolean

Whether the checksums field is set.

hasCreateTime()

public 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
TypeDescription
boolean

Whether the createTime field is set.

hasCustomTime()

public boolean hasCustomTime()

A user-specified timestamp set on an object.

.google.protobuf.Timestamp custom_time = 26;

Returns
TypeDescription
boolean

Whether the customTime field is set.

hasCustomerEncryption()

public boolean hasCustomerEncryption()

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

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

Returns
TypeDescription
boolean

Whether the customerEncryption field is set.

hasDeleteTime()

public 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
TypeDescription
boolean

Whether the deleteTime field is set.

hasEventBasedHold()

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

Returns
TypeDescription
boolean

Whether the eventBasedHold field is set.

hasOwner()

public 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
TypeDescription
boolean

Whether the owner field is set.

hasRetentionExpireTime()

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

Returns
TypeDescription
boolean

Whether the retentionExpireTime field is set.

hasUpdateStorageClassTime()

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

Returns
TypeDescription
boolean

Whether the updateStorageClassTime field is set.

hasUpdateTime()

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Object.Builder newBuilderForType()
Returns
TypeDescription
Object.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Object.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Object.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Object.Builder toBuilder()
Returns
TypeDescription
Object.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException