com.google.cloud.storage

Class Bucket.Builder

java.lang.Object

com.google.cloud.storage.BucketInfo.Builder

com.google.cloud.storage.Bucket.Builder

Enclosing class:

Bucket

public static class Bucket.Builder
extends BucketInfo.Builder

Builder for Bucket.

Method Summary

Modifier and Type	Method and Description
Bucket	build() Creates a BucketInfo object.
Bucket.Builder	deleteLifecycleRules() Deletes the lifecycle rules of this bucket.
Bucket.Builder	setAcl(Iterable<Acl> acl) Sets the bucket's access control configuration.
Bucket.Builder	setAutoclass(BucketInfo.Autoclass autoclass)
Bucket.Builder	setCors(Iterable<Cors> cors) Sets the bucket's Cross-Origin Resource Sharing (CORS) configuration.
Bucket.Builder	setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)
Bucket.Builder	setDefaultAcl(Iterable<Acl> acl) Sets the default access control configuration to apply to bucket's blobs when no other configuration is specified.
Bucket.Builder	setDefaultEventBasedHold(Boolean defaultEventBasedHold) Sets the default event-based hold for this bucket.
Bucket.Builder	setDefaultKmsKeyName(String defaultKmsKeyName) Sets the default Cloud KMS key name for this bucket.
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())));
Bucket.Builder	setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration) Sets the IamConfiguration to specify whether IAM access should be enabled.
Bucket.Builder	setIndexPage(String indexPage) Sets the bucket's website index page.
Bucket.Builder	setLabels(@Nullable Map<String,String> labels) Sets the label of this bucket.
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.
Bucket.Builder	setLocation(String location) Sets the bucket's location.
Bucket.Builder	setLogging(BucketInfo.Logging logging)
Bucket.Builder	setName(String name) Sets the bucket's name.
Bucket.Builder	setNotFoundPage(String notFoundPage) Sets the custom object to return when a requested resource is not found.
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.
Bucket.Builder	setRetentionPeriod(Long retentionPeriod) Deprecated. Use setRetentionPeriodDuration(Duration)
BucketInfo.Builder	setRetentionPeriodDuration(Duration retentionPeriod) If policy is not locked this value can be cleared, increased, and decreased.
Bucket.Builder	setRpo(Rpo rpo) Sets the bucket's Recovery Point Objective (RPO).
Bucket.Builder	setStorageClass(StorageClass storageClass) Sets the bucket's storage class.
Bucket.Builder	setVersioningEnabled(Boolean enable) Sets whether versioning should be enabled for this bucket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setName

public Bucket.Builder setName(String name)

Description copied from class: BucketInfo.Builder

Sets the bucket's name.

Specified by:

setName in class BucketInfo.Builder

setVersioningEnabled

public Bucket.Builder setVersioningEnabled(Boolean enable)

Description copied from class: BucketInfo.Builder

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

Specified by:

setVersioningEnabled in class BucketInfo.Builder

setRequesterPays

public Bucket.Builder setRequesterPays(Boolean requesterPays)

Description copied from class: BucketInfo.Builder

Sets whether a user accessing the bucket or an object it contains should assume the transit costs related to the access.

Specified by:

setRequesterPays in class BucketInfo.Builder

setIndexPage

public Bucket.Builder setIndexPage(String indexPage)

Description copied from class: BucketInfo.Builder

Sets the bucket's website index page. Behaves as the bucket's directory index where missing blobs are treated as potential directories.

Specified by:

setIndexPage in class BucketInfo.Builder

setNotFoundPage

public Bucket.Builder setNotFoundPage(String notFoundPage)

Description copied from class: BucketInfo.Builder

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

Specified by:

setNotFoundPage in class BucketInfo.Builder

setDeleteRules

@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())));

Description copied from class: BucketInfo.Builder

Sets the bucket's lifecycle configuration as a number of delete rules.

Specified by:

setDeleteRules in class BucketInfo.Builder

setLifecycleRules

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

