public abstract static class BucketInfo . Builder
Methods
build()
public abstract BucketInfo build ()
Creates a BucketInfo object.
deleteLifecycleRules()
public abstract BucketInfo . Builder deleteLifecycleRules ()
Deletes the lifecycle rules of this bucket.
setAcl(Iterable<Acl> acl)
public abstract BucketInfo . Builder setAcl ( Iterable<Acl> acl )
setAutoclass(BucketInfo.Autoclass autoclass)
public abstract BucketInfo . Builder setAutoclass ( BucketInfo . Autoclass autoclass )
setCors(Iterable<Cors> cors)
public abstract BucketInfo . Builder setCors ( Iterable<Cors> cors )
setCustomPlacementConfig(BucketInfo.CustomPlacementConfig customPlacementConfig)
public abstract BucketInfo . Builder setCustomPlacementConfig ( BucketInfo . CustomPlacementConfig customPlacementConfig )
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
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
defaultEventBasedHoldBoolean
setDefaultKmsKeyName(String defaultKmsKeyName)
public abstract BucketInfo . Builder setDefaultKmsKeyName ( String defaultKmsKeyName )
Sets the default Cloud KMS key name for this bucket.
Parameter
Name Description
defaultKmsKeyNameString
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
rulesIterable <? extends com.google.cloud.storage.BucketInfo.DeleteRule >
setHierarchicalNamespace(BucketInfo.HierarchicalNamespace hierarchicalNamespace)
public abstract BucketInfo . Builder setHierarchicalNamespace ( BucketInfo . HierarchicalNamespace hierarchicalNamespace )
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
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
indexPageString
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 >
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
rulesIterable <? extends com.google.cloud.storage.BucketInfo.LifecycleRule >
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
locationString
setLogging(BucketInfo.Logging logging)
public abstract BucketInfo . Builder setLogging ( BucketInfo . Logging logging )
setName(String name)
public abstract BucketInfo . Builder setName ( String name )
Parameter
Name Description
nameString
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
notFoundPageString
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
requesterPaysBoolean
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
retentionPeriodLong
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
retentionPeriodDuration
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
rpoRpo
setSoftDeletePolicy(BucketInfo.SoftDeletePolicy softDeletePolicy)
public abstract BucketInfo . Builder setSoftDeletePolicy ( BucketInfo . SoftDeletePolicy softDeletePolicy )
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 .
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
enableBoolean
