Package com.google.storage.v2

Class Bucket

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

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • BUCKET_ID_FIELD_NUMBER

      public static final int BUCKET_ID_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • PROJECT_FIELD_NUMBER

      public static final int PROJECT_FIELD_NUMBER
      See Also:

    • METAGENERATION_FIELD_NUMBER

      public static final int METAGENERATION_FIELD_NUMBER
      See Also:

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

    • LOCATION_TYPE_FIELD_NUMBER

      public static final int LOCATION_TYPE_FIELD_NUMBER
      See Also:

    • STORAGE_CLASS_FIELD_NUMBER

      public static final int STORAGE_CLASS_FIELD_NUMBER
      See Also:

    • RPO_FIELD_NUMBER

      public static final int RPO_FIELD_NUMBER
      See Also:

    • ACL_FIELD_NUMBER

      public static final int ACL_FIELD_NUMBER
      See Also:

    • DEFAULT_OBJECT_ACL_FIELD_NUMBER

      public static final int DEFAULT_OBJECT_ACL_FIELD_NUMBER
      See Also:

    • LIFECYCLE_FIELD_NUMBER

      public static final int LIFECYCLE_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • CORS_FIELD_NUMBER

      public static final int CORS_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER

      public static final int DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • WEBSITE_FIELD_NUMBER

      public static final int WEBSITE_FIELD_NUMBER
      See Also:

    • VERSIONING_FIELD_NUMBER

      public static final int VERSIONING_FIELD_NUMBER
      See Also:

    • LOGGING_FIELD_NUMBER

      public static final int LOGGING_FIELD_NUMBER
      See Also:

    • OWNER_FIELD_NUMBER

      public static final int OWNER_FIELD_NUMBER
      See Also:

    • ENCRYPTION_FIELD_NUMBER

      public static final int ENCRYPTION_FIELD_NUMBER
      See Also:

    • BILLING_FIELD_NUMBER

      public static final int BILLING_FIELD_NUMBER
      See Also:

    • RETENTION_POLICY_FIELD_NUMBER

      public static final int RETENTION_POLICY_FIELD_NUMBER
      See Also:

    • IAM_CONFIG_FIELD_NUMBER

      public static final int IAM_CONFIG_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER

      public static final int CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER
      See Also:

    • AUTOCLASS_FIELD_NUMBER

      public static final int AUTOCLASS_FIELD_NUMBER
      See Also:

    • HIERARCHICAL_NAMESPACE_FIELD_NUMBER

      public static final int HIERARCHICAL_NAMESPACE_FIELD_NUMBER
      See Also:

    • SOFT_DELETE_POLICY_FIELD_NUMBER

      public static final int SOFT_DELETE_POLICY_FIELD_NUMBER
      See Also:

    • OBJECT_RETENTION_FIELD_NUMBER

      public static final int OBJECT_RETENTION_FIELD_NUMBER
      See Also:

    • IP_FILTER_FIELD_NUMBER

      public static final int IP_FILTER_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()
       Identifier. The name of the bucket.
 Format: `projects/{project}/buckets/{bucket}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface BucketOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. The name of the bucket.
 Format: `projects/{project}/buckets/{bucket}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface BucketOrBuilder
      Returns:
      The bytes for name.

    • getBucketId

      public String getBucketId()
       Output only. The user-chosen part of the bucket name. The `{bucket}`
 portion of the `name` field. For globally unique buckets, this is equal to
 the "bucket name" of other Cloud Storage APIs. Example: "pub".
      string bucket_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBucketId in interface BucketOrBuilder
      Returns:
      The bucketId.

    • getBucketIdBytes

      public com.google.protobuf.ByteString getBucketIdBytes()
       Output only. The user-chosen part of the bucket name. The `{bucket}`
 portion of the `name` field. For globally unique buckets, this is equal to
 the "bucket name" of other Cloud Storage APIs. Example: "pub".
      string bucket_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBucketIdBytes in interface BucketOrBuilder
      Returns:
      The bytes for bucketId.

    • getEtag

      public String getEtag()
       The etag of the bucket.
 If included in the metadata of an UpdateBucketRequest, the operation will
 only be performed if the etag matches that of the bucket.
      string etag = 29;
      Specified by:
      getEtag in interface BucketOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       The etag of the bucket.
 If included in the metadata of an UpdateBucketRequest, the operation will
 only be performed if the etag matches that of the bucket.
      string etag = 29;
      Specified by:
      getEtagBytes in interface BucketOrBuilder
      Returns:
      The bytes for etag.

    • getProject

      public String getProject()
       Immutable. The project which owns this bucket, in the format of
 "projects/{projectIdentifier}".
 {projectIdentifier} can be the project ID or project number.
 Output values will always be in project number format.
      string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getProject in interface BucketOrBuilder
      Returns:
      The project.

    • getProjectBytes

      public com.google.protobuf.ByteString getProjectBytes()
       Immutable. The project which owns this bucket, in the format of
 "projects/{projectIdentifier}".
 {projectIdentifier} can be the project ID or project number.
 Output values will always be in project number format.
      string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Specified by:
      getProjectBytes in interface BucketOrBuilder
      Returns:
      The bytes for project.

    • getMetageneration

      public long getMetageneration()
       Output only. The metadata generation of this bucket.
      int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMetageneration in interface BucketOrBuilder
      Returns:
      The metageneration.

    • getLocation

      public String getLocation()
       Immutable. The location of the bucket. Object data for objects in the
 bucket resides in physical storage within this region.  Defaults to `US`.
 See the
 [https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations"][developer's
 guide] for the authoritative list. Attempting to update this field after
 the bucket is created will result in an error.
      string location = 5 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getLocation in interface BucketOrBuilder
      Returns:
      The location.

    • getLocationBytes

      public com.google.protobuf.ByteString getLocationBytes()
       Immutable. The location of the bucket. Object data for objects in the
 bucket resides in physical storage within this region.  Defaults to `US`.
 See the
 [https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations"][developer's
 guide] for the authoritative list. Attempting to update this field after
 the bucket is created will result in an error.
      string location = 5 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getLocationBytes in interface BucketOrBuilder
      Returns:
      The bytes for location.

    • getLocationType

      public String getLocationType()
       Output only. The location type of the bucket (region, dual-region,
 multi-region, etc).
      string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLocationType in interface BucketOrBuilder
      Returns:
      The locationType.

    • getLocationTypeBytes

      public com.google.protobuf.ByteString getLocationTypeBytes()
       Output only. The location type of the bucket (region, dual-region,
 multi-region, etc).
      string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLocationTypeBytes in interface BucketOrBuilder
      Returns:
      The bytes for locationType.

    • getStorageClass

      public String getStorageClass()
       Optional. The bucket's default storage class, used whenever no storageClass
 is specified for a newly-created object. This defines how objects in the
 bucket are stored and determines the SLA and the cost of storage.
 If this value is not specified when the bucket is created, it will default
 to `STANDARD`. For more information, see
 https://developers.google.com/storage/docs/storage-classes.
      string storage_class = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageClass in interface BucketOrBuilder
      Returns:
      The storageClass.

    • getStorageClassBytes

      public com.google.protobuf.ByteString getStorageClassBytes()
       Optional. The bucket's default storage class, used whenever no storageClass
 is specified for a newly-created object. This defines how objects in the
 bucket are stored and determines the SLA and the cost of storage.
 If this value is not specified when the bucket is created, it will default
 to `STANDARD`. For more information, see
 https://developers.google.com/storage/docs/storage-classes.
      string storage_class = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStorageClassBytes in interface BucketOrBuilder
      Returns:
      The bytes for storageClass.

    • getRpo

      public String getRpo()
       Optional. The recovery point objective for cross-region replication of the
 bucket. Applicable only for dual- and multi-region buckets. "DEFAULT" uses
 default replication. "ASYNC_TURBO" enables turbo replication, valid for
 dual-region buckets only. If rpo is not specified when the bucket is
 created, it defaults to "DEFAULT". For more information, see
 https://cloud.google.com/storage/docs/availability-durability#turbo-replication.
      string rpo = 27 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRpo in interface BucketOrBuilder
      Returns:
      The rpo.

    • getRpoBytes

      public com.google.protobuf.ByteString getRpoBytes()
       Optional. The recovery point objective for cross-region replication of the
 bucket. Applicable only for dual- and multi-region buckets. "DEFAULT" uses
 default replication. "ASYNC_TURBO" enables turbo replication, valid for
 dual-region buckets only. If rpo is not specified when the bucket is
 created, it defaults to "DEFAULT". For more information, see
 https://cloud.google.com/storage/docs/availability-durability#turbo-replication.
      string rpo = 27 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRpoBytes in interface BucketOrBuilder
      Returns:
      The bytes for rpo.

    • getAclList

      public List<BucketAccessControl> getAclList()
       Optional. Access controls on the bucket.
 If iam_config.uniform_bucket_level_access is enabled on this bucket,
 requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.BucketAccessControl acl = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclList in interface BucketOrBuilder

    • getAclOrBuilderList

      public List<? extends BucketAccessControlOrBuilder> getAclOrBuilderList()
       Optional. Access controls on the bucket.
 If iam_config.uniform_bucket_level_access is enabled on this bucket,
 requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.BucketAccessControl acl = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclOrBuilderList in interface BucketOrBuilder

    • getAclCount

      public int getAclCount()
       Optional. Access controls on the bucket.
 If iam_config.uniform_bucket_level_access is enabled on this bucket,
 requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.BucketAccessControl acl = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclCount in interface BucketOrBuilder

    • getAcl

      public BucketAccessControl getAcl(int index)
       Optional. Access controls on the bucket.
 If iam_config.uniform_bucket_level_access is enabled on this bucket,
 requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.BucketAccessControl acl = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAcl in interface BucketOrBuilder

    • getAclOrBuilder

      public BucketAccessControlOrBuilder getAclOrBuilder(int index)
       Optional. Access controls on the bucket.
 If iam_config.uniform_bucket_level_access is enabled on this bucket,
 requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.BucketAccessControl acl = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAclOrBuilder in interface BucketOrBuilder

    • getDefaultObjectAclList

      public List<ObjectAccessControl> getDefaultObjectAclList()
       Optional. Default access controls to apply to new objects when no ACL is
 provided. If iam_config.uniform_bucket_level_access is enabled on this
 bucket, requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultObjectAclList in interface BucketOrBuilder

    • getDefaultObjectAclOrBuilderList

      public List<? extends ObjectAccessControlOrBuilder> getDefaultObjectAclOrBuilderList()
       Optional. Default access controls to apply to new objects when no ACL is
 provided. If iam_config.uniform_bucket_level_access is enabled on this
 bucket, requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultObjectAclOrBuilderList in interface BucketOrBuilder

    • getDefaultObjectAclCount

      public int getDefaultObjectAclCount()
       Optional. Default access controls to apply to new objects when no ACL is
 provided. If iam_config.uniform_bucket_level_access is enabled on this
 bucket, requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultObjectAclCount in interface BucketOrBuilder

    • getDefaultObjectAcl

      public ObjectAccessControl getDefaultObjectAcl(int index)
       Optional. Default access controls to apply to new objects when no ACL is
 provided. If iam_config.uniform_bucket_level_access is enabled on this
 bucket, requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultObjectAcl in interface BucketOrBuilder

    • getDefaultObjectAclOrBuilder

      public ObjectAccessControlOrBuilder getDefaultObjectAclOrBuilder(int index)
       Optional. Default access controls to apply to new objects when no ACL is
 provided. If iam_config.uniform_bucket_level_access is enabled on this
 bucket, requests to set, read, or modify acl is an error.
      repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultObjectAclOrBuilder in interface BucketOrBuilder

    • hasLifecycle

      public boolean hasLifecycle()
       Optional. The bucket's lifecycle config. See
 [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management]
 for more information.
      .google.storage.v2.Bucket.Lifecycle lifecycle = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasLifecycle in interface BucketOrBuilder
      Returns:
      Whether the lifecycle field is set.

    • getLifecycle

      public Bucket.Lifecycle getLifecycle()
       Optional. The bucket's lifecycle config. See
 [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management]
 for more information.
      .google.storage.v2.Bucket.Lifecycle lifecycle = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLifecycle in interface BucketOrBuilder
      Returns:
      The lifecycle.

    • getLifecycleOrBuilder

      public Bucket.LifecycleOrBuilder getLifecycleOrBuilder()
       Optional. The bucket's lifecycle config. See
 [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management]
 for more information.
      .google.storage.v2.Bucket.Lifecycle lifecycle = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLifecycleOrBuilder in interface BucketOrBuilder

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

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

    • getCorsList

      public List<Bucket.Cors> getCorsList()
       Optional. The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource
 Sharing] (CORS) config.
      repeated .google.storage.v2.Bucket.Cors cors = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCorsList in interface BucketOrBuilder

    • getCorsOrBuilderList

      public List<? extends Bucket.CorsOrBuilder> getCorsOrBuilderList()
       Optional. The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource
 Sharing] (CORS) config.
      repeated .google.storage.v2.Bucket.Cors cors = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCorsOrBuilderList in interface BucketOrBuilder

    • getCorsCount

      public int getCorsCount()
       Optional. The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource
 Sharing] (CORS) config.
      repeated .google.storage.v2.Bucket.Cors cors = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCorsCount in interface BucketOrBuilder

    • getCors

      public Bucket.Cors getCors(int index)
       Optional. The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource
 Sharing] (CORS) config.
      repeated .google.storage.v2.Bucket.Cors cors = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCors in interface BucketOrBuilder

    • getCorsOrBuilder

      public Bucket.CorsOrBuilder getCorsOrBuilder(int index)
       Optional. The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource
 Sharing] (CORS) config.
      repeated .google.storage.v2.Bucket.Cors cors = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCorsOrBuilder in interface BucketOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The modification time of the bucket.
      .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface BucketOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The modification time of the bucket.
      .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface BucketOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The modification time of the bucket.
      .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface BucketOrBuilder

    • getDefaultEventBasedHold

      public boolean getDefaultEventBasedHold()
       Optional. The default value for event-based hold on newly created objects
 in this bucket.  Event-based hold is a way to retain objects indefinitely
 until an event occurs, signified by the hold's release. After being
 released, such objects will be subject to bucket-level retention (if any).
 One sample use case of this flag is for banks to hold loan documents for at
 least 3 years after loan is paid in full. Here, bucket-level retention is 3
 years and the event is loan being paid in full. In this example, these
 objects will be held intact for any number of years until the event has
 occurred (event-based hold on the object is released) and then 3 more years
 after that. That means retention duration of the objects begins from the
 moment event-based hold transitioned from true to false.  Objects under
 event-based hold cannot be deleted, overwritten or archived until the hold
 is removed.
      bool default_event_based_hold = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDefaultEventBasedHold in interface BucketOrBuilder
      Returns:
      The defaultEventBasedHold.

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface BucketOrBuilder

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. User-provided labels, in key/value pairs.
      map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface BucketOrBuilder

    • hasWebsite

      public boolean hasWebsite()
       Optional. The bucket's website config, controlling how the service behaves
 when accessing bucket contents as a web site. See the
 [https://cloud.google.com/storage/docs/static-website][Static Website
 Examples] for more information.
      .google.storage.v2.Bucket.Website website = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasWebsite in interface BucketOrBuilder
      Returns:
      Whether the website field is set.

    • getWebsite

      public Bucket.Website getWebsite()
       Optional. The bucket's website config, controlling how the service behaves
 when accessing bucket contents as a web site. See the
 [https://cloud.google.com/storage/docs/static-website][Static Website
 Examples] for more information.
      .google.storage.v2.Bucket.Website website = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebsite in interface BucketOrBuilder
      Returns:
      The website.

    • getWebsiteOrBuilder

      public Bucket.WebsiteOrBuilder getWebsiteOrBuilder()
       Optional. The bucket's website config, controlling how the service behaves
 when accessing bucket contents as a web site. See the
 [https://cloud.google.com/storage/docs/static-website][Static Website
 Examples] for more information.
      .google.storage.v2.Bucket.Website website = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebsiteOrBuilder in interface BucketOrBuilder

    • hasVersioning

      public boolean hasVersioning()
       Optional. The bucket's versioning config.
      .google.storage.v2.Bucket.Versioning versioning = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasVersioning in interface BucketOrBuilder
      Returns:
      Whether the versioning field is set.

    • getVersioning

      public Bucket.Versioning getVersioning()
       Optional. The bucket's versioning config.
      .google.storage.v2.Bucket.Versioning versioning = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVersioning in interface BucketOrBuilder
      Returns:
      The versioning.

    • getVersioningOrBuilder

      public Bucket.VersioningOrBuilder getVersioningOrBuilder()
       Optional. The bucket's versioning config.
      .google.storage.v2.Bucket.Versioning versioning = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVersioningOrBuilder in interface BucketOrBuilder

    • hasLogging

      public boolean hasLogging()
       Optional. The bucket's logging config, which defines the destination bucket
 and name prefix (if any) for the current bucket's logs.
      .google.storage.v2.Bucket.Logging logging = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasLogging in interface BucketOrBuilder
      Returns:
      Whether the logging field is set.

    • getLogging

      public Bucket.Logging getLogging()
       Optional. The bucket's logging config, which defines the destination bucket
 and name prefix (if any) for the current bucket's logs.
      .google.storage.v2.Bucket.Logging logging = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLogging in interface BucketOrBuilder
      Returns:
      The logging.

    • getLoggingOrBuilder

      public Bucket.LoggingOrBuilder getLoggingOrBuilder()
       Optional. The bucket's logging config, which defines the destination bucket
 and name prefix (if any) for the current bucket's logs.
      .google.storage.v2.Bucket.Logging logging = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLoggingOrBuilder in interface BucketOrBuilder

    • hasOwner

      public boolean hasOwner()
       Output only. The owner of the bucket. This is always the project team's
 owner group.
      .google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasOwner in interface BucketOrBuilder
      Returns:
      Whether the owner field is set.

    • getOwner

      public Owner getOwner()
       Output only. The owner of the bucket. This is always the project team's
 owner group.
      .google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOwner in interface BucketOrBuilder
      Returns:
      The owner.

    • getOwnerOrBuilder

      public OwnerOrBuilder getOwnerOrBuilder()
       Output only. The owner of the bucket. This is always the project team's
 owner group.
      .google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getOwnerOrBuilder in interface BucketOrBuilder

    • hasEncryption

      public boolean hasEncryption()
       Optional. Encryption config for a bucket.
      .google.storage.v2.Bucket.Encryption encryption = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEncryption in interface BucketOrBuilder
      Returns:
      Whether the encryption field is set.

    • getEncryption

      public Bucket.Encryption getEncryption()
       Optional. Encryption config for a bucket.
      .google.storage.v2.Bucket.Encryption encryption = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryption in interface BucketOrBuilder
      Returns:
      The encryption.

    • getEncryptionOrBuilder

      public Bucket.EncryptionOrBuilder getEncryptionOrBuilder()
       Optional. Encryption config for a bucket.
      .google.storage.v2.Bucket.Encryption encryption = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEncryptionOrBuilder in interface BucketOrBuilder

    • hasBilling

      public boolean hasBilling()
       Optional. The bucket's billing config.
      .google.storage.v2.Bucket.Billing billing = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBilling in interface BucketOrBuilder
      Returns:
      Whether the billing field is set.

    • getBilling

      public Bucket.Billing getBilling()
       Optional. The bucket's billing config.
      .google.storage.v2.Bucket.Billing billing = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBilling in interface BucketOrBuilder
      Returns:
      The billing.

    • getBillingOrBuilder

      public Bucket.BillingOrBuilder getBillingOrBuilder()
       Optional. The bucket's billing config.
      .google.storage.v2.Bucket.Billing billing = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBillingOrBuilder in interface BucketOrBuilder

    • hasRetentionPolicy

      public boolean hasRetentionPolicy()
       Optional. The bucket's retention policy. The retention policy enforces a
 minimum retention time for all objects contained in the bucket, based on
 their creation time. Any attempt to overwrite or delete objects younger
 than the retention period will result in a PERMISSION_DENIED error.  An
 unlocked retention policy can be modified or removed from the bucket via a
 storage.buckets.update operation. A locked retention policy cannot be
 removed or shortened in duration for the lifetime of the bucket.
 Attempting to remove or decrease period of a locked retention policy will
 result in a PERMISSION_DENIED error.
      .google.storage.v2.Bucket.RetentionPolicy retention_policy = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRetentionPolicy in interface BucketOrBuilder
      Returns:
      Whether the retentionPolicy field is set.

    • getRetentionPolicy

      public Bucket.RetentionPolicy getRetentionPolicy()
       Optional. The bucket's retention policy. The retention policy enforces a
 minimum retention time for all objects contained in the bucket, based on
 their creation time. Any attempt to overwrite or delete objects younger
 than the retention period will result in a PERMISSION_DENIED error.  An
 unlocked retention policy can be modified or removed from the bucket via a
 storage.buckets.update operation. A locked retention policy cannot be
 removed or shortened in duration for the lifetime of the bucket.
 Attempting to remove or decrease period of a locked retention policy will
 result in a PERMISSION_DENIED error.
      .google.storage.v2.Bucket.RetentionPolicy retention_policy = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionPolicy in interface BucketOrBuilder
      Returns:
      The retentionPolicy.

    • getRetentionPolicyOrBuilder

      public Bucket.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()
       Optional. The bucket's retention policy. The retention policy enforces a
 minimum retention time for all objects contained in the bucket, based on
 their creation time. Any attempt to overwrite or delete objects younger
 than the retention period will result in a PERMISSION_DENIED error.  An
 unlocked retention policy can be modified or removed from the bucket via a
 storage.buckets.update operation. A locked retention policy cannot be
 removed or shortened in duration for the lifetime of the bucket.
 Attempting to remove or decrease period of a locked retention policy will
 result in a PERMISSION_DENIED error.
      .google.storage.v2.Bucket.RetentionPolicy retention_policy = 22 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRetentionPolicyOrBuilder in interface BucketOrBuilder

    • hasIamConfig

      public boolean hasIamConfig()
       Optional. The bucket's IAM config.
      .google.storage.v2.Bucket.IamConfig iam_config = 23 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasIamConfig in interface BucketOrBuilder
      Returns:
      Whether the iamConfig field is set.

    • getIamConfig

      public Bucket.IamConfig getIamConfig()
       Optional. The bucket's IAM config.
      .google.storage.v2.Bucket.IamConfig iam_config = 23 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIamConfig in interface BucketOrBuilder
      Returns:
      The iamConfig.

    • getIamConfigOrBuilder

      public Bucket.IamConfigOrBuilder getIamConfigOrBuilder()
       Optional. The bucket's IAM config.
      .google.storage.v2.Bucket.IamConfig iam_config = 23 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIamConfigOrBuilder in interface BucketOrBuilder

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Optional. Reserved for future use.
      bool satisfies_pzs = 25 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSatisfiesPzs in interface BucketOrBuilder
      Returns:
      The satisfiesPzs.

    • hasCustomPlacementConfig

      public boolean hasCustomPlacementConfig()
       Optional. Configuration that, if present, specifies the data placement for
 a
 [https://cloud.google.com/storage/docs/locations#location-dr][configurable
 dual-region].
      .google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCustomPlacementConfig in interface BucketOrBuilder
      Returns:
      Whether the customPlacementConfig field is set.

    • getCustomPlacementConfig

      public Bucket.CustomPlacementConfig getCustomPlacementConfig()
       Optional. Configuration that, if present, specifies the data placement for
 a
 [https://cloud.google.com/storage/docs/locations#location-dr][configurable
 dual-region].
      .google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomPlacementConfig in interface BucketOrBuilder
      Returns:
      The customPlacementConfig.

    • getCustomPlacementConfigOrBuilder

      public Bucket.CustomPlacementConfigOrBuilder getCustomPlacementConfigOrBuilder()
       Optional. Configuration that, if present, specifies the data placement for
 a
 [https://cloud.google.com/storage/docs/locations#location-dr][configurable
 dual-region].
      .google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCustomPlacementConfigOrBuilder in interface BucketOrBuilder

    • hasAutoclass

      public boolean hasAutoclass()
       Optional. The bucket's Autoclass configuration. If there is no
 configuration, the Autoclass feature will be disabled and have no effect on
 the bucket.
      .google.storage.v2.Bucket.Autoclass autoclass = 28 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAutoclass in interface BucketOrBuilder
      Returns:
      Whether the autoclass field is set.

    • getAutoclass

      public Bucket.Autoclass getAutoclass()
       Optional. The bucket's Autoclass configuration. If there is no
 configuration, the Autoclass feature will be disabled and have no effect on
 the bucket.
      .google.storage.v2.Bucket.Autoclass autoclass = 28 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoclass in interface BucketOrBuilder
      Returns:
      The autoclass.

    • getAutoclassOrBuilder

      public Bucket.AutoclassOrBuilder getAutoclassOrBuilder()
       Optional. The bucket's Autoclass configuration. If there is no
 configuration, the Autoclass feature will be disabled and have no effect on
 the bucket.
      .google.storage.v2.Bucket.Autoclass autoclass = 28 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoclassOrBuilder in interface BucketOrBuilder

    • hasHierarchicalNamespace

      public boolean hasHierarchicalNamespace()
       Optional. The bucket's hierarchical namespace configuration. If there is no
 configuration, the hierarchical namespace feature will be disabled and have
 no effect on the bucket.
      .google.storage.v2.Bucket.HierarchicalNamespace hierarchical_namespace = 32 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasHierarchicalNamespace in interface BucketOrBuilder
      Returns:
      Whether the hierarchicalNamespace field is set.

    • getHierarchicalNamespace

      public Bucket.HierarchicalNamespace getHierarchicalNamespace()
       Optional. The bucket's hierarchical namespace configuration. If there is no
 configuration, the hierarchical namespace feature will be disabled and have
 no effect on the bucket.
      .google.storage.v2.Bucket.HierarchicalNamespace hierarchical_namespace = 32 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHierarchicalNamespace in interface BucketOrBuilder
      Returns:
      The hierarchicalNamespace.

    • getHierarchicalNamespaceOrBuilder

      public Bucket.HierarchicalNamespaceOrBuilder getHierarchicalNamespaceOrBuilder()
       Optional. The bucket's hierarchical namespace configuration. If there is no
 configuration, the hierarchical namespace feature will be disabled and have
 no effect on the bucket.
      .google.storage.v2.Bucket.HierarchicalNamespace hierarchical_namespace = 32 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHierarchicalNamespaceOrBuilder in interface BucketOrBuilder

    • hasSoftDeletePolicy

      public boolean hasSoftDeletePolicy()
       Optional. The bucket's soft delete policy. The soft delete policy prevents
 soft-deleted objects from being permanently deleted.
      .google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSoftDeletePolicy in interface BucketOrBuilder
      Returns:
      Whether the softDeletePolicy field is set.

    • getSoftDeletePolicy

      public Bucket.SoftDeletePolicy getSoftDeletePolicy()
       Optional. The bucket's soft delete policy. The soft delete policy prevents
 soft-deleted objects from being permanently deleted.
      .google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSoftDeletePolicy in interface BucketOrBuilder
      Returns:
      The softDeletePolicy.

    • getSoftDeletePolicyOrBuilder

      public Bucket.SoftDeletePolicyOrBuilder getSoftDeletePolicyOrBuilder()
       Optional. The bucket's soft delete policy. The soft delete policy prevents
 soft-deleted objects from being permanently deleted.
      .google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSoftDeletePolicyOrBuilder in interface BucketOrBuilder

    • hasObjectRetention

      public boolean hasObjectRetention()
       Optional. The bucket's object retention configuration. Must be enabled
 before objects in the bucket may have retention configured.
      .google.storage.v2.Bucket.ObjectRetention object_retention = 33 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasObjectRetention in interface BucketOrBuilder
      Returns:
      Whether the objectRetention field is set.

    • getObjectRetention

      public Bucket.ObjectRetention getObjectRetention()
       Optional. The bucket's object retention configuration. Must be enabled
 before objects in the bucket may have retention configured.
      .google.storage.v2.Bucket.ObjectRetention object_retention = 33 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getObjectRetention in interface BucketOrBuilder
      Returns:
      The objectRetention.

    • getObjectRetentionOrBuilder

      public Bucket.ObjectRetentionOrBuilder getObjectRetentionOrBuilder()
       Optional. The bucket's object retention configuration. Must be enabled
 before objects in the bucket may have retention configured.
      .google.storage.v2.Bucket.ObjectRetention object_retention = 33 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getObjectRetentionOrBuilder in interface BucketOrBuilder

    • hasIpFilter

      public boolean hasIpFilter()
       Optional. The bucket's IP filter configuration.
      optional .google.storage.v2.Bucket.IpFilter ip_filter = 38 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasIpFilter in interface BucketOrBuilder
      Returns:
      Whether the ipFilter field is set.

    • getIpFilter

      public Bucket.IpFilter getIpFilter()
       Optional. The bucket's IP filter configuration.
      optional .google.storage.v2.Bucket.IpFilter ip_filter = 38 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIpFilter in interface BucketOrBuilder
      Returns:
      The ipFilter.

    • getIpFilterOrBuilder

      public Bucket.IpFilterOrBuilder getIpFilterOrBuilder()
       Optional. The bucket's IP filter configuration.
      optional .google.storage.v2.Bucket.IpFilter ip_filter = 38 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getIpFilterOrBuilder in interface BucketOrBuilder

    • 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 Bucket parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Bucket.Builder newBuilder()

    • newBuilder

      public static Bucket.Builder newBuilder(Bucket prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Bucket getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Bucket> 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 Bucket getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder