Interface BucketOrBuilder (2.3.0)

public interface BucketOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getAcl(int index)

public abstract BucketAccessControl getAcl(int index)

Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.BucketAccessControl acl = 8;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BucketAccessControl

getAclCount()

public abstract int getAclCount()

Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.BucketAccessControl acl = 8;

Returns

Type	Description
int

getAclList()

public abstract List<BucketAccessControl> getAclList()

Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.BucketAccessControl acl = 8;

Returns

Type	Description
List<BucketAccessControl>

getAclOrBuilder(int index)

public abstract BucketAccessControlOrBuilder getAclOrBuilder(int index)

Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.BucketAccessControl acl = 8;

Parameter

Name	Description
index	`int`

Returns

Type	Description
BucketAccessControlOrBuilder

getAclOrBuilderList()

public abstract List<? extends BucketAccessControlOrBuilder> getAclOrBuilderList()

Access controls on the bucket. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.BucketAccessControl acl = 8;

Returns

Type	Description
List<? extends com.google.storage.v2.BucketAccessControlOrBuilder>

getBilling()

public abstract Bucket.Billing getBilling()

The bucket's billing config.

.google.storage.v2.Bucket.Billing billing = 21;

Returns

Type	Description
Bucket.Billing	The billing.

getBillingOrBuilder()

public abstract Bucket.BillingOrBuilder getBillingOrBuilder()

The bucket's billing config.

.google.storage.v2.Bucket.Billing billing = 21;

Returns

Type	Description
Bucket.BillingOrBuilder

getBucketId()

public abstract String getBucketId()

Output only. The user-chosen part of the bucket name. The {bucket} portion of the name field. For globally unique buckets, this is equal to the "bucket name" of other Cloud Storage APIs. Example: "pub".

string bucket_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The bucketId.

getBucketIdBytes()

public abstract ByteString getBucketIdBytes()

string bucket_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for bucketId.

getCors(int index)

public abstract Bucket.Cors getCors(int index)

The bucket's https://www.w3.org/TR/cors/ (CORS) config.

repeated .google.storage.v2.Bucket.Cors cors = 12;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Bucket.Cors

getCorsCount()

public abstract int getCorsCount()

The bucket's https://www.w3.org/TR/cors/ (CORS) config.

repeated .google.storage.v2.Bucket.Cors cors = 12;

Returns

Type	Description
int

getCorsList()

public abstract List<Bucket.Cors> getCorsList()

The bucket's https://www.w3.org/TR/cors/ (CORS) config.

repeated .google.storage.v2.Bucket.Cors cors = 12;

Returns

Type	Description
List<Cors>

getCorsOrBuilder(int index)

public abstract Bucket.CorsOrBuilder getCorsOrBuilder(int index)

The bucket's https://www.w3.org/TR/cors/ (CORS) config.

repeated .google.storage.v2.Bucket.Cors cors = 12;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Bucket.CorsOrBuilder

getCorsOrBuilderList()

public abstract List<? extends Bucket.CorsOrBuilder> getCorsOrBuilderList()

The bucket's https://www.w3.org/TR/cors/ (CORS) config.

repeated .google.storage.v2.Bucket.Cors cors = 12;

Returns

Type	Description
List<? extends com.google.storage.v2.Bucket.CorsOrBuilder>

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time of the bucket in https://tools.ietf.org/html/rfc3339 format. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the bucket in https://tools.ietf.org/html/rfc3339 format. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getDefaultEventBasedHold()

public abstract boolean getDefaultEventBasedHold()

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.

bool default_event_based_hold = 14;

Returns

Type	Description
boolean	The defaultEventBasedHold.

getDefaultObjectAcl(int index)

public abstract ObjectAccessControl getDefaultObjectAcl(int index)

Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ObjectAccessControl

getDefaultObjectAclCount()

public abstract int getDefaultObjectAclCount()

Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;

Returns

Type	Description
int

getDefaultObjectAclList()

public abstract List<ObjectAccessControl> getDefaultObjectAclList()

Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;

Returns

Type	Description
List<ObjectAccessControl>

getDefaultObjectAclOrBuilder(int index)

public abstract ObjectAccessControlOrBuilder getDefaultObjectAclOrBuilder(int index)

Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;

Parameter

Name	Description
index	`int`

Returns

Type	Description
ObjectAccessControlOrBuilder

getDefaultObjectAclOrBuilderList()

public abstract List<? extends ObjectAccessControlOrBuilder> getDefaultObjectAclOrBuilderList()

