Package com.google.storage.v2

Interface ObjectOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Object, Object.Builder
public interface ObjectOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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];
      Returns:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getBucket

      String getBucket()
       Immutable. The name of the bucket containing this object.
      string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bucket.

    • getBucketBytes

      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) = { ... }
      Returns:
      The bytes for bucket.

    • getEtag

      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:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       The etag of the object.
 If included in the metadata of an update or delete request message, the
 operation will only be performed if the etag matches that of the live
 object.
      string etag = 27;
      Returns:
      The bytes for etag.

    • getGeneration

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

    • getMetageneration

      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];
      Returns:
      The metageneration.

    • getStorageClass

      String getStorageClass()
       Storage class of the object.
      string storage_class = 5;
      Returns:
      The storageClass.

    • getStorageClassBytes

      com.google.protobuf.ByteString getStorageClassBytes()
       Storage class of the object.
      string storage_class = 5;
      Returns:
      The bytes for storageClass.

    • getSize

      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];
      Returns:
      The size.

    • getContentEncoding

      String getContentEncoding()
       Content-Encoding of the object data, matching
 [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
      string content_encoding = 7;
      Returns:
      The contentEncoding.

    • getContentEncodingBytes

      com.google.protobuf.ByteString getContentEncodingBytes()
       Content-Encoding of the object data, matching
 [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
      string content_encoding = 7;
      Returns:
      The bytes for contentEncoding.

    • getContentDisposition

      String getContentDisposition()
       Content-Disposition of the object data, matching
 [https://tools.ietf.org/html/rfc6266][RFC 6266].
      string content_disposition = 8;
      Returns:
      The contentDisposition.

    • getContentDispositionBytes

      com.google.protobuf.ByteString getContentDispositionBytes()
       Content-Disposition of the object data, matching
 [https://tools.ietf.org/html/rfc6266][RFC 6266].
      string content_disposition = 8;
      Returns:
      The bytes for contentDisposition.

    • getCacheControl

      String getCacheControl()
       Cache-Control directive for the object data, matching
 [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
 If omitted, and the object is accessible to all anonymous users, the
 default will be `public, max-age=3600`.
      string cache_control = 9;
      Returns:
      The cacheControl.

    • getCacheControlBytes

      com.google.protobuf.ByteString getCacheControlBytes()
       Cache-Control directive for the object data, matching
 [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
 If omitted, and the object is accessible to all anonymous users, the
 default will be `public, max-age=3600`.
      string cache_control = 9;
      Returns:
      The bytes for cacheControl.

    • getAclList

      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;

    • getAcl

      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;

    • getAclCount

      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;

    • getAclOrBuilderList

      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;

    • getAclOrBuilder

      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;

    • getContentLanguage

      String getContentLanguage()
       Content-Language of the object data, matching
 [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
      string content_language = 11;
      Returns:
      The contentLanguage.

    • getContentLanguageBytes

      com.google.protobuf.ByteString getContentLanguageBytes()
       Content-Language of the object data, matching
 [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
      string content_language = 11;
      Returns:
      The bytes for contentLanguage.

    • hasDeleteTime

      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];
      Returns:
      Whether the deleteTime field is set.

    • getDeleteTime

      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];
      Returns:
      The deleteTime.

    • getDeleteTimeOrBuilder

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

    • getContentType

      String getContentType()
       Content-Type of the object data, matching
 [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
 If an object is stored without a Content-Type, it is served as
 `application/octet-stream`.
      string content_type = 13;
      Returns:
      The contentType.

    • getContentTypeBytes

      com.google.protobuf.ByteString getContentTypeBytes()
       Content-Type of the object data, matching
 [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
 If an object is stored without a Content-Type, it is served as
 `application/octet-stream`.
      string content_type = 13;
      Returns:
      The bytes for contentType.

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

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

    • getComponentCount

      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];
      Returns:
      The componentCount.

    • hasChecksums

      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:
      Whether the checksums field is set.

    • getChecksums

      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:
      The checksums.

    • getChecksumsOrBuilder

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

    • hasUpdateTime

      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];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

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

    • getKmsKey

      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:
      The kmsKey.

    • getKmsKeyBytes

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

    • hasUpdateStorageClassTime

      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];
      Returns:
      Whether the updateStorageClassTime field is set.

    • getUpdateStorageClassTime

      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];
      Returns:
      The updateStorageClassTime.

    • getUpdateStorageClassTimeOrBuilder

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

    • getTemporaryHold

      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:
      The temporaryHold.

    • hasRetentionExpireTime

      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:
      Whether the retentionExpireTime field is set.

    • getRetentionExpireTime

      com.google.protobuf.Timestamp getRetentionExpireTime()
       A server-determined value that specifies the earliest time that the
 object's retention period expires.
 Note 1: This field is not provided for objects with an active event-based
 hold, since retention expiration is unknown until the hold is removed.
 Note 2: This value can be provided even when temporary hold is set (so that
 the user can reason about policy without having to first unset the
 temporary hold).
      .google.protobuf.Timestamp retention_expire_time = 21;
      Returns:
      The retentionExpireTime.

    • getRetentionExpireTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getRetentionExpireTimeOrBuilder()
       A server-determined value that specifies the earliest time that the
 object's retention period expires.
 Note 1: This field is not provided for objects with an active event-based
 hold, since retention expiration is unknown until the hold is removed.
 Note 2: This value can be provided even when temporary hold is set (so that
 the user can reason about policy without having to first unset the
 temporary hold).
      .google.protobuf.Timestamp retention_expire_time = 21;

    • getMetadataCount

      int getMetadataCount()
       User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22;

    • containsMetadata

      boolean containsMetadata(String key)
       User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22;

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      Map<String,String> getMetadataMap()
       User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22;

    • getMetadataOrDefault

      String getMetadataOrDefault(String key, String defaultValue)
       User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22;

    • getMetadataOrThrow

      String getMetadataOrThrow(String key)
       User-provided metadata, in key/value pairs.
      map<string, string> metadata = 22;

    • hasEventBasedHold

      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:
      Whether the eventBasedHold field is set.

    • getEventBasedHold

      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:
      The eventBasedHold.

    • hasOwner

      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];
      Returns:
      Whether the owner field is set.

    • getOwner

      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];
      Returns:
      The owner.

    • getOwnerOrBuilder

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

    • hasCustomerEncryption

      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:
      Whether the customerEncryption field is set.

    • getCustomerEncryption

      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:
      The customerEncryption.

    • getCustomerEncryptionOrBuilder

      CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder()
       Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
 such a key.
      .google.storage.v2.CustomerEncryption customer_encryption = 25;

    • hasCustomTime

      boolean hasCustomTime()
       A user-specified timestamp set on an object.
      .google.protobuf.Timestamp custom_time = 26;
      Returns:
      Whether the customTime field is set.

    • getCustomTime

      com.google.protobuf.Timestamp getCustomTime()
       A user-specified timestamp set on an object.
      .google.protobuf.Timestamp custom_time = 26;
      Returns:
      The customTime.

    • getCustomTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCustomTimeOrBuilder()
       A user-specified timestamp set on an object.
      .google.protobuf.Timestamp custom_time = 26;

    • hasSoftDeleteTime

      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];
      Returns:
      Whether the softDeleteTime field is set.

    • getSoftDeleteTime

      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];
      Returns:
      The softDeleteTime.

    • getSoftDeleteTimeOrBuilder

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

    • hasHardDeleteTime

      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];
      Returns:
      Whether the hardDeleteTime field is set.

    • getHardDeleteTime

      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];
      Returns:
      The hardDeleteTime.

    • getHardDeleteTimeOrBuilder

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