Package com.google.storage.v2

Interface BucketOrBuilder

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

  • Method Details

    • getName

      String getName()
       Identifier. The name of the bucket.
 Format: `projects/{project}/buckets/{bucket}`
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

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

    • getBucketId

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

    • getBucketIdBytes

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

    • getEtag

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

    • getEtagBytes

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

    • getProject

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

    • getProjectBytes

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

    • getMetageneration

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

    • getLocation

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

    • getLocationBytes

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

    • getLocationType

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

    • getLocationTypeBytes

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

    • getStorageClass

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

    • getStorageClassBytes

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

    • getRpo

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

    • getRpoBytes

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

    • getAclList

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

    • getAcl

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

    • getAclCount

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

    • getAclOrBuilderList

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

    • getAclOrBuilder

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

    • getDefaultObjectAclList

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

    • getDefaultObjectAcl

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

    • getDefaultObjectAclCount

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

    • getDefaultObjectAclOrBuilderList

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

    • getDefaultObjectAclOrBuilder

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

    • hasLifecycle

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

    • getLifecycle

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

    • getLifecycleOrBuilder

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

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The creation time of the bucket.
      .google.protobuf.Timestamp create_time = 11 [(.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 bucket.
      .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

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

    • getCorsList

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

    • getCors

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

    • getCorsCount

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

    • getCorsOrBuilderList

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

    • getCorsOrBuilder

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

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The modification time of the bucket.
      .google.protobuf.Timestamp update_time = 13 [(.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 bucket.
      .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

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

    • getDefaultEventBasedHold

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

    • getLabelsCount

      int getLabelsCount()
       Optional. User-provided labels, in key/value pairs.
      map<string, string> labels = 15 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

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

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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

    • hasWebsite

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

    • getWebsite

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

    • getWebsiteOrBuilder

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

    • hasVersioning

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

    • getVersioning

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

    • getVersioningOrBuilder

      Bucket.VersioningOrBuilder getVersioningOrBuilder()
       Optional. The bucket's versioning config.
      .google.storage.v2.Bucket.Versioning versioning = 17 [(.google.api.field_behavior) = OPTIONAL];

    • hasLogging

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

    • getLogging

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

    • getLoggingOrBuilder

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

    • hasOwner

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

    • getOwner

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

    • getOwnerOrBuilder

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

    • hasEncryption

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

    • getEncryption

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

    • getEncryptionOrBuilder

      Bucket.EncryptionOrBuilder getEncryptionOrBuilder()
       Optional. Encryption config for a bucket.
      .google.storage.v2.Bucket.Encryption encryption = 20 [(.google.api.field_behavior) = OPTIONAL];

    • hasBilling

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

    • getBilling

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

    • getBillingOrBuilder

      Bucket.BillingOrBuilder getBillingOrBuilder()
       Optional. The bucket's billing config.
      .google.storage.v2.Bucket.Billing billing = 21 [(.google.api.field_behavior) = OPTIONAL];

    • hasRetentionPolicy

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

    • getRetentionPolicy

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

    • getRetentionPolicyOrBuilder

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

    • hasIamConfig

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

    • getIamConfig

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

    • getIamConfigOrBuilder

      Bucket.IamConfigOrBuilder getIamConfigOrBuilder()
       Optional. The bucket's IAM config.
      .google.storage.v2.Bucket.IamConfig iam_config = 23 [(.google.api.field_behavior) = OPTIONAL];

    • getSatisfiesPzs

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

    • hasCustomPlacementConfig

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

    • getCustomPlacementConfig

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

    • getCustomPlacementConfigOrBuilder

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

    • hasAutoclass

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

    • getAutoclass

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

    • getAutoclassOrBuilder

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

    • hasHierarchicalNamespace

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

    • getHierarchicalNamespace

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

    • getHierarchicalNamespaceOrBuilder

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

    • hasSoftDeletePolicy

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

    • getSoftDeletePolicy

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

    • getSoftDeletePolicyOrBuilder

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

    • hasObjectRetention

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

    • getObjectRetention

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

    • getObjectRetentionOrBuilder

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

    • hasIpFilter

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

    • getIpFilter

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

    • getIpFilterOrBuilder

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