Default access controls to apply to new objects when no ACL is provided. If iamConfig.uniformBucketLevelAccess is enabled on this bucket, requests to set, read, or modify acl is an error.

repeated .google.storage.v2.ObjectAccessControl default_object_acl = 9;

Returns

Type	Description
List<? extends com.google.storage.v2.ObjectAccessControlOrBuilder>

getEncryption()

public abstract Bucket.Encryption getEncryption()

Encryption config for a bucket.

.google.storage.v2.Bucket.Encryption encryption = 20;

Returns

Type	Description
Bucket.Encryption	The encryption.

getEncryptionOrBuilder()

public abstract Bucket.EncryptionOrBuilder getEncryptionOrBuilder()

Encryption config for a bucket.

.google.storage.v2.Bucket.Encryption encryption = 20;

Returns

Type	Description
Bucket.EncryptionOrBuilder

getIamConfig()

public abstract Bucket.IamConfig getIamConfig()

The bucket's IAM config.

.google.storage.v2.Bucket.IamConfig iam_config = 23;

Returns

Type	Description
Bucket.IamConfig	The iamConfig.

getIamConfigOrBuilder()

public abstract Bucket.IamConfigOrBuilder getIamConfigOrBuilder()

The bucket's IAM config.

.google.storage.v2.Bucket.IamConfig iam_config = 23;

Returns

Type	Description
Bucket.IamConfigOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Returns

Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getLifecycle()

public abstract Bucket.Lifecycle getLifecycle()

The bucket's lifecycle config. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.

.google.storage.v2.Bucket.Lifecycle lifecycle = 10;

Returns

Type	Description
Bucket.Lifecycle	The lifecycle.

getLifecycleOrBuilder()

public abstract Bucket.LifecycleOrBuilder getLifecycleOrBuilder()

The bucket's lifecycle config. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.

.google.storage.v2.Bucket.Lifecycle lifecycle = 10;

Returns

Type	Description
Bucket.LifecycleOrBuilder

getLocation()

public abstract String getLocation()

Immutable. The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the https://developers.google.com/storage/docs/concepts-techniques#specifyinglocations" for the authoritative list. Attempting to update this field after the bucket is created will result in an error.

string location = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

string location = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for location.

getLocationType()

public abstract String getLocationType()

Output only. The location type of the bucket (region, dual-region, multi-region, etc).

string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The locationType.

getLocationTypeBytes()

public abstract ByteString getLocationTypeBytes()

Output only. The location type of the bucket (region, dual-region, multi-region, etc).

string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for locationType.

getLogging()

public abstract Bucket.Logging getLogging()

The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.

.google.storage.v2.Bucket.Logging logging = 18;

Returns

Type	Description
Bucket.Logging	The logging.

getLoggingOrBuilder()

public abstract Bucket.LoggingOrBuilder getLoggingOrBuilder()

The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.

.google.storage.v2.Bucket.Logging logging = 18;

Returns

Type	Description
Bucket.LoggingOrBuilder

getMetageneration()

public abstract long getMetageneration()

Output only. The metadata generation of this bucket. Attempting to set or update this field will result in a FieldViolation.

int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
long	The metageneration.

getName()

public abstract String getName()

Immutable. The name of the bucket.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. The name of the bucket.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for name.

getOwner()

public abstract Owner getOwner()

Output only. The owner of the bucket. This is always the project team's owner group.

.google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Owner	The owner.

getOwnerOrBuilder()

public abstract OwnerOrBuilder getOwnerOrBuilder()

Output only. The owner of the bucket. This is always the project team's owner group.

.google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
OwnerOrBuilder

getProject()

public abstract String getProject()

Immutable. The project which owns this bucket.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The project.

getProjectBytes()

public abstract ByteString getProjectBytes()

Immutable. The project which owns this bucket.

string project = 3 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for project.

getRetentionPolicy()

public abstract Bucket.RetentionPolicy getRetentionPolicy()

The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.

.google.storage.v2.Bucket.RetentionPolicy retention_policy = 22;

Returns

Type	Description
Bucket.RetentionPolicy	The retentionPolicy.

getRetentionPolicyOrBuilder()

public abstract Bucket.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()

.google.storage.v2.Bucket.RetentionPolicy retention_policy = 22;

Returns

Type	Description
Bucket.RetentionPolicyOrBuilder

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

Reserved for future use.

bool satisfies_pzs = 25;

Returns

Type	Description
boolean	The satisfiesPzs.

getStorageClass()

public abstract String getStorageClass()

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see https://developers.google.com/storage/docs/storage-classes.

string storage_class = 7;

Returns

Type	Description
String	The storageClass.

getStorageClassBytes()

public abstract ByteString getStorageClassBytes()

string storage_class = 7;

Returns

Type	Description
ByteString	The bytes for storageClass.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The modification time of the bucket. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The modification time of the bucket. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getVersioning()

public abstract Bucket.Versioning getVersioning()

The bucket's versioning config.

.google.storage.v2.Bucket.Versioning versioning = 17;

Returns

Type	Description
Bucket.Versioning	The versioning.

getVersioningOrBuilder()

public abstract Bucket.VersioningOrBuilder getVersioningOrBuilder()

The bucket's versioning config.

.google.storage.v2.Bucket.Versioning versioning = 17;

Returns

Type	Description
Bucket.VersioningOrBuilder

getWebsite()

public abstract Bucket.Website getWebsite()

The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site. See the https://cloud.google.com/storage/docs/static-website for more information.

.google.storage.v2.Bucket.Website website = 16;

Returns

Type	Description
Bucket.Website	The website.

getWebsiteOrBuilder()

public abstract Bucket.WebsiteOrBuilder getWebsiteOrBuilder()

The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site. See the https://cloud.google.com/storage/docs/static-website for more information.

.google.storage.v2.Bucket.Website website = 16;

Returns

Type	Description
Bucket.WebsiteOrBuilder

getZoneAffinity(int index)

public abstract String getZoneAffinity(int index)

Immutable. The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The values are case-insensitive. Attempting to update this field after bucket is created will result in an error.

repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
index	`int` The index of the element to return.

Returns

Type	Description
String	The zoneAffinity at the given index.

getZoneAffinityBytes(int index)

public abstract ByteString getZoneAffinityBytes(int index)

repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
index	`int` The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the zoneAffinity at the given index.

getZoneAffinityCount()

public abstract int getZoneAffinityCount()

repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
int	The count of zoneAffinity.

getZoneAffinityList()

public abstract List<String> getZoneAffinityList()

repeated string zone_affinity = 24 [deprecated = true, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
List<String>	A list containing the zoneAffinity.

hasBilling()

public abstract boolean hasBilling()

The bucket's billing config.

.google.storage.v2.Bucket.Billing billing = 21;

Returns

Type	Description
boolean	Whether the billing field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time of the bucket in https://tools.ietf.org/html/rfc3339 format. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the createTime field is set.

hasEncryption()

public abstract boolean hasEncryption()

Encryption config for a bucket.

.google.storage.v2.Bucket.Encryption encryption = 20;

Returns

Type	Description
boolean	Whether the encryption field is set.

hasIamConfig()

public abstract boolean hasIamConfig()

The bucket's IAM config.

.google.storage.v2.Bucket.IamConfig iam_config = 23;

Returns

Type	Description
boolean	Whether the iamConfig field is set.

hasLifecycle()

public abstract boolean hasLifecycle()

The bucket's lifecycle config. See [https://developers.google.com/storage/docs/lifecycle]Lifecycle Management] for more information.

.google.storage.v2.Bucket.Lifecycle lifecycle = 10;

Returns

Type	Description
boolean	Whether the lifecycle field is set.

hasLogging()

public abstract boolean hasLogging()

The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.

.google.storage.v2.Bucket.Logging logging = 18;

Returns

Type	Description
boolean	Whether the logging field is set.

hasOwner()

public abstract boolean hasOwner()

Output only. The owner of the bucket. This is always the project team's owner group.

.google.storage.v2.Owner owner = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the owner field is set.

hasRetentionPolicy()

public abstract boolean hasRetentionPolicy()

.google.storage.v2.Bucket.RetentionPolicy retention_policy = 22;

Returns

Type	Description
boolean	Whether the retentionPolicy field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The modification time of the bucket. Attempting to set or update this field will result in a FieldViolation.

.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the updateTime field is set.

hasVersioning()

public abstract boolean hasVersioning()

The bucket's versioning config.

.google.storage.v2.Bucket.Versioning versioning = 17;

Returns

Type	Description
boolean	Whether the versioning field is set.

hasWebsite()

public abstract boolean hasWebsite()

The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site. See the https://cloud.google.com/storage/docs/static-website for more information.

.google.storage.v2.Bucket.Website website = 16;

Returns

Type	Description
boolean	Whether the website field is set.