Class Bucket.Builder (2.37.0) 

public static class Bucket.Builder extends BucketInfo.Builder

Builder for Bucket.

Inheritance

java.lang.Object > BucketInfo.Builder > Bucket.Builder

Methods

build()

public Bucket build()

Creates a BucketInfo object.

Returns
Type Description
Bucket
Overrides

deleteLifecycleRules()

public Bucket.Builder deleteLifecycleRules()

Deletes the lifecycle rules of this bucket.

Returns
Type Description
Bucket.Builder
Overrides

setAcl(Iterable<Acl> acl)

public Bucket.Builder setAcl(Iterable<Acl> acl)

Sets the bucket's access control configuration.

Parameter
Name Description
acl Iterable<Acl>
Returns
Type Description
Bucket.Builder
Overrides

setAutoclass(BucketInfo.Autoclass autoclass)

public Bucket.Builder setAutoclass(BucketInfo.Autoclass autoclass)
Parameter
Name Description
autoclass BucketInfo.Autoclass
Returns
Type Description
Bucket.Builder
Overrides

setCors(Iterable<Cors> cors)

public Bucket.Builder setCors(Iterable<Cors> cors)

Sets the bucket's Cross-Origin Resource Sharing (CORS) configuration.

Parameter
Name Description
cors Iterable<Cors>
Returns
Type Description
Bucket.Builder
Overrides

setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)

public Bucket.Builder setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)
Parameter
Name Description
customPlacementConfig BucketInfo.CustomPlacementConfig
Returns
Type Description
Bucket.Builder
Overrides

setDefaultAcl(Iterable<Acl> acl)

public Bucket.Builder setDefaultAcl(Iterable<Acl> acl)

Sets the default access control configuration to apply to bucket's blobs when no other configuration is specified.

Parameter
Name Description
acl Iterable<Acl>
Returns
Type Description
Bucket.Builder
Overrides

setDefaultEventBasedHold(Boolean defaultEventBasedHold)

public Bucket.Builder setDefaultEventBasedHold(Boolean defaultEventBasedHold)

Sets the default event-based hold for this bucket.

Parameter
Name Description
defaultEventBasedHold Boolean
Returns
Type Description
Bucket.Builder
Overrides

setDefaultKmsKeyName(String defaultKmsKeyName)

public Bucket.Builder setDefaultKmsKeyName(String defaultKmsKeyName)

Sets the default Cloud KMS key name for this bucket.

Parameter
Name Description
defaultKmsKeyName String
Returns
Type Description
Bucket.Builder
Overrides

setDeleteRules(Iterable<? extends BucketInfo.DeleteRule> rules) (deprecated)

public Bucket.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.

Parameter
Name Description
rules Iterable<? extends com.google.cloud.storage.BucketInfo.DeleteRule>
Returns
Type Description
Bucket.Builder
Overrides

setHierarchicalNamespace(BucketInfo.HierarchicalNamespace hierarchicalNamespace)

public Bucket.Builder setHierarchicalNamespace(BucketInfo.HierarchicalNamespace hierarchicalNamespace)
Parameter
Name Description
hierarchicalNamespace BucketInfo.HierarchicalNamespace
Returns
Type Description
Bucket.Builder
Overrides

setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration)

public Bucket.Builder setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration)

Sets the IamConfiguration to specify whether IAM access should be enabled.

Parameter
Name Description
iamConfiguration BucketInfo.IamConfiguration
Returns
Type Description
Bucket.Builder
Overrides

setIndexPage(String indexPage)

public Bucket.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.

Parameter
Name Description
indexPage String
Returns
Type Description
Bucket.Builder
Overrides

setLabels(@Nullable Map<@NonNull String,@Nullable String> labels)

public Bucket.Builder setLabels(@Nullable Map<@NonNull String,@Nullable String> labels)

Sets the label of this bucket.

Parameter
Name Description
labels @org.checkerframework.checker.nullness.qual.Nullable java.util.Map<@org.checkerframework.checker.nullness.qual.NonNull java.lang.String,@org.checkerframework.checker.nullness.qual.Nullable java.lang.String>
Returns
Type Description
Bucket.Builder
Overrides

setLifecycleRules(Iterable<? extends BucketInfo.LifecycleRule> rules)

public Bucket.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.

Parameter
Name Description
rules Iterable<? extends com.google.cloud.storage.BucketInfo.LifecycleRule>
Returns
Type Description
Bucket.Builder
Overrides

setLocation(String location)

public Bucket.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.

Parameter
Name Description
location String
Returns
Type Description
Bucket.Builder
Overrides

setLogging(BucketInfo.Logging logging)

public Bucket.Builder setLogging(BucketInfo.Logging logging)
Parameter
Name Description
logging BucketInfo.Logging
Returns
Type Description
Bucket.Builder
Overrides

setName(String name)

public Bucket.Builder setName(String name)

Sets the bucket's name.

Parameter
Name Description
name String
Returns
Type Description
Bucket.Builder
Overrides

setNotFoundPage(String notFoundPage)

public Bucket.Builder setNotFoundPage(String notFoundPage)

Sets the custom object to return when a requested resource is not found.

Parameter
Name Description
notFoundPage String
Returns
Type Description
Bucket.Builder
Overrides

setRequesterPays(Boolean requesterPays)

public Bucket.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.

Parameter
Name Description
requesterPays Boolean
Returns
Type Description
Bucket.Builder
Overrides

setRetentionPeriod(Long retentionPeriod) (deprecated)

public Bucket.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.

Parameter
Name Description
retentionPeriod Long
Returns
Type Description
Bucket.Builder
Overrides

setRetentionPeriodDuration(Duration retentionPeriod)

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.

Parameter
Name Description
retentionPeriod Duration
Returns
Type Description
BucketInfo.Builder
Overrides

setRpo(Rpo rpo)

public Bucket.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.

Parameter
Name Description
rpo Rpo
Returns
Type Description
Bucket.Builder
Overrides

setSoftDeletePolicy(BucketInfo.SoftDeletePolicy softDeletePolicy)

public Bucket.Builder setSoftDeletePolicy(BucketInfo.SoftDeletePolicy softDeletePolicy)
Parameter
Name Description
softDeletePolicy BucketInfo.SoftDeletePolicy
Returns
Type Description
Bucket.Builder
Overrides

setStorageClass(StorageClass storageClass)

public Bucket.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.

Parameter
Name Description
storageClass StorageClass
Returns
Type Description
Bucket.Builder
Overrides

setVersioningEnabled(Boolean enable)

public Bucket.Builder setVersioningEnabled(Boolean enable)

Sets whether versioning should be enabled for this bucket. When set to true, versioning is fully enabled.

Parameter
Name Description
enable Boolean
Returns
Type Description
Bucket.Builder
Overrides