Class Bucket.Builder (2.30.1) 

public static final class Bucket.Builder extends GeneratedMessageV3.Builder<Bucket.Builder> implements BucketOrBuilder

A bucket.

Protobuf type google.storage.v2.Bucket

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Bucket.Builder

Implements

BucketOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAcl(BucketAccessControl value)

public Bucket.Builder addAcl(BucketAccessControl value)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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
value BucketAccessControl
Returns
Type Description
Bucket.Builder

addAcl(BucketAccessControl.Builder builderForValue)

public Bucket.Builder addAcl(BucketAccessControl.Builder builderForValue)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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
builderForValue BucketAccessControl.Builder
Returns
Type Description
Bucket.Builder

addAcl(int index, BucketAccessControl value)

public Bucket.Builder addAcl(int index, BucketAccessControl value)

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

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

Parameters
Name Description
index int
value BucketAccessControl
Returns
Type Description
Bucket.Builder

addAcl(int index, BucketAccessControl.Builder builderForValue)

public Bucket.Builder addAcl(int index, BucketAccessControl.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue BucketAccessControl.Builder
Returns
Type Description
Bucket.Builder

addAclBuilder()

public BucketAccessControl.Builder addAclBuilder()

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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
BucketAccessControl.Builder

addAclBuilder(int index)

public BucketAccessControl.Builder addAclBuilder(int index)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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.Builder

addAllAcl(Iterable<? extends BucketAccessControl> values)

public Bucket.Builder addAllAcl(Iterable<? extends BucketAccessControl> values)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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
values Iterable<? extends com.google.storage.v2.BucketAccessControl>
Returns
Type Description
Bucket.Builder

addAllCors(Iterable<? extends Bucket.Cors> values)

public Bucket.Builder addAllCors(Iterable<? extends Bucket.Cors> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.storage.v2.Bucket.Cors>
Returns
Type Description
Bucket.Builder

addAllDefaultObjectAcl(Iterable<? extends ObjectAccessControl> values)

public Bucket.Builder addAllDefaultObjectAcl(Iterable<? extends ObjectAccessControl> values)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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
values Iterable<? extends com.google.storage.v2.ObjectAccessControl>
Returns
Type Description
Bucket.Builder

addCors(Bucket.Cors value)

public Bucket.Builder addCors(Bucket.Cors value)

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

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

Parameter
Name Description
value Bucket.Cors
Returns
Type Description
Bucket.Builder

addCors(Bucket.Cors.Builder builderForValue)

public Bucket.Builder addCors(Bucket.Cors.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Bucket.Cors.Builder
Returns
Type Description
Bucket.Builder

addCors(int index, Bucket.Cors value)

public Bucket.Builder addCors(int index, Bucket.Cors value)

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

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

Parameters
Name Description
index int
value Bucket.Cors
Returns
Type Description
Bucket.Builder

addCors(int index, Bucket.Cors.Builder builderForValue)

public Bucket.Builder addCors(int index, Bucket.Cors.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Bucket.Cors.Builder
Returns
Type Description
Bucket.Builder

addCorsBuilder()

public Bucket.Cors.Builder addCorsBuilder()

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

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

Returns
Type Description
Bucket.Cors.Builder

addCorsBuilder(int index)

public Bucket.Cors.Builder addCorsBuilder(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.Builder

addDefaultObjectAcl(ObjectAccessControl value)

public Bucket.Builder addDefaultObjectAcl(ObjectAccessControl value)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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
value ObjectAccessControl
Returns
Type Description
Bucket.Builder

addDefaultObjectAcl(ObjectAccessControl.Builder builderForValue)

public Bucket.Builder addDefaultObjectAcl(ObjectAccessControl.Builder builderForValue)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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
builderForValue ObjectAccessControl.Builder
Returns
Type Description
Bucket.Builder

addDefaultObjectAcl(int index, ObjectAccessControl value)

public Bucket.Builder addDefaultObjectAcl(int index, ObjectAccessControl value)

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

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

Parameters
Name Description
index int
value ObjectAccessControl
Returns
Type Description
Bucket.Builder

addDefaultObjectAcl(int index, ObjectAccessControl.Builder builderForValue)

public Bucket.Builder addDefaultObjectAcl(int index, ObjectAccessControl.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue ObjectAccessControl.Builder
Returns
Type Description
Bucket.Builder

addDefaultObjectAclBuilder()

public ObjectAccessControl.Builder addDefaultObjectAclBuilder()

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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
ObjectAccessControl.Builder

addDefaultObjectAclBuilder(int index)

public ObjectAccessControl.Builder addDefaultObjectAclBuilder(int index)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Bucket.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Bucket.Builder
Overrides

build()

public Bucket build()
Returns
Type Description
Bucket

buildPartial()

public Bucket buildPartial()
Returns
Type Description
Bucket

clear()

public Bucket.Builder clear()
Returns
Type Description
Bucket.Builder
Overrides

clearAcl()

public Bucket.Builder clearAcl()

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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
Bucket.Builder

clearAutoclass()

public Bucket.Builder clearAutoclass()

The bucket's Autoclass configuration. If there is no configuration, the Autoclass feature will be disabled and have no effect on the bucket.

.google.storage.v2.Bucket.Autoclass autoclass = 28;

Returns
Type Description
Bucket.Builder

clearBilling()

public Bucket.Builder clearBilling()

The bucket's billing config.

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

Returns
Type Description
Bucket.Builder

clearBucketId()

public Bucket.Builder clearBucketId()

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

This builder for chaining.

clearCors()

public Bucket.Builder clearCors()

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

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

Returns
Type Description
Bucket.Builder

clearCreateTime()

public Bucket.Builder clearCreateTime()

Output only. The creation time of the bucket.

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

Returns
Type Description
Bucket.Builder

clearCustomPlacementConfig()

public Bucket.Builder clearCustomPlacementConfig()

Configuration that, if present, specifies the data placement for a https://cloud.google.com/storage/docs/use-dual-regions.

.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;

Returns
Type Description
Bucket.Builder

clearDefaultEventBasedHold()

public Bucket.Builder clearDefaultEventBasedHold()

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

This builder for chaining.

clearDefaultObjectAcl()

public Bucket.Builder clearDefaultObjectAcl()

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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
Bucket.Builder

clearEncryption()

public Bucket.Builder clearEncryption()

Encryption config for a bucket.

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

Returns
Type Description
Bucket.Builder

clearEtag()

public Bucket.Builder clearEtag()

The etag of the bucket. If included in the metadata of an UpdateBucketRequest, the operation will only be performed if the etag matches that of the bucket.

string etag = 29;

Returns
Type Description
Bucket.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Bucket.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Bucket.Builder
Overrides

clearIamConfig()

public Bucket.Builder clearIamConfig()

The bucket's IAM config.

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

Returns
Type Description
Bucket.Builder

clearLabels()

public Bucket.Builder clearLabels()
Returns
Type Description
Bucket.Builder

clearLifecycle()

public Bucket.Builder clearLifecycle()

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

clearLocation()

public Bucket.Builder clearLocation()

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

This builder for chaining.

clearLocationType()

public Bucket.Builder clearLocationType()

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

This builder for chaining.

clearLogging()

public Bucket.Builder clearLogging()

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

clearMetageneration()

public Bucket.Builder clearMetageneration()

Output only. The metadata generation of this bucket.

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

Returns
Type Description
Bucket.Builder

This builder for chaining.

clearName()

public Bucket.Builder clearName()

Immutable. The name of the bucket. Format: projects/{project}/buckets/{bucket}

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

Returns
Type Description
Bucket.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Bucket.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Bucket.Builder
Overrides

clearOwner()

public Bucket.Builder clearOwner()

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

clearProject()

public Bucket.Builder clearProject()

Immutable. The project which owns this bucket, in the format of "projects/{projectIdentifier}". {projectIdentifier} can be the project ID or project number.

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

Returns
Type Description
Bucket.Builder

This builder for chaining.

clearRetentionPolicy()

public Bucket.Builder clearRetentionPolicy()

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

clearRpo()

public Bucket.Builder clearRpo()

The recovery point objective for cross-region replication of the bucket. Applicable only for dual- and multi-region buckets. "DEFAULT" uses default replication. "ASYNC_TURBO" enables turbo replication, valid for dual-region buckets only. If rpo is not specified when the bucket is created, it defaults to "DEFAULT". For more information, see https://cloud.google.com/storage/docs/availability-durability#turbo-replication.

string rpo = 27;

Returns
Type Description
Bucket.Builder

This builder for chaining.

clearSatisfiesPzs()

public Bucket.Builder clearSatisfiesPzs()

Reserved for future use.

bool satisfies_pzs = 25;

Returns
Type Description
Bucket.Builder

This builder for chaining.

clearSoftDeletePolicy()

public Bucket.Builder clearSoftDeletePolicy()

Optional. The bucket's soft delete policy. The soft delete policy prevents soft-deleted objects from being permanently deleted.

.google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Builder

clearStorageClass()

public Bucket.Builder clearStorageClass()

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

This builder for chaining.

clearUpdateTime()

public Bucket.Builder clearUpdateTime()

Output only. The modification time of the bucket.

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

Returns
Type Description
Bucket.Builder

clearVersioning()

public Bucket.Builder clearVersioning()

The bucket's versioning config.

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

Returns
Type Description
Bucket.Builder

clearWebsite()

public Bucket.Builder clearWebsite()

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

clone()

public Bucket.Builder clone()
Returns
Type Description
Bucket.Builder
Overrides

containsLabels(String key)

public 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 BucketAccessControl getAcl(int index)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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

getAclBuilder(int index)

public BucketAccessControl.Builder getAclBuilder(int index)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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.Builder

getAclBuilderList()

public List<BucketAccessControl.Builder> getAclBuilderList()

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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<Builder>

getAclCount()

public int getAclCount()

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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 List<BucketAccessControl> getAclList()

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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 BucketAccessControlOrBuilder getAclOrBuilder(int index)

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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 List<? extends BucketAccessControlOrBuilder> getAclOrBuilderList()

Access controls on the bucket. If iam_config.uniform_bucket_level_access 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>

getAutoclass()

public Bucket.Autoclass getAutoclass()

The bucket's Autoclass configuration. If there is no configuration, the Autoclass feature will be disabled and have no effect on the bucket.

.google.storage.v2.Bucket.Autoclass autoclass = 28;

Returns
Type Description
Bucket.Autoclass

The autoclass.

getAutoclassBuilder()

public Bucket.Autoclass.Builder getAutoclassBuilder()

The bucket's Autoclass configuration. If there is no configuration, the Autoclass feature will be disabled and have no effect on the bucket.

.google.storage.v2.Bucket.Autoclass autoclass = 28;

Returns
Type Description
Bucket.Autoclass.Builder

getAutoclassOrBuilder()

public Bucket.AutoclassOrBuilder getAutoclassOrBuilder()

The bucket's Autoclass configuration. If there is no configuration, the Autoclass feature will be disabled and have no effect on the bucket.

.google.storage.v2.Bucket.Autoclass autoclass = 28;

Returns
Type Description
Bucket.AutoclassOrBuilder

getBilling()

public Bucket.Billing getBilling()

The bucket's billing config.

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

Returns
Type Description
Bucket.Billing

The billing.

getBillingBuilder()

public Bucket.Billing.Builder getBillingBuilder()

The bucket's billing config.

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

Returns
Type Description
Bucket.Billing.Builder

getBillingOrBuilder()

public Bucket.BillingOrBuilder getBillingOrBuilder()

The bucket's billing config.

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

Returns
Type Description
Bucket.BillingOrBuilder

getBucketId()

public 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 ByteString getBucketIdBytes()

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
ByteString

The bytes for bucketId.

getCors(int index)

public 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

getCorsBuilder(int index)

public Bucket.Cors.Builder getCorsBuilder(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.Builder

getCorsBuilderList()

public List<Bucket.Cors.Builder> getCorsBuilderList()

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

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

Returns
Type Description
List<Builder>

getCorsCount()

public 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 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 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 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 Timestamp getCreateTime()

Output only. The creation time of the bucket.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time of the bucket.

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

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the bucket.

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

Returns
Type Description
TimestampOrBuilder

getCustomPlacementConfig()

public Bucket.CustomPlacementConfig getCustomPlacementConfig()

Configuration that, if present, specifies the data placement for a https://cloud.google.com/storage/docs/use-dual-regions.

.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;

Returns
Type Description
Bucket.CustomPlacementConfig

The customPlacementConfig.

getCustomPlacementConfigBuilder()

public Bucket.CustomPlacementConfig.Builder getCustomPlacementConfigBuilder()

Configuration that, if present, specifies the data placement for a https://cloud.google.com/storage/docs/use-dual-regions.

.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;

Returns
Type Description
Bucket.CustomPlacementConfig.Builder

getCustomPlacementConfigOrBuilder()

public Bucket.CustomPlacementConfigOrBuilder getCustomPlacementConfigOrBuilder()

Configuration that, if present, specifies the data placement for a https://cloud.google.com/storage/docs/use-dual-regions.

.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;

Returns
Type Description
Bucket.CustomPlacementConfigOrBuilder

getDefaultEventBasedHold()

public 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.

getDefaultInstanceForType()

public Bucket getDefaultInstanceForType()
Returns
Type Description
Bucket

getDefaultObjectAcl(int index)

public ObjectAccessControl getDefaultObjectAcl(int index)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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

getDefaultObjectAclBuilder(int index)

public ObjectAccessControl.Builder getDefaultObjectAclBuilder(int index)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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.Builder

getDefaultObjectAclBuilderList()

public List<ObjectAccessControl.Builder> getDefaultObjectAclBuilderList()

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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<Builder>

getDefaultObjectAclCount()

public int getDefaultObjectAclCount()

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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 List<ObjectAccessControl> getDefaultObjectAclList()

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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 ObjectAccessControlOrBuilder getDefaultObjectAclOrBuilder(int index)

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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 List<? extends ObjectAccessControlOrBuilder> getDefaultObjectAclOrBuilderList()

Default access controls to apply to new objects when no ACL is provided. If iam_config.uniform_bucket_level_access 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>

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEncryption()

public Bucket.Encryption getEncryption()

Encryption config for a bucket.

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

Returns
Type Description
Bucket.Encryption

The encryption.

getEncryptionBuilder()

public Bucket.Encryption.Builder getEncryptionBuilder()

Encryption config for a bucket.

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

Returns
Type Description
Bucket.Encryption.Builder

getEncryptionOrBuilder()

public Bucket.EncryptionOrBuilder getEncryptionOrBuilder()

Encryption config for a bucket.

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

Returns
Type Description
Bucket.EncryptionOrBuilder

getEtag()

public String getEtag()

The etag of the bucket. If included in the metadata of an UpdateBucketRequest, the operation will only be performed if the etag matches that of the bucket.

string etag = 29;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

The etag of the bucket. If included in the metadata of an UpdateBucketRequest, the operation will only be performed if the etag matches that of the bucket.

string etag = 29;

Returns
Type Description
ByteString

The bytes for etag.

getIamConfig()

public Bucket.IamConfig getIamConfig()

The bucket's IAM config.

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

Returns
Type Description
Bucket.IamConfig

The iamConfig.

getIamConfigBuilder()

public Bucket.IamConfig.Builder getIamConfigBuilder()

The bucket's IAM config.

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

Returns
Type Description
Bucket.IamConfig.Builder

getIamConfigOrBuilder()

public Bucket.IamConfigOrBuilder getIamConfigOrBuilder()

The bucket's IAM config.

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

Returns
Type Description
Bucket.IamConfigOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Returns
Type Description
Map<