Package com.google.cloud.storage

Class BucketInfo.Builder

java.lang.Object
com.google.cloud.storage.BucketInfo.Builder
Direct Known Subclasses:
Bucket.Builder
Enclosing class:
BucketInfo
public abstract static class BucketInfo.Builder extends Object
Builder for BucketInfo.

  • Method Details

    • setName

      public abstract BucketInfo.Builder setName(String name)
      Sets the bucket's name.

    • setRequesterPays

      public abstract BucketInfo.Builder setRequesterPays(Boolean requesterPays)
      Sets whether a user accessing the bucket or an object it contains should assume the transit costs related to the access.

    • setVersioningEnabled

      public abstract BucketInfo.Builder setVersioningEnabled(Boolean enable)
      Sets whether versioning should be enabled for this bucket. When set to true, versioning is fully enabled.

    • setIndexPage

      public abstract BucketInfo.Builder setIndexPage(String indexPage)
      Sets the bucket's website index page. Behaves as the bucket's directory index where missing blobs are treated as potential directories.

    • setNotFoundPage

      public abstract BucketInfo.Builder setNotFoundPage(String notFoundPage)
      Sets the custom object to return when a requested resource is not found.

    • setDeleteRules

      @Deprecated public abstract BucketInfo.Builder setDeleteRules(Iterable<? extends BucketInfo.DeleteRule> rules)
      Deprecated.
      Use setLifecycleRules(Iterable) instead, as in setLifecycleRules(Collections.singletonList( new BucketInfo.LifecycleRule( LifecycleAction.newDeleteAction(), LifecycleCondition.newBuilder().setAge(5).build())));
      Sets the bucket's lifecycle configuration as a number of delete rules.

    • setLifecycleRules

      public abstract BucketInfo.Builder setLifecycleRules(Iterable<? extends BucketInfo.LifecycleRule> rules)
      Sets the bucket's lifecycle configuration as a number of lifecycle rules, consisting of an action and a condition.
      See Also:

    • deleteLifecycleRules

      public abstract BucketInfo.Builder deleteLifecycleRules()
      Deletes the lifecycle rules of this bucket.

    • setRpo

      public abstract BucketInfo.Builder setRpo(Rpo rpo)
      Sets the bucket's Recovery Point Objective (RPO). This can only be set for a dual-region bucket, and determines the speed at which data will be replicated between regions. See the Rpo class for supported values, and here for additional details.

    • setStorageClass

      public abstract BucketInfo.Builder setStorageClass(StorageClass storageClass)
      Sets the bucket's storage class. This defines how blobs in the bucket are stored and determines the SLA and the cost of storage. A list of supported values is available here.

    • setLocation

      public abstract BucketInfo.Builder setLocation(String location)
      Sets the bucket's location. Data for blobs in the bucket resides in physical storage within this region or regions. A list of supported values is available here.

    • setCors

      public abstract BucketInfo.Builder setCors(Iterable<Cors> cors)
      Sets the bucket's Cross-Origin Resource Sharing (CORS) configuration.
      See Also:

    • setAcl

      public abstract BucketInfo.Builder setAcl(Iterable<Acl> acl)
      Sets the bucket's access control configuration.
      See Also:

    • setDefaultAcl

      public abstract BucketInfo.Builder setDefaultAcl(Iterable<Acl> acl)
      Sets the default access control configuration to apply to bucket's blobs when no other configuration is specified.
      See Also:

    • setLabels

      public abstract BucketInfo.Builder setLabels(@Nullable Map<@NonNull String,@Nullable String> labels)
      Sets the label of this bucket.

    • setDefaultKmsKeyName

      public abstract BucketInfo.Builder setDefaultKmsKeyName(String defaultKmsKeyName)
      Sets the default Cloud KMS key name for this bucket.

    • setDefaultEventBasedHold

      @BetaApi public abstract BucketInfo.Builder setDefaultEventBasedHold(Boolean defaultEventBasedHold)
      Sets the default event-based hold for this bucket.

    • setRetentionPeriod

      @BetaApi @Deprecated public abstract BucketInfo.Builder setRetentionPeriod(Long retentionPeriod)
      Deprecated.
      Use setRetentionPeriodDuration(Duration)
      If policy is not locked this value can be cleared, increased, and decreased. If policy is locked the retention period can only be increased.

    • setRetentionPeriodDuration

      @BetaApi public BucketInfo.Builder setRetentionPeriodDuration(Duration retentionPeriod)
      If policy is not locked this value can be cleared, increased, and decreased. If policy is locked the retention period can only be increased.

    • setIamConfiguration

      @BetaApi public abstract BucketInfo.Builder setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration)
      Sets the IamConfiguration to specify whether IAM access should be enabled.
      See Also:

    • setAutoclass

      public abstract BucketInfo.Builder setAutoclass(BucketInfo.Autoclass autoclass)

    • setLogging

      public abstract BucketInfo.Builder setLogging(BucketInfo.Logging logging)

    • setCustomPlacementConfig

      public abstract BucketInfo.Builder setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)

    • build

      public abstract BucketInfo build()
      Creates a BucketInfo object.