Package com.google.storage.v2

Class Object

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.Object
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ObjectOrBuilder, Serializable
public final class Object extends com.google.protobuf.GeneratedMessageV3 implements ObjectOrBuilder
 An object.
Protobuf type google.storage.v2.Object
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • BUCKET_FIELD_NUMBER

      public static final int BUCKET_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • GENERATION_FIELD_NUMBER

      public static final int GENERATION_FIELD_NUMBER
      See Also:

    • RESTORE_TOKEN_FIELD_NUMBER

      public static final int RESTORE_TOKEN_FIELD_NUMBER
      See Also:

    • METAGENERATION_FIELD_NUMBER

      public static final int METAGENERATION_FIELD_NUMBER
      See Also:

    • STORAGE_CLASS_FIELD_NUMBER

      public static final int STORAGE_CLASS_FIELD_NUMBER
      See Also:

    • SIZE_FIELD_NUMBER

      public static final int SIZE_FIELD_NUMBER
      See Also:

    • CONTENT_ENCODING_FIELD_NUMBER

      public static final int CONTENT_ENCODING_FIELD_NUMBER
      See Also:

    • CONTENT_DISPOSITION_FIELD_NUMBER

      public static final int CONTENT_DISPOSITION_FIELD_NUMBER
      See Also:

    • CACHE_CONTROL_FIELD_NUMBER

      public static final int CACHE_CONTROL_FIELD_NUMBER
      See Also:

    • ACL_FIELD_NUMBER

      public static final int ACL_FIELD_NUMBER
      See Also:

    • CONTENT_LANGUAGE_FIELD_NUMBER

      public static final int CONTENT_LANGUAGE_FIELD_NUMBER
      See Also:

    • DELETE_TIME_FIELD_NUMBER

      public static final int DELETE_TIME_FIELD_NUMBER
      See Also:

    • FINALIZE_TIME_FIELD_NUMBER

      public static final int FINALIZE_TIME_FIELD_NUMBER
      See Also:

    • CONTENT_TYPE_FIELD_NUMBER

      public static final int CONTENT_TYPE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • COMPONENT_COUNT_FIELD_NUMBER

      public static final int COMPONENT_COUNT_FIELD_NUMBER
      See Also:

    • CHECKSUMS_FIELD_NUMBER

      public static final int CHECKSUMS_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • KMS_KEY_FIELD_NUMBER

      public static final int KMS_KEY_FIELD_NUMBER
      See Also:

    • UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER

      public static final int UPDATE_STORAGE_CLASS_TIME_FIELD_NUMBER
      See Also:

    • TEMPORARY_HOLD_FIELD_NUMBER

      public static final int TEMPORARY_HOLD_FIELD_NUMBER
      See Also:

    • RETENTION_EXPIRE_TIME_FIELD_NUMBER

      public static final int RETENTION_EXPIRE_TIME_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • EVENT_BASED_HOLD_FIELD_NUMBER

      public static final int EVENT_BASED_HOLD_FIELD_NUMBER
      See Also:

    • OWNER_FIELD_NUMBER

      public static final int OWNER_FIELD_NUMBER
      See Also:

    • CUSTOMER_ENCRYPTION_FIELD_NUMBER

      public static final int CUSTOMER_ENCRYPTION_FIELD_NUMBER
      See Also:

    • CUSTOM_TIME_FIELD_NUMBER

      public static final int CUSTOM_TIME_FIELD_NUMBER
      See Also:

    • SOFT_DELETE_TIME_FIELD_NUMBER

      public static final int SOFT_DELETE_TIME_FIELD_NUMBER
      See Also:

    • HARD_DELETE_TIME_FIELD_NUMBER

      public static final int HARD_DELETE_TIME_FIELD_NUMBER
      See Also:

    • RETENTION_FIELD_NUMBER

      public static final int RETENTION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getName

      public 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];
      Specified by:
      getName in interface ObjectOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface ObjectOrBuilder
      Returns:
      The bytes for name.

    • 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) = { ... }
      Specified by:
      getBucket in interface ObjectOrBuilder
      Returns:
      The bucket.

    • getBucketBytes

      public 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) = { ... }
      Specified by:
      getBucketBytes in interface ObjectOrBuilder
      Returns:
      The bytes for bucket.

    • getEtag

      public String getEtag()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface ObjectOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface ObjectOrBuilder
      Returns:
      The bytes for etag.

    • getGeneration

      public long getGeneration()
       Immutable. The content generation of this object. Used for object
 versioning.
      int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getGeneration in interface ObjectOrBuilder
      Returns:
      The generation.

    • hasRestoreToken

      public boolean hasRestoreToken()
       Output only. Restore token used to differentiate deleted objects with the
 same name and generation. This field is output only, and only set for
 deleted objects in HNS buckets.
      optional string restore_token = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRestoreToken in interface ObjectOrBuilder
      Returns:
      Whether the restoreToken field is set.

    • getRestoreToken

      public String getRestoreToken()
       Output only. Restore token used to differentiate deleted objects with the
 same name and generation. This field is output only, and only set for
 deleted objects in HNS buckets.
      optional string restore_token = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRestoreToken in interface ObjectOrBuilder
      Returns:
      The restoreToken.

    • getRestoreTokenBytes

      public com.google.protobuf.ByteString getRestoreTokenBytes()
       Output only. Restore token used to differentiate deleted objects with the
 same name and generation. This field is output only, and only set for
 deleted objects in HNS buckets.
      optional string restore_token = 35 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRestoreTokenBytes in interface ObjectOrBuilder
      Returns:
      The bytes for restoreToken.

    • 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.
      int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetageneration in interface ObjectOrBuilder
      Returns:
      The metageneration.

    • getStorageClass

      public String getStorageClass()
       Optional. Storage class of the object.
      string storage_class = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageClass in interface ObjectOrBuilder
      Returns:
      The storageClass.

    • getStorageClassBytes

      public com.google.protobuf.ByteString getStorageClassBytes()
       Optional. Storage class of the object.
      string storage_class = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageClassBytes in interface ObjectOrBuilder
      Returns:
      The bytes for storageClass.

    • 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][RFC 7230 ยง3.3.2].
      int64 size = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSize in interface ObjectOrBuilder
      Returns:
      The size.

    • getContentEncoding

      public String getContentEncoding()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentEncoding in interface ObjectOrBuilder
      Returns:
      The contentEncoding.

    • getContentEncodingBytes

      public com.google.protobuf.ByteString getContentEncodingBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentEncodingBytes in interface ObjectOrBuilder
      Returns:
      The bytes for contentEncoding.

    • getContentDisposition

      public String getContentDisposition()
       Optional. Content-Disposition of the object data, matching
 [https://tools.ietf.org/html/rfc6266][RFC 6266].
      string content_disposition = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentDisposition in interface ObjectOrBuilder
      Returns:
      The contentDisposition.

    • getContentDispositionBytes

      public com.google.protobuf.ByteString getContentDispositionBytes()
       Optional. Content-Disposition of the object data, matching
 [https://tools.ietf.org/html/rfc6266][RFC 6266].
      string content_disposition = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentDispositionBytes in interface ObjectOrBuilder
      Returns:
      The bytes for contentDisposition.

    • getCacheControl

      public String getCacheControl()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCacheControl in interface ObjectOrBuilder
      Returns:
      The cacheControl.

    • getCacheControlBytes

      public com.google.protobuf.ByteString getCacheControlBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCacheControlBytes in interface ObjectOrBuilder
      Returns:
      The bytes for cacheControl.

    • getAclList

      public List<ObjectAccessControl> getAclList()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclList in interface ObjectOrBuilder

    • getAclOrBuilderList

      public List<? extends ObjectAccessControlOrBuilder> getAclOrBuilderList()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclOrBuilderList in interface ObjectOrBuilder

    • getAclCount

      public int getAclCount()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclCount in interface ObjectOrBuilder

    • getAcl

      public ObjectAccessControl getAcl(int index)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAcl in interface ObjectOrBuilder

    • getAclOrBuilder

      public ObjectAccessControlOrBuilder getAclOrBuilder(int index)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclOrBuilder in interface ObjectOrBuilder

    • getContentLanguage

      public String getContentLanguage()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentLanguage in interface ObjectOrBuilder
      Returns:
      The contentLanguage.

    • getContentLanguageBytes

      public com.google.protobuf.ByteString getContentLanguageBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentLanguageBytes in interface ObjectOrBuilder
      Returns:
      The bytes for contentLanguage.

    • hasDeleteTime

      public boolean hasDeleteTime()
       Output only. If this object is noncurrent, this is the time when the object
 became noncurrent.
      .google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDeleteTime in interface ObjectOrBuilder
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      public com.google.protobuf.Timestamp getDeleteTime()
       Output only. If this object is noncurrent, this is the time when the object
 became noncurrent.
      .google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeleteTime in interface ObjectOrBuilder
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
       Output only. If this object is noncurrent, this is the time when the object
 became noncurrent.
      .google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDeleteTimeOrBuilder in interface ObjectOrBuilder

    • hasFinalizeTime

      public boolean hasFinalizeTime()
       Output only. The time when the object was finalized.
      .google.protobuf.Timestamp finalize_time = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFinalizeTime in interface ObjectOrBuilder
      Returns:
      Whether the finalizeTime field is set.

    • getFinalizeTime

      public com.google.protobuf.Timestamp getFinalizeTime()
       Output only. The time when the object was finalized.
      .google.protobuf.Timestamp finalize_time = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFinalizeTime in interface ObjectOrBuilder
      Returns:
      The finalizeTime.

    • getFinalizeTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getFinalizeTimeOrBuilder()
       Output only. The time when the object was finalized.
      .google.protobuf.Timestamp finalize_time = 36 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFinalizeTimeOrBuilder in interface ObjectOrBuilder

    • getContentType

      public String getContentType()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentType in interface ObjectOrBuilder
      Returns:
      The contentType.

    • getContentTypeBytes

      public com.google.protobuf.ByteString getContentTypeBytes()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContentTypeBytes in interface ObjectOrBuilder
      Returns:
      The bytes for contentType.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The creation time of the object.
      .google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ObjectOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The creation time of the object.
      .google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ObjectOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The creation time of the object.
      .google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ObjectOrBuilder

    • getComponentCount

      public int getComponentCount()
       Output only. Number of underlying components that make up this object.
 Components are accumulated by compose operations.
      int32 component_count = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getComponentCount in interface ObjectOrBuilder
      Returns:
      The componentCount.

    • 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. The
 checksums of the complete object regardless of data range. If the object is
 downloaded in full, the client should compute one of these checksums over
 the downloaded object and compare it against the value provided here.
      .google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasChecksums in interface ObjectOrBuilder
      Returns:
      Whether the checksums field is set.

    • 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. The
 checksums of the complete object regardless of data range. If the object is
 downloaded in full, the client should compute one of these checksums over
 the downloaded object and compare it against the value provided here.
      .google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getChecksums in interface ObjectOrBuilder
      Returns:
      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. The
 checksums of the complete object regardless of data range. If the object is
 downloaded in full, the client should compute one of these checksums over
 the downloaded object and compare it against the value provided here.
      .google.storage.v2.ObjectChecksums checksums = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getChecksumsOrBuilder in interface ObjectOrBuilder

    • 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.
      .google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface ObjectOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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.
      .google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ObjectOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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.
      .google.protobuf.Timestamp update_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ObjectOrBuilder

    • getKmsKey

      public String getKmsKey()
       Optional. Cloud KMS Key used to encrypt this object, if the object is
 encrypted by such a key.
      string kms_key = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKey in interface ObjectOrBuilder
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      public com.google.protobuf.ByteString getKmsKeyBytes()
       Optional. Cloud KMS Key used to encrypt this object, if the object is
 encrypted by such a key.
      string kms_key = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyBytes in interface ObjectOrBuilder
      Returns:
      The bytes for kmsKey.

    • 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.
      .google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateStorageClassTime in interface ObjectOrBuilder
      Returns:
      Whether the updateStorageClassTime field is set.

    • getUpdateStorageClassTime

      public 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.
      .google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateStorageClassTime in interface ObjectOrBuilder
      Returns:
      The updateStorageClassTime.

    • getUpdateStorageClassTimeOrBuilder

      public 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.
      .google.protobuf.Timestamp update_storage_class_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateStorageClassTimeOrBuilder in interface ObjectOrBuilder

    • getTemporaryHold

      public boolean getTemporaryHold()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTemporaryHold in interface ObjectOrBuilder
      Returns:
      The temporaryHold.

    • hasRetentionExpireTime

      public boolean hasRetentionExpireTime()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRetentionExpireTime in interface ObjectOrBuilder
      Returns:
      Whether the retentionExpireTime field is set.

    • getRetentionExpireTime

      public com.google.protobuf.Timestamp getRetentionExpireTime()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionExpireTime in interface ObjectOrBuilder
      Returns:
      The retentionExpireTime.

    • getRetentionExpireTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getRetentionExpireTimeOrBuilder()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionExpireTimeOrBuilder in interface ObjectOrBuilder

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: ObjectOrBuilder
       Optional. User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataCount in interface ObjectOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Optional. User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsMetadata in interface ObjectOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface ObjectOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
       Optional. User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataMap in interface ObjectOrBuilder

    • getMetadataOrDefault

      public String getMetadataOrDefault(String key, String defaultValue)
       Optional. User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataOrDefault in interface ObjectOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
       Optional. User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataOrThrow in interface ObjectOrBuilder

    • 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;
      Specified by:
      hasEventBasedHold in interface ObjectOrBuilder
      Returns:
      Whether the eventBasedHold field is set.

    • 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;
      Specified by:
      getEventBasedHold in interface ObjectOrBuilder
      Returns:
      The eventBasedHold.

    • hasOwner

      public boolean hasOwner()
       Output only. The owner of the object. This will always be the uploader of
 the object.
      .google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasOwner in interface ObjectOrBuilder
      Returns:
      Whether the owner field is set.

    • getOwner

      public Owner getOwner()
       Output only. The owner of the object. This will always be the uploader of
 the object.
      .google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOwner in interface ObjectOrBuilder
      Returns:
      The owner.

    • getOwnerOrBuilder

      public OwnerOrBuilder getOwnerOrBuilder()
       Output only. The owner of the object. This will always be the uploader of
 the object.
      .google.storage.v2.Owner owner = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOwnerOrBuilder in interface ObjectOrBuilder

    • hasCustomerEncryption

      public boolean hasCustomerEncryption()
       Optional. Metadata of Customer-Supplied Encryption Key, if the object is
 encrypted by such a key.
      .google.storage.v2.CustomerEncryption customer_encryption = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomerEncryption in interface ObjectOrBuilder
      Returns:
      Whether the customerEncryption field is set.

    • getCustomerEncryption

      public CustomerEncryption getCustomerEncryption()
       Optional. Metadata of Customer-Supplied Encryption Key, if the object is
 encrypted by such a key.
      .google.storage.v2.CustomerEncryption customer_encryption = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomerEncryption in interface ObjectOrBuilder
      Returns:
      The customerEncryption.

    • getCustomerEncryptionOrBuilder

      public CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()
       Optional. Metadata of Customer-Supplied Encryption Key, if the object is
 encrypted by such a key.
      .google.storage.v2.CustomerEncryption customer_encryption = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomerEncryptionOrBuilder in interface ObjectOrBuilder

    • hasCustomTime

      public boolean hasCustomTime()
       Optional. A user-specified timestamp set on an object.
      .google.protobuf.Timestamp custom_time = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomTime in interface ObjectOrBuilder
      Returns:
      Whether the customTime field is set.

    • getCustomTime

      public com.google.protobuf.Timestamp getCustomTime()
       Optional. A user-specified timestamp set on an object.
      .google.protobuf.Timestamp custom_time = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomTime in interface ObjectOrBuilder
      Returns:
      The customTime.

    • getCustomTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCustomTimeOrBuilder()
       Optional. A user-specified timestamp set on an object.
      .google.protobuf.Timestamp custom_time = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomTimeOrBuilder in interface ObjectOrBuilder

    • hasSoftDeleteTime

      public boolean hasSoftDeleteTime()
       Output only. This is the time when the object became soft-deleted.

 Soft-deleted objects are only accessible if a soft_delete_policy is
 enabled. Also see hard_delete_time.
      optional .google.protobuf.Timestamp soft_delete_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSoftDeleteTime in interface ObjectOrBuilder
      Returns:
      Whether the softDeleteTime field is set.

    • getSoftDeleteTime

      public com.google.protobuf.Timestamp getSoftDeleteTime()
       Output only. This is the time when the object became soft-deleted.

 Soft-deleted objects are only accessible if a soft_delete_policy is
 enabled. Also see hard_delete_time.
      optional .google.protobuf.Timestamp soft_delete_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSoftDeleteTime in interface ObjectOrBuilder
      Returns:
      The softDeleteTime.

    • getSoftDeleteTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getSoftDeleteTimeOrBuilder()
       Output only. This is the time when the object became soft-deleted.

 Soft-deleted objects are only accessible if a soft_delete_policy is
 enabled. Also see hard_delete_time.
      optional .google.protobuf.Timestamp soft_delete_time = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSoftDeleteTimeOrBuilder in interface ObjectOrBuilder

    • hasHardDeleteTime

      public boolean hasHardDeleteTime()
       Output only. The time when the object will be permanently deleted.

 Only set when an object becomes soft-deleted with a soft_delete_policy.
 Otherwise, the object will not be accessible.
      optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasHardDeleteTime in interface ObjectOrBuilder
      Returns:
      Whether the hardDeleteTime field is set.

    • getHardDeleteTime

      public com.google.protobuf.Timestamp getHardDeleteTime()
       Output only. The time when the object will be permanently deleted.

 Only set when an object becomes soft-deleted with a soft_delete_policy.
 Otherwise, the object will not be accessible.
      optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getHardDeleteTime in interface ObjectOrBuilder
      Returns:
      The hardDeleteTime.

    • getHardDeleteTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getHardDeleteTimeOrBuilder()
       Output only. The time when the object will be permanently deleted.

 Only set when an object becomes soft-deleted with a soft_delete_policy.
 Otherwise, the object will not be accessible.
      optional .google.protobuf.Timestamp hard_delete_time = 29 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getHardDeleteTimeOrBuilder in interface ObjectOrBuilder

    • hasRetention

      public boolean hasRetention()
       Optional. Retention configuration of this object.
 May only be configured if the bucket has object retention enabled.
      .google.storage.v2.Object.Retention retention = 30 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRetention in interface ObjectOrBuilder
      Returns:
      Whether the retention field is set.

    • getRetention

      public Object.Retention getRetention()
       Optional. Retention configuration of this object.
 May only be configured if the bucket has object retention enabled.
      .google.storage.v2.Object.Retention retention = 30 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetention in interface ObjectOrBuilder
      Returns:
      The retention.

    • getRetentionOrBuilder

      public Object.RetentionOrBuilder getRetentionOrBuilder()
       Optional. Retention configuration of this object.
 May only be configured if the bucket has object retention enabled.
      .google.storage.v2.Object.Retention retention = 30 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionOrBuilder in interface ObjectOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Object parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Object parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Object parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Object parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Object parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Object parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Object parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Object parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Object parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Object parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Object parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Object parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Object.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Object.Builder newBuilder()

    • newBuilder

      public static Object.Builder newBuilder(Object prototype)

    • toBuilder

      public Object.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Object.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Object getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Object> parser()

    • getParserForType

      public com.google.protobuf.Parser<Object> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Object getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder