Package com.google.cloud.storage

Class BucketInfo

java.lang.Object

com.google.cloud.storage.BucketInfo

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Bucket

@TransportCompatibility({HTTP,GRPC})
public class BucketInfo
extends Object
implements Serializable

Google Storage bucket metadata;

See Also:

• Concepts and Terminology
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BucketInfo.AgeDeleteRule	Deprecated. Use a LifecycleRule with a DeleteLifecycleAction and use LifecycleCondition.Builder.setAge instead.
static final class	BucketInfo.Autoclass	Configuration for the Autoclass settings of a bucket.
static class	BucketInfo.Builder	Builder for BucketInfo.
static class	BucketInfo.CreatedBeforeDeleteRule	Deprecated. Use a LifecycleRule with an action DeleteLifecycleAction and a condition LifecycleCondition.Builder.setCreatedBefore instead.
static class	BucketInfo.CustomPlacementConfig	The bucket's custom placement configuration for Custom Dual Regions.
static class	BucketInfo.DeleteRule	Deprecated. Use a LifecycleRule with a DeleteLifecycleAction and a LifecycleCondition which is equivalent to a subclass of DeleteRule instead.
static final class	BucketInfo.HierarchicalNamespace	The bucket's hierarchical namespace (Folders) configuration.
static class	BucketInfo.IamConfiguration	The Bucket's IAM Configuration.
static class	BucketInfo.IsLiveDeleteRule	Deprecated. Use a LifecycleRule with a DeleteLifecycleAction and a condition LifecycleCondition.Builder.setIsLive instead.
static class	BucketInfo.LifecycleRule	Lifecycle rule for a bucket.
static class	BucketInfo.Logging	The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
static class	BucketInfo.NumNewerVersionsDeleteRule	Deprecated. Use a LifecycleRule with a DeleteLifecycleAction and a condition LifecycleCondition.Builder.setNumberOfNewerVersions instead.
static final class	BucketInfo.ObjectRetention
static enum	BucketInfo.PublicAccessPrevention	Public Access Prevention enum with expected values.
static class	BucketInfo.SoftDeletePolicy	The bucket's soft delete policy.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<Acl>	getAcl()	Returns the bucket's access control configuration.
BucketInfo.Autoclass	getAutoclass()	Returns the Autoclass configuration
List<Cors>	getCors()	Returns the bucket's Cross-Origin Resource Sharing (CORS) configuration.
Long	getCreateTime()	Deprecated. getCreateTimeOffsetDateTime()
OffsetDateTime	getCreateTimeOffsetDateTime()
BucketInfo.CustomPlacementConfig	getCustomPlacementConfig()	Returns the Custom Placement Configuration
List<Acl>	getDefaultAcl()	Returns the default access control configuration for this bucket's blobs.
Boolean	getDefaultEventBasedHold()	Returns a Boolean with either true, null and in certain cases false.
String	getDefaultKmsKeyName()	Returns the default Cloud KMS key to be applied to newly inserted objects in this bucket.
List<? extends BucketInfo.DeleteRule>	getDeleteRules()	Deprecated.
String	getEtag()	Returns HTTP 1.1 Entity tag for the bucket.
String	getGeneratedId()	Returns the service-generated id for the bucket.
BucketInfo.HierarchicalNamespace	getHierarchicalNamespace()	Returns the Hierarchical Namespace (Folders) Configuration
BucketInfo.IamConfiguration	getIamConfiguration()	Returns the IAM configuration
String	getIndexPage()	Returns bucket's website index page.
@Nullable Map<@NonNull String,@Nullable String>	getLabels()	Returns the labels for this bucket.
@NonNull List<? extends BucketInfo.LifecycleRule>	getLifecycleRules()
String	getLocation()	Returns the bucket's location.
String	getLocationType()	Returns the bucket's locationType.
BucketInfo.Logging	getLogging()	Returns the Logging
Long	getMetageneration()	Returns the metadata generation of this bucket.
String	getName()	Returns the bucket's name.
String	getNotFoundPage()	Returns the custom object to return when a requested resource is not found.
BucketInfo.ObjectRetention	getObjectRetention()	returns the Object Retention configuration
Acl.Entity	getOwner()	Returns the bucket's owner.
BigInteger	getProject()	The project number of the project the bucket belongs to
Long	getRetentionEffectiveTime()	Deprecated. Use getRetentionPeriodDuration()
OffsetDateTime	getRetentionEffectiveTimeOffsetDateTime()	Returns the retention effective time a policy took effect if a retention policy is defined.
Long	getRetentionPeriod()	Deprecated. Use getRetentionPeriodDuration()
Duration	getRetentionPeriodDuration()	Returns the retention policy retention period.
Rpo	getRpo()	Returns the bucket's recovery point objective (RPO).
String	getSelfLink()	Returns the URI of this bucket as a string.
BucketInfo.SoftDeletePolicy	getSoftDeletePolicy()	returns the Soft Delete policy
StorageClass	getStorageClass()	Returns the bucket's storage class.
Long	getUpdateTime()	Deprecated. getUpdateTimeOffsetDateTime()
OffsetDateTime	getUpdateTimeOffsetDateTime()
int	hashCode()
static BucketInfo.Builder	newBuilder(String name)	Returns a BucketInfo builder where the bucket's name is set to the provided name.
static BucketInfo	of(String name)	Creates a BucketInfo object for the provided bucket name.
Boolean	requesterPays()	Returns a Boolean with either true, false, and in a specific case null.
Boolean	retentionPolicyIsLocked()	Returns a Boolean with either true or null.
BucketInfo.Builder	toBuilder()	Returns a builder for the current bucket.
String	toString()
Boolean	versioningEnabled()	Returns a Boolean with either true, null and in certain cases false.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getProject

public BigInteger getProject()

The project number of the project the bucket belongs to

getGeneratedId

public String getGeneratedId()

Returns the service-generated id for the bucket.

getName

public String getName()

Returns the bucket's name.

getOwner

public Acl.Entity getOwner()

Returns the bucket's owner. This is always the project team's owner group.

getSelfLink

public String getSelfLink()

Returns the URI of this bucket as a string.

versioningEnabled

public Boolean versioningEnabled()

Returns a Boolean with either true, null and in certain cases false.

Case 1: true the field Storage.BucketField.VERSIONING is selected in a Storage.get(String, Storage.BucketGetOption...) and versions for the bucket is enabled.

Case 2.1: null the field Storage.BucketField.VERSIONING is selected in a Storage.get(String, Storage.BucketGetOption...), but versions for the bucket is not enabled. This case can be considered implicitly false.

Case 2.2: null the field Storage.BucketField.VERSIONING is not selected in a Storage.get(String, Storage.BucketGetOption...), and the state for this field is unknown.

Case 3: false versions is explicitly set to false client side for a follow-up request for example Storage.update(BucketInfo, Storage.BucketTargetOption...) in which case the value of versions will remain false for for the given instance.

requesterPays

public Boolean requesterPays()

Returns a Boolean with either true, false, and in a specific case null.

Case 1: true the field Storage.BucketField.BILLING is selected in a Storage.get(String, Storage.BucketGetOption...) and requester pays for the bucket is enabled.

Case 2: false the field Storage.BucketField.BILLING in a Storage.get(String, Storage.BucketGetOption...) is selected and requester pays for the bucket is disable.

Case 3: null the field Storage.BucketField.BILLING in a Storage.get(String, Storage.BucketGetOption...) is not selected, the value is unknown.

getIndexPage

public String getIndexPage()

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

getNotFoundPage

public String getNotFoundPage()

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

getDeleteRules

@Deprecated
public List<? extends BucketInfo.DeleteRule> getDeleteRules()

Deprecated.

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

See Also:

• Lifecycle Management

getLifecycleRules

public @NonNull List<? extends BucketInfo.LifecycleRule> getLifecycleRules()

getEtag

public String getEtag()

Returns HTTP 1.1 Entity tag for the bucket.

See Also:

• Entity Tags

getCreateTime

@Deprecated
public Long getCreateTime()

Deprecated.

getCreateTimeOffsetDateTime()

Returns the time at which the bucket was created.

getCreateTimeOffsetDateTime

public OffsetDateTime getCreateTimeOffsetDateTime()

getUpdateTime

@Deprecated
public Long getUpdateTime()

Deprecated.

getUpdateTimeOffsetDateTime()

Returns the last modification time of the bucket's metadata expressed as the number of milliseconds since the Unix epoch.

getUpdateTimeOffsetDateTime

public OffsetDateTime getUpdateTimeOffsetDateTime()

getMetageneration

public Long getMetageneration()

Returns the metadata generation of this bucket.

getLocation

public String getLocation()

Returns the bucket's location. Data for blobs in the bucket resides in physical storage within this region or regions. If specifying more than one region `customPlacementConfig` should be set in conjunction.

See Also:

• Bucket Locations

getLocationType

public String getLocationType()

Returns the bucket's locationType.

See Also:

• Bucket LocationType

getRpo

public Rpo getRpo()

Returns the bucket's recovery point objective (RPO). This defines how quickly data is replicated between regions in a dual-region bucket. Not defined for single-region buckets.

See Also:

• Turbo Replication"

getStorageClass

public StorageClass getStorageClass()

Returns the bucket's storage class. This defines how blobs in the bucket are stored and determines the SLA and the cost of storage.

See Also:

• Storage Classes

getCors

public List<Cors> getCors()

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

See Also:

• Cross-Origin Resource Sharing (CORS)

getAcl

public List<Acl> getAcl()

Returns the bucket's access control configuration.

See Also:

• About Access Control Lists

getDefaultAcl

public List<Acl> getDefaultAcl()

Returns the default access control configuration for this bucket's blobs.

See Also:

• About Access Control Lists

getLabels

public @Nullable Map<@NonNull String,@Nullable String> getLabels()

Returns the labels for this bucket.

getDefaultKmsKeyName

public String getDefaultKmsKeyName()

Returns the default Cloud KMS key to be applied to newly inserted objects in this bucket.

getDefaultEventBasedHold

@BetaApi
public Boolean getDefaultEventBasedHold()

Returns a Boolean with either true, null and in certain cases false.

Case 1: true the field Storage.BucketField.DEFAULT_EVENT_BASED_HOLD is selected in a Storage.get(String, Storage.BucketGetOption...) and default event-based hold for the bucket is enabled.

Case 2.1: null the field Storage.BucketField.DEFAULT_EVENT_BASED_HOLD is selected in a Storage.get(String, Storage.BucketGetOption...), but default event-based hold for the bucket is not enabled. This case can be considered implicitly false.

Case 2.2: null the field Storage.BucketField.DEFAULT_EVENT_BASED_HOLD is not selected in a Storage.get(String, Storage.BucketGetOption...), and the state for this field is unknown.

Case 3: false default event-based hold is explicitly set to false using in a BucketInfo.Builder.setDefaultEventBasedHold(Boolean) client side for a follow-up request e.g. Storage.update(BucketInfo, Storage.BucketTargetOption...) in which case the value of default event-based hold will remain false for the given instance.

getRetentionEffectiveTime

@BetaApi
@Deprecated
public Long getRetentionEffectiveTime()

Deprecated.

Use getRetentionPeriodDuration()

Returns the retention effective time a policy took effect if a retention policy is defined as a Long.

getRetentionEffectiveTimeOffsetDateTime

@BetaApi
public OffsetDateTime getRetentionEffectiveTimeOffsetDateTime()

Returns the retention effective time a policy took effect if a retention policy is defined.

retentionPolicyIsLocked

@BetaApi
public Boolean retentionPolicyIsLocked()

Returns a Boolean with either true or null.

Case 1: true the field Storage.BucketField.RETENTION_POLICY is selected in a Storage.get(String, Storage.BucketGetOption...) and retention policy for the bucket is locked.

Case 2.1: null the field Storage.BucketField.RETENTION_POLICY is selected in a Storage.get(String, Storage.BucketGetOption...), but retention policy for the bucket is not locked. This case can be considered implicitly false.

Case 2.2: null the field Storage.BucketField.RETENTION_POLICY is not selected in a Storage.get(String, Storage.BucketGetOption...), and the state for this field is unknown.

getRetentionPeriod

@BetaApi
@Deprecated
public Long getRetentionPeriod()

Deprecated.

Use getRetentionPeriodDuration()

Returns the retention policy retention period.

getRetentionPeriodDuration

@BetaApi
public Duration getRetentionPeriodDuration()

Returns the retention policy retention period.

getIamConfiguration

@BetaApi
public BucketInfo.IamConfiguration getIamConfiguration()

Returns the IAM configuration

getAutoclass

public BucketInfo.Autoclass getAutoclass()

Returns the Autoclass configuration

getLogging

public BucketInfo.Logging getLogging()

Returns the Logging

getCustomPlacementConfig

public BucketInfo.CustomPlacementConfig getCustomPlacementConfig()

Returns the Custom Placement Configuration

getObjectRetention

public BucketInfo.ObjectRetention getObjectRetention()

returns the Object Retention configuration

getSoftDeletePolicy

public BucketInfo.SoftDeletePolicy getSoftDeletePolicy()

returns the Soft Delete policy

getHierarchicalNamespace

public BucketInfo.HierarchicalNamespace getHierarchicalNamespace()

Returns the Hierarchical Namespace (Folders) Configuration

toBuilder

public BucketInfo.Builder toBuilder()

Returns a builder for the current bucket.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static BucketInfo of(String name)

Creates a BucketInfo object for the provided bucket name.

newBuilder

public static BucketInfo.Builder newBuilder(String name)

Returns a BucketInfo builder where the bucket's name is set to the provided name.