Description copied from class: BucketInfo.Builder

Sets the bucket's lifecycle configuration as a number of lifecycle rules, consisting of an action and a condition.

Specified by:

setLifecycleRules in class BucketInfo.Builder

See Also:

Object Lifecycle Management

deleteLifecycleRules

public Bucket.Builder deleteLifecycleRules()

Description copied from class: BucketInfo.Builder

Deletes the lifecycle rules of this bucket.

Specified by:

deleteLifecycleRules in class BucketInfo.Builder

setRpo

public Bucket.Builder setRpo(Rpo rpo)

Description copied from class: BucketInfo.Builder

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.

Specified by:

setRpo in class BucketInfo.Builder

setStorageClass

public Bucket.Builder setStorageClass(StorageClass storageClass)

Description copied from class: BucketInfo.Builder

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.

Specified by:

setStorageClass in class BucketInfo.Builder

setLocation

public Bucket.Builder setLocation(String location)

Description copied from class: BucketInfo.Builder

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.

Specified by:

setLocation in class BucketInfo.Builder

setCors

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

Description copied from class: BucketInfo.Builder

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

Specified by:

setCors in class BucketInfo.Builder

See Also:

Cross-Origin Resource Sharing (CORS)

setAcl

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

Description copied from class: BucketInfo.Builder

Sets the bucket's access control configuration.

Specified by:

setAcl in class BucketInfo.Builder

See Also:

About Access Control Lists

setDefaultAcl

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

Description copied from class: BucketInfo.Builder

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

Specified by:

setDefaultAcl in class BucketInfo.Builder

See Also:

About Access Control Lists

setLabels

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

Description copied from class: BucketInfo.Builder

Sets the label of this bucket.

Specified by:

setLabels in class BucketInfo.Builder

setDefaultKmsKeyName

public Bucket.Builder setDefaultKmsKeyName(String defaultKmsKeyName)

Description copied from class: BucketInfo.Builder

Sets the default Cloud KMS key name for this bucket.

Specified by:

setDefaultKmsKeyName in class BucketInfo.Builder

setDefaultEventBasedHold

public Bucket.Builder setDefaultEventBasedHold(Boolean defaultEventBasedHold)

Description copied from class: BucketInfo.Builder

Sets the default event-based hold for this bucket.

Specified by:

setDefaultEventBasedHold in class BucketInfo.Builder

setRetentionPeriod

@Deprecated
public Bucket.Builder setRetentionPeriod(Long retentionPeriod)

Deprecated. Use setRetentionPeriodDuration(Duration)

Description copied from class: BucketInfo.Builder

If policy is not locked this value can be cleared, increased, and decreased. If policy is locked the retention period can only be increased.

Specified by:

setRetentionPeriod in class BucketInfo.Builder

setRetentionPeriodDuration

public BucketInfo.Builder setRetentionPeriodDuration(Duration retentionPeriod)

Description copied from class: BucketInfo.Builder

If policy is not locked this value can be cleared, increased, and decreased. If policy is locked the retention period can only be increased.

Overrides:

setRetentionPeriodDuration in class BucketInfo.Builder

setIamConfiguration

public Bucket.Builder setIamConfiguration(BucketInfo.IamConfiguration iamConfiguration)

Description copied from class: BucketInfo.Builder

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

Specified by:

setIamConfiguration in class BucketInfo.Builder

See Also:

Bucket Policy Only

setAutoclass

public Bucket.Builder setAutoclass(BucketInfo.Autoclass autoclass)

Specified by:

setAutoclass in class BucketInfo.Builder

setLogging

public Bucket.Builder setLogging(BucketInfo.Logging logging)

Specified by:

setLogging in class BucketInfo.Builder

setCustomPlacementConfig

public Bucket.Builder setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)

Specified by:

setCustomPlacementConfig in class BucketInfo.Builder

build

public Bucket build()

Description copied from class: BucketInfo.Builder

Creates a BucketInfo object.

Specified by:

build in class BucketInfo.Builder