All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.storage.v2.ObjectOrBuilder Maven / Gradle / Ivy

There is a newer version: 2.47.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/storage/v2/storage.proto

// Protobuf Java Version: 3.25.2
package com.google.storage.v2;

public interface ObjectOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.storage.v2.Object)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * 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]; * * @return The name. */ java.lang.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]; * * @return The bytes for name. */ com.google.protobuf.ByteString getNameBytes(); /** * * *
   * Immutable. The name of the bucket containing this object.
   * 
* * * string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... } * * * @return The bucket. */ java.lang.String getBucket(); /** * * *
   * Immutable. The name of the bucket containing this object.
   * 
* * * string bucket = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... } * * * @return The bytes for bucket. */ com.google.protobuf.ByteString getBucketBytes(); /** * * *
   * 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; * * @return The etag. */ java.lang.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; * * @return The bytes for etag. */ com.google.protobuf.ByteString getEtagBytes(); /** * * *
   * Immutable. The content generation of this object. Used for object
   * versioning.
   * 
* * int64 generation = 3 [(.google.api.field_behavior) = IMMUTABLE]; * * @return The generation. */ long getGeneration(); /** * * *
   * 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]; * * @return The metageneration. */ long getMetageneration(); /** * * *
   * Storage class of the object.
   * 
* * string storage_class = 5; * * @return The storageClass. */ java.lang.String getStorageClass(); /** * * *
   * Storage class of the object.
   * 
* * string storage_class = 5; * * @return The bytes for storageClass. */ com.google.protobuf.ByteString getStorageClassBytes(); /** * * *
   * 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]; * * @return The size. */ long getSize(); /** * * *
   * 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; * * @return The contentEncoding. */ java.lang.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; * * @return The bytes for contentEncoding. */ com.google.protobuf.ByteString getContentEncodingBytes(); /** * * *
   * Content-Disposition of the object data, matching
   * [https://tools.ietf.org/html/rfc6266][RFC 6266].
   * 
* * string content_disposition = 8; * * @return The contentDisposition. */ java.lang.String getContentDisposition(); /** * * *
   * Content-Disposition of the object data, matching
   * [https://tools.ietf.org/html/rfc6266][RFC 6266].
   * 
* * string content_disposition = 8; * * @return The bytes for contentDisposition. */ com.google.protobuf.ByteString getContentDispositionBytes(); /** * * *
   * 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; * * @return The cacheControl. */ java.lang.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; * * @return The bytes for cacheControl. */ com.google.protobuf.ByteString getCacheControlBytes(); /** * * *
   * 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; */ java.util.List 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; */ com.google.storage.v2.ObjectAccessControl getAcl(int index); /** * * *
   * Access controls on the object.
   * If iam_config.uniform_bucket_level_access is enabled on the parent
   * bucket, requests to set, read, or modify acl is an error.
   * 
* * repeated .google.storage.v2.ObjectAccessControl acl = 10; */ int getAclCount(); /** * * *
   * Access controls on the object.
   * If iam_config.uniform_bucket_level_access is enabled on the parent
   * bucket, requests to set, read, or modify acl is an error.
   * 
* * repeated .google.storage.v2.ObjectAccessControl acl = 10; */ java.util.List 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; */ com.google.storage.v2.ObjectAccessControlOrBuilder getAclOrBuilder(int index); /** * * *
   * 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; * * @return The contentLanguage. */ java.lang.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; * * @return The bytes for contentLanguage. */ com.google.protobuf.ByteString getContentLanguageBytes(); /** * * *
   * 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]; * * * @return Whether the deleteTime field is set. */ 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]; * * * @return The deleteTime. */ 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]; * */ com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder(); /** * * *
   * 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; * * @return The contentType. */ java.lang.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; * * @return The bytes for contentType. */ com.google.protobuf.ByteString getContentTypeBytes(); /** * * *
   * Output only. The creation time of the object.
   * 
* * .google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * * @return Whether the createTime field is set. */ boolean hasCreateTime(); /** * * *
   * Output only. The creation time of the object.
   * 
* * .google.protobuf.Timestamp create_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY]; * * * @return The createTime. */ 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]; * */ com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); /** * * *
   * 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]; * * @return The componentCount. */ int getComponentCount(); /** * * *
   * 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]; * * * @return Whether the checksums field is set. */ 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]; * * * @return The checksums. */ com.google.storage.v2.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]; * */ com.google.storage.v2.ObjectChecksumsOrBuilder getChecksumsOrBuilder(); /** * * *
   * 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]; * * * @return Whether the updateTime field is set. */ 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]; * * * @return The updateTime. */ 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]; * */ com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); /** * * *
   * 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) = { ... } * * @return The kmsKey. */ java.lang.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) = { ... } * * @return The bytes for kmsKey. */ com.google.protobuf.ByteString getKmsKeyBytes(); /** * * *
   * 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]; * * * @return Whether the updateStorageClassTime field is set. */ 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]; * * * @return The updateStorageClassTime. */ 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]; * */ com.google.protobuf.TimestampOrBuilder getUpdateStorageClassTimeOrBuilder(); /** * * *
   * 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; * * @return The temporaryHold. */ boolean getTemporaryHold(); /** * * *
   * 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; * * @return Whether the retentionExpireTime field is set. */ 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; * * @return The retentionExpireTime. */ com.google.protobuf.Timestamp getRetentionExpireTime(); /** * * *
   * A server-determined value that specifies the earliest time that the
   * object's retention period expires.
   * Note 1: This field is not provided for objects with an active event-based
   * hold, since retention expiration is unknown until the hold is removed.
   * Note 2: This value can be provided even when temporary hold is set (so that
   * the user can reason about policy without having to first unset the
   * temporary hold).
   * 
* * .google.protobuf.Timestamp retention_expire_time = 21; */ com.google.protobuf.TimestampOrBuilder getRetentionExpireTimeOrBuilder(); /** * * *
   * User-provided metadata, in key/value pairs.
   * 
* * map<string, string> metadata = 22; */ int getMetadataCount(); /** * * *
   * User-provided metadata, in key/value pairs.
   * 
* * map<string, string> metadata = 22; */ boolean containsMetadata(java.lang.String key); /** Use {@link #getMetadataMap()} instead. */ @java.lang.Deprecated java.util.Map getMetadata(); /** * * *
   * User-provided metadata, in key/value pairs.
   * 
* * map<string, string> metadata = 22; */ java.util.Map getMetadataMap(); /** * * *
   * User-provided metadata, in key/value pairs.
   * 
* * map<string, string> metadata = 22; */ /* nullable */ java.lang.String getMetadataOrDefault( java.lang.String key, /* nullable */ java.lang.String defaultValue); /** * * *
   * User-provided metadata, in key/value pairs.
   * 
* * map<string, string> metadata = 22; */ java.lang.String getMetadataOrThrow(java.lang.String key); /** * * *
   * 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; * * @return Whether the eventBasedHold field is set. */ 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; * * @return The eventBasedHold. */ boolean getEventBasedHold(); /** * * *
   * 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]; * * @return Whether the owner field is set. */ 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]; * * @return The owner. */ com.google.storage.v2.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]; */ com.google.storage.v2.OwnerOrBuilder getOwnerOrBuilder(); /** * * *
   * Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
   * such a key.
   * 
* * .google.storage.v2.CustomerEncryption customer_encryption = 25; * * @return Whether the customerEncryption field is set. */ boolean hasCustomerEncryption(); /** * * *
   * Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
   * such a key.
   * 
* * .google.storage.v2.CustomerEncryption customer_encryption = 25; * * @return The customerEncryption. */ com.google.storage.v2.CustomerEncryption getCustomerEncryption(); /** * * *
   * Metadata of Customer-Supplied Encryption Key, if the object is encrypted by
   * such a key.
   * 
* * .google.storage.v2.CustomerEncryption customer_encryption = 25; */ com.google.storage.v2.CustomerEncryptionOrBuilder getCustomerEncryptionOrBuilder(); /** * * *
   * A user-specified timestamp set on an object.
   * 
* * .google.protobuf.Timestamp custom_time = 26; * * @return Whether the customTime field is set. */ boolean hasCustomTime(); /** * * *
   * A user-specified timestamp set on an object.
   * 
* * .google.protobuf.Timestamp custom_time = 26; * * @return The customTime. */ com.google.protobuf.Timestamp getCustomTime(); /** * * *
   * A user-specified timestamp set on an object.
   * 
* * .google.protobuf.Timestamp custom_time = 26; */ com.google.protobuf.TimestampOrBuilder getCustomTimeOrBuilder(); /** * * *
   * 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]; * * * @return Whether the softDeleteTime field is set. */ 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]; * * * @return The softDeleteTime. */ 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]; * */ com.google.protobuf.TimestampOrBuilder getSoftDeleteTimeOrBuilder(); /** * * *
   * 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]; * * * @return Whether the hardDeleteTime field is set. */ 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]; * * * @return The hardDeleteTime. */ 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]; * */ com.google.protobuf.TimestampOrBuilder getHardDeleteTimeOrBuilder(); }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy