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.BuilderImplements
BucketOrBuilderInherited Members
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 |
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 |
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. 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 |
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 |
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. Attempting to set or update this field will result in a FieldViolation.
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 |
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/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. |
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. 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 |
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 |
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;
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;
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;
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. 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The creation time of the bucket. 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 |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time of the bucket. 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 |
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;
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 |
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.
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;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public 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 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. |
getLifecycleBuilder()
public Bucket.Lifecycle.Builder getLifecycleBuilder()
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.Builder |
getLifecycleOrBuilder()
public 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 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 ByteString getLocationBytes()
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 |
ByteString |
The bytes for location. |
getLocationType()
public 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 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 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. |
getLoggingBuilder()
public Bucket.Logging.Builder getLoggingBuilder()
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.Builder |
getLoggingOrBuilder()
public 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 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. |
getMutableLabels()
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
getName()
public String getName()
Immutable. The name of the bucket.
Format: projects/{project}/buckets/{bucket}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Immutable. The name of the bucket.
Format: projects/{project}/buckets/{bucket}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getOwner()
public 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. |
getOwnerBuilder()
public Owner.Builder getOwnerBuilder()
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.Builder |
getOwnerOrBuilder()
public 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 String getProject()
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 |
String |
The project. |
getProjectBytes()
public ByteString getProjectBytes()
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 |
ByteString |
The bytes for project. |
getRetentionPolicy()
public 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. |
getRetentionPolicyBuilder()
public Bucket.RetentionPolicy.Builder getRetentionPolicyBuilder()
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.Builder |
getRetentionPolicyOrBuilder()
public Bucket.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()
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.RetentionPolicyOrBuilder |
getRpo()
public String getRpo()
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/turbo-replication.
string rpo = 27;
Returns | |
---|---|
Type | Description |
String |
The rpo. |
getRpoBytes()
public ByteString getRpoBytes()
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/turbo-replication.
string rpo = 27;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for rpo. |
getSatisfiesPzs()
public boolean getSatisfiesPzs()
Reserved for future use.
bool satisfies_pzs = 25;
Returns | |
---|---|
Type | Description |
boolean |
The satisfiesPzs. |
getStorageClass()
public 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 ByteString getStorageClassBytes()
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 |
ByteString |
The bytes for storageClass. |
getUpdateTime()
public 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
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 |
Builder |
getUpdateTimeOrBuilder()
public 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 Bucket.Versioning getVersioning()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
Returns | |
---|---|
Type | Description |
Bucket.Versioning |
The versioning. |
getVersioningBuilder()
public Bucket.Versioning.Builder getVersioningBuilder()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
Returns | |
---|---|
Type | Description |
Bucket.Versioning.Builder |
getVersioningOrBuilder()
public Bucket.VersioningOrBuilder getVersioningOrBuilder()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
Returns | |
---|---|
Type | Description |
Bucket.VersioningOrBuilder |
getWebsite()
public 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. |
getWebsiteBuilder()
public Bucket.Website.Builder getWebsiteBuilder()
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.Builder |
getWebsiteOrBuilder()
public 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 |
hasAutoclass()
public boolean hasAutoclass()
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 |
boolean |
Whether the autoclass field is set. |
hasBilling()
public 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 boolean hasCreateTime()
Output only. The creation time of the bucket. 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. |
hasCustomPlacementConfig()
public boolean hasCustomPlacementConfig()
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 |
boolean |
Whether the customPlacementConfig field is set. |
hasEncryption()
public 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 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 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 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 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 boolean hasRetentionPolicy()
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 |
boolean |
Whether the retentionPolicy field is set. |
hasUpdateTime()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeAutoclass(Bucket.Autoclass value)
public Bucket.Builder mergeAutoclass(Bucket.Autoclass value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Autoclass |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeBilling(Bucket.Billing value)
public Bucket.Builder mergeBilling(Bucket.Billing value)
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Billing |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeCreateTime(Timestamp value)
public Bucket.Builder mergeCreateTime(Timestamp value)
Output only. The creation time of the bucket. Attempting to set or update this field will result in a FieldViolation.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeCustomPlacementConfig(Bucket.CustomPlacementConfig value)
public Bucket.Builder mergeCustomPlacementConfig(Bucket.CustomPlacementConfig value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.CustomPlacementConfig |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeEncryption(Bucket.Encryption value)
public Bucket.Builder mergeEncryption(Bucket.Encryption value)
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Encryption |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Bucket.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Bucket.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeFrom(Bucket other)
public Bucket.Builder mergeFrom(Bucket other)
Parameter | |
---|---|
Name | Description |
other |
Bucket |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeIamConfig(Bucket.IamConfig value)
public Bucket.Builder mergeIamConfig(Bucket.IamConfig value)
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
Parameter | |
---|---|
Name | Description |
value |
Bucket.IamConfig |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeLifecycle(Bucket.Lifecycle value)
public Bucket.Builder mergeLifecycle(Bucket.Lifecycle value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Lifecycle |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeLogging(Bucket.Logging value)
public Bucket.Builder mergeLogging(Bucket.Logging value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Logging |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeOwner(Owner value)
public Bucket.Builder mergeOwner(Owner value)
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];
Parameter | |
---|---|
Name | Description |
value |
Owner |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeRetentionPolicy(Bucket.RetentionPolicy value)
public Bucket.Builder mergeRetentionPolicy(Bucket.RetentionPolicy value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.RetentionPolicy |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Bucket.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeUpdateTime(Timestamp value)
public Bucket.Builder mergeUpdateTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeVersioning(Bucket.Versioning value)
public Bucket.Builder mergeVersioning(Bucket.Versioning value)
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Versioning |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
mergeWebsite(Bucket.Website value)
public Bucket.Builder mergeWebsite(Bucket.Website value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Website |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
putAllLabels(Map<String,String> values)
public Bucket.Builder putAllLabels(Map<String,String> values)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
Returns | |
---|---|
Type | Description |
Bucket.Builder |
putLabels(String key, String value)
public Bucket.Builder putLabels(String key, String value)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
Returns | |
---|---|
Type | Description |
Bucket.Builder |
removeAcl(int index)
public Bucket.Builder removeAcl(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 |
Bucket.Builder |
removeCors(int index)
public Bucket.Builder removeCors(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.Builder |
removeDefaultObjectAcl(int index)
public Bucket.Builder removeDefaultObjectAcl(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 |
Bucket.Builder |
removeLabels(String key)
public Bucket.Builder removeLabels(String key)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setAcl(int index, BucketAccessControl value)
public Bucket.Builder setAcl(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 |
setAcl(int index, BucketAccessControl.Builder builderForValue)
public Bucket.Builder setAcl(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 |
setAutoclass(Bucket.Autoclass value)
public Bucket.Builder setAutoclass(Bucket.Autoclass value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Autoclass |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setAutoclass(Bucket.Autoclass.Builder builderForValue)
public Bucket.Builder setAutoclass(Bucket.Autoclass.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Autoclass.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setBilling(Bucket.Billing value)
public Bucket.Builder setBilling(Bucket.Billing value)
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Billing |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setBilling(Bucket.Billing.Builder builderForValue)
public Bucket.Builder setBilling(Bucket.Billing.Builder builderForValue)
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Billing.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setBucketId(String value)
public Bucket.Builder setBucketId(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The bucketId to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setBucketIdBytes(ByteString value)
public Bucket.Builder setBucketIdBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for bucketId to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setCors(int index, Bucket.Cors value)
public Bucket.Builder setCors(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 |
setCors(int index, Bucket.Cors.Builder builderForValue)
public Bucket.Builder setCors(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 |
setCreateTime(Timestamp value)
public Bucket.Builder setCreateTime(Timestamp value)
Output only. The creation time of the bucket. Attempting to set or update this field will result in a FieldViolation.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Bucket.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The creation time of the bucket. Attempting to set or update this field will result in a FieldViolation.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setCustomPlacementConfig(Bucket.CustomPlacementConfig value)
public Bucket.Builder setCustomPlacementConfig(Bucket.CustomPlacementConfig value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.CustomPlacementConfig |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setCustomPlacementConfig(Bucket.CustomPlacementConfig.Builder builderForValue)
public Bucket.Builder setCustomPlacementConfig(Bucket.CustomPlacementConfig.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.CustomPlacementConfig.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setDefaultEventBasedHold(boolean value)
public Bucket.Builder setDefaultEventBasedHold(boolean value)
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;
Parameter | |
---|---|
Name | Description |
value |
boolean The defaultEventBasedHold to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setDefaultObjectAcl(int index, ObjectAccessControl value)
public Bucket.Builder setDefaultObjectAcl(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 |
setDefaultObjectAcl(int index, ObjectAccessControl.Builder builderForValue)
public Bucket.Builder setDefaultObjectAcl(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 |
setEncryption(Bucket.Encryption value)
public Bucket.Builder setEncryption(Bucket.Encryption value)
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Encryption |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setEncryption(Bucket.Encryption.Builder builderForValue)
public Bucket.Builder setEncryption(Bucket.Encryption.Builder builderForValue)
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Encryption.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setEtag(String value)
public Bucket.Builder setEtag(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The etag to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setEtagBytes(ByteString value)
public Bucket.Builder setEtagBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Bucket.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setIamConfig(Bucket.IamConfig value)
public Bucket.Builder setIamConfig(Bucket.IamConfig value)
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
Parameter | |
---|---|
Name | Description |
value |
Bucket.IamConfig |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setIamConfig(Bucket.IamConfig.Builder builderForValue)
public Bucket.Builder setIamConfig(Bucket.IamConfig.Builder builderForValue)
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.IamConfig.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setLifecycle(Bucket.Lifecycle value)
public Bucket.Builder setLifecycle(Bucket.Lifecycle value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Lifecycle |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setLifecycle(Bucket.Lifecycle.Builder builderForValue)
public Bucket.Builder setLifecycle(Bucket.Lifecycle.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Lifecycle.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setLocation(String value)
public Bucket.Builder setLocation(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The location to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setLocationBytes(ByteString value)
public Bucket.Builder setLocationBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for location to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setLocationType(String value)
public Bucket.Builder setLocationType(String value)
Output only. The location type of the bucket (region, dual-region, multi-region, etc).
string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The locationType to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setLocationTypeBytes(ByteString value)
public Bucket.Builder setLocationTypeBytes(ByteString value)
Output only. The location type of the bucket (region, dual-region, multi-region, etc).
string location_type = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for locationType to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setLogging(Bucket.Logging value)
public Bucket.Builder setLogging(Bucket.Logging value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Logging |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setLogging(Bucket.Logging.Builder builderForValue)
public Bucket.Builder setLogging(Bucket.Logging.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Logging.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setMetageneration(long value)
public Bucket.Builder setMetageneration(long value)
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];
Parameter | |
---|---|
Name | Description |
value |
long The metageneration to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setName(String value)
public Bucket.Builder setName(String value)
Immutable. The name of the bucket.
Format: projects/{project}/buckets/{bucket}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Bucket.Builder setNameBytes(ByteString value)
Immutable. The name of the bucket.
Format: projects/{project}/buckets/{bucket}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setOwner(Owner value)
public Bucket.Builder setOwner(Owner value)
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];
Parameter | |
---|---|
Name | Description |
value |
Owner |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setOwner(Owner.Builder builderForValue)
public Bucket.Builder setOwner(Owner.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Owner.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setProject(String value)
public Bucket.Builder setProject(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The project to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setProjectBytes(ByteString value)
public Bucket.Builder setProjectBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for project to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Bucket.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setRetentionPolicy(Bucket.RetentionPolicy value)
public Bucket.Builder setRetentionPolicy(Bucket.RetentionPolicy value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.RetentionPolicy |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setRetentionPolicy(Bucket.RetentionPolicy.Builder builderForValue)
public Bucket.Builder setRetentionPolicy(Bucket.RetentionPolicy.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.RetentionPolicy.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setRpo(String value)
public Bucket.Builder setRpo(String value)
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/turbo-replication.
string rpo = 27;
Parameter | |
---|---|
Name | Description |
value |
String The rpo to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setRpoBytes(ByteString value)
public Bucket.Builder setRpoBytes(ByteString value)
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/turbo-replication.
string rpo = 27;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for rpo to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setSatisfiesPzs(boolean value)
public Bucket.Builder setSatisfiesPzs(boolean value)
Reserved for future use.
bool satisfies_pzs = 25;
Parameter | |
---|---|
Name | Description |
value |
boolean The satisfiesPzs to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setStorageClass(String value)
public Bucket.Builder setStorageClass(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The storageClass to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setStorageClassBytes(ByteString value)
public Bucket.Builder setStorageClassBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for storageClass to set. |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Bucket.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setUpdateTime(Timestamp value)
public Bucket.Builder setUpdateTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Bucket.Builder setUpdateTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setVersioning(Bucket.Versioning value)
public Bucket.Builder setVersioning(Bucket.Versioning value)
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Versioning |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setVersioning(Bucket.Versioning.Builder builderForValue)
public Bucket.Builder setVersioning(Bucket.Versioning.Builder builderForValue)
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Versioning.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setWebsite(Bucket.Website value)
public Bucket.Builder setWebsite(Bucket.Website value)
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;
Parameter | |
---|---|
Name | Description |
value |
Bucket.Website |
Returns | |
---|---|
Type | Description |
Bucket.Builder |
setWebsite(Bucket.Website.Builder builderForValue)
public Bucket.Builder setWebsite(Bucket.Website.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Bucket.Website.Builder |
Returns | |
---|---|
Type | Description |
Bucket.Builder |