Class BucketInfo.Builder (2.37.0)

Version 2.37.0

• 2.38.0 (latest)
• 2.37.0
• 2.36.1
• 2.34.0
• 2.33.0
• 2.32.1
• 2.30.1
• 2.29.1
• 2.28.0
• 2.27.1
• 2.24.0
• 2.23.0
• 2.22.6
• 2.21.0
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.2
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.3
• 2.10.0
• 2.9.3
• 2.8.1
• 2.7.1
• 2.6.1
• 2.5.1
• 2.4.5
• 2.3.0
• 2.2.3
• 2.1.10

public abstract static class BucketInfo.Builder

Builder for BucketInfo.

Inheritance

java.lang.Object > BucketInfo.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public abstract BucketInfo build()

Creates a BucketInfo object.

Returns
Type	Description
BucketInfo

deleteLifecycleRules()

public abstract BucketInfo.Builder deleteLifecycleRules()

Deletes the lifecycle rules of this bucket.

Returns
Type	Description
BucketInfo.Builder

setAcl(Iterable<Acl> acl)

public abstract BucketInfo.Builder setAcl(Iterable<Acl> acl)

Sets the bucket's access control configuration. See Also: About Access Control Lists

Parameter
Name	Description
acl	Iterable<Acl>

Returns
Type	Description
BucketInfo.Builder

setAutoclass(BucketInfo.Autoclass autoclass)

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

Parameter
Name	Description
autoclass	BucketInfo.Autoclass

Returns
Type	Description
BucketInfo.Builder

setCors(Iterable<Cors> cors)

public abstract BucketInfo.Builder setCors(Iterable<Cors> cors)

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

Parameter
Name	Description
cors	Iterable<Cors>

Returns
Type	Description
BucketInfo.Builder

setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)

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

Parameter
Name	Description
customPlacementConfig	BucketInfo.CustomPlacementConfig

Returns
Type	Description
BucketInfo.Builder

setDefaultAcl(Iterable<Acl> acl)

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: About Access Control Lists

Parameter
Name	Description
acl	Iterable<Acl>

Returns
Type	Description
BucketInfo.Builder

setDefaultEventBasedHold(Boolean defaultEventBasedHold)

public abstract BucketInfo.Builder setDefaultEventBasedHold(Boolean defaultEventBasedHold)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Sets the default event-based hold for this bucket.

Parameter
Name	Description
defaultEventBasedHold	Boolean

Returns
Type	Description
BucketInfo.Builder

setDefaultKmsKeyName(String defaultKmsKeyName)

public abstract BucketInfo.Builder setDefaultKmsKeyName(String defaultKmsKeyName)

Sets the default Cloud KMS key name for this bucket.

Parameter
Name	Description
defaultKmsKeyName	String

Returns
Type	Description
BucketInfo.Builder

setDeleteRules(Iterable<? extends BucketInfo.DeleteRule> rules) (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.

Parameter
Name	Description
rules	Iterable<? extends com.google.cloud.storage.BucketInfo.DeleteRule>

Returns
Type	Description
BucketInfo.Builder

setHierarchicalNamespace(BucketInfo.HierarchicalNamespace hierarchicalNamespace)

public abstract BucketInfo.Builder setHierarchicalNamespace(BucketInfo.HierarchicalNamespace hierarchicalNamespace)

Parameter
Name	Description
hierarchicalNamespace	BucketInfo.HierarchicalNamespace

Returns
Type	Description
BucketInfo.Builder

setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration)

public abstract BucketInfo.Builder setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Sets the IamConfiguration to specify whether IAM access should be enabled. See Also: Bucket Policy Only

Parameter
Name	Description
iamConfiguration	BucketInfo.IamConfiguration

Returns
Type	Description
BucketInfo.Builder

setIndexPage(String indexPage)

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.

Parameter
Name	Description
indexPage	String

Returns
Type	Description
BucketInfo.Builder

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

public abstract BucketInfo.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
BucketInfo.Builder

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

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: Object Lifecycle Management

Parameter
Name	Description
rules	Iterable<? extends com.google.cloud.storage.BucketInfo.LifecycleRule>

Returns
Type	Description
BucketInfo.Builder

setLocation(String location)

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.

Parameter
Name	Description
location	String

Returns
Type	Description
BucketInfo.Builder

setLogging(BucketInfo.Logging logging)

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

Parameter
Name	Description
logging	BucketInfo.Logging

Returns
Type	Description
BucketInfo.Builder

setName(String name)

public abstract BucketInfo.Builder setName(String name)

Sets the bucket's name.

Parameter
Name	Description
name	String

Returns
Type	Description
BucketInfo.Builder

setNotFoundPage(String notFoundPage)

public abstract BucketInfo.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
BucketInfo.Builder

setRequesterPays(Boolean requesterPays)

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.

Parameter
Name	Description
requesterPays	Boolean

Returns
Type	Description
BucketInfo.Builder

setRetentionPeriod(Long retentionPeriod) (deprecated)

public abstract BucketInfo.Builder setRetentionPeriod(Long retentionPeriod)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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
BucketInfo.Builder

setRetentionPeriodDuration(Duration retentionPeriod)

public BucketInfo.Builder setRetentionPeriodDuration(Duration retentionPeriod)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

setRpo(Rpo rpo)

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.

Parameter
Name	Description
rpo	Rpo

Returns
Type	Description
BucketInfo.Builder

setSoftDeletePolicy(BucketInfo.SoftDeletePolicy softDeletePolicy)

public abstract BucketInfo.Builder setSoftDeletePolicy(BucketInfo.SoftDeletePolicy softDeletePolicy)

Parameter
Name	Description
softDeletePolicy	BucketInfo.SoftDeletePolicy

Returns
Type	Description
BucketInfo.Builder

setStorageClass(StorageClass storageClass)

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.

Parameter
Name	Description
storageClass	StorageClass

Returns
Type	Description
BucketInfo.Builder

setVersioningEnabled(Boolean enable)

public abstract BucketInfo.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
BucketInfo.Builder