public final class Bucket extends com.google.protobuf.GeneratedMessageV3 implements BucketOrBuilder
A bucket.Protobuf type
google.storage.v2.Bucket
Modifier and Type | Class and Description |
---|---|
static class |
Bucket.Autoclass
Configuration for a bucket's Autoclass feature.
|
static interface |
Bucket.AutoclassOrBuilder |
static class |
Bucket.Billing
Billing properties of a bucket.
|
static interface |
Bucket.BillingOrBuilder |
static class |
Bucket.Builder
A bucket.
|
static class |
Bucket.Cors
Cross-Origin Response sharing (CORS) properties for a bucket.
|
static interface |
Bucket.CorsOrBuilder |
static class |
Bucket.CustomPlacementConfig
Configuration for Custom Dual Regions.
|
static interface |
Bucket.CustomPlacementConfigOrBuilder |
static class |
Bucket.Encryption
Encryption properties of a bucket.
|
static interface |
Bucket.EncryptionOrBuilder |
static class |
Bucket.IamConfig
Bucket restriction options.
|
static interface |
Bucket.IamConfigOrBuilder |
static class |
Bucket.Lifecycle
Lifecycle properties of a bucket.
|
static interface |
Bucket.LifecycleOrBuilder |
static class |
Bucket.Logging
Logging-related properties of a bucket.
|
static interface |
Bucket.LoggingOrBuilder |
static class |
Bucket.RetentionPolicy
Retention policy properties of a bucket.
|
static interface |
Bucket.RetentionPolicyOrBuilder |
static class |
Bucket.Versioning
Properties of a bucket related to versioning.
|
static interface |
Bucket.VersioningOrBuilder |
static class |
Bucket.Website
Properties of a bucket related to accessing the contents as a static
website.
|
static interface |
Bucket.WebsiteOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Method and Description |
---|---|
boolean |
containsLabels(String key)
User-provided labels, in key/value pairs.
|
boolean |
equals(Object obj) |
BucketAccessControl |
getAcl(int index)
Access controls on the bucket.
|
int |
getAclCount()
Access controls on the bucket.
|
List<BucketAccessControl> |
getAclList()
Access controls on the bucket.
|
BucketAccessControlOrBuilder |
getAclOrBuilder(int index)
Access controls on the bucket.
|
List<? extends BucketAccessControlOrBuilder> |
getAclOrBuilderList()
Access controls on the bucket.
|
Bucket.Autoclass |
getAutoclass()
The bucket's Autoclass configuration.
|
Bucket.AutoclassOrBuilder |
getAutoclassOrBuilder()
The bucket's Autoclass configuration.
|
Bucket.Billing |
getBilling()
The bucket's billing config.
|
Bucket.BillingOrBuilder |
getBillingOrBuilder()
The bucket's billing config.
|
String |
getBucketId()
Output only.
|
com.google.protobuf.ByteString |
getBucketIdBytes()
Output only.
|
Bucket.Cors |
getCors(int index)
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
(CORS) config.
|
int |
getCorsCount()
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
(CORS) config.
|
List<Bucket.Cors> |
getCorsList()
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
(CORS) config.
|
Bucket.CorsOrBuilder |
getCorsOrBuilder(int index)
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
(CORS) config.
|
List<? extends Bucket.CorsOrBuilder> |
getCorsOrBuilderList()
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing]
(CORS) config.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
Bucket.CustomPlacementConfig |
getCustomPlacementConfig()
Configuration that, if present, specifies the data placement for a
[https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
|
Bucket.CustomPlacementConfigOrBuilder |
getCustomPlacementConfigOrBuilder()
Configuration that, if present, specifies the data placement for a
[https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
|
boolean |
getDefaultEventBasedHold()
The default value for event-based hold on newly created objects in this
bucket.
|
static Bucket |
getDefaultInstance() |
Bucket |
getDefaultInstanceForType() |
ObjectAccessControl |
getDefaultObjectAcl(int index)
Default access controls to apply to new objects when no ACL is provided.
|
int |
getDefaultObjectAclCount()
Default access controls to apply to new objects when no ACL is provided.
|
List<ObjectAccessControl> |
getDefaultObjectAclList()
Default access controls to apply to new objects when no ACL is provided.
|
ObjectAccessControlOrBuilder |
getDefaultObjectAclOrBuilder(int index)
Default access controls to apply to new objects when no ACL is provided.
|
List<? extends ObjectAccessControlOrBuilder> |
getDefaultObjectAclOrBuilderList()
Default access controls to apply to new objects when no ACL is provided.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Bucket.Encryption |
getEncryption()
Encryption config for a bucket.
|
Bucket.EncryptionOrBuilder |
getEncryptionOrBuilder()
Encryption config for a bucket.
|
String |
getEtag()
The etag of the bucket.
|
com.google.protobuf.ByteString |
getEtagBytes()
The etag of the bucket.
|
Bucket.IamConfig |
getIamConfig()
The bucket's IAM config.
|
Bucket.IamConfigOrBuilder |
getIamConfigOrBuilder()
The bucket's IAM config.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
User-provided labels, in key/value pairs.
|
Map<String,String> |
getLabelsMap()
User-provided labels, in key/value pairs.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
User-provided labels, in key/value pairs.
|
String |
getLabelsOrThrow(String key)
User-provided labels, in key/value pairs.
|
Bucket.Lifecycle |
getLifecycle()
The bucket's lifecycle config.
|
Bucket.LifecycleOrBuilder |
getLifecycleOrBuilder()
The bucket's lifecycle config.
|
String |
getLocation()
Immutable.
|
com.google.protobuf.ByteString |
getLocationBytes()
Immutable.
|
String |
getLocationType()
Output only.
|
com.google.protobuf.ByteString |
getLocationTypeBytes()
Output only.
|
Bucket.Logging |
getLogging()
The bucket's logging config, which defines the destination bucket
and name prefix (if any) for the current bucket's logs.
|
Bucket.LoggingOrBuilder |
getLoggingOrBuilder()
The bucket's logging config, which defines the destination bucket
and name prefix (if any) for the current bucket's logs.
|
long |
getMetageneration()
Output only.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
Owner |
getOwner()
Output only.
|
OwnerOrBuilder |
getOwnerOrBuilder()
Output only.
|
com.google.protobuf.Parser<Bucket> |
getParserForType() |
String |
getProject()
Immutable.
|
com.google.protobuf.ByteString |
getProjectBytes()
Immutable.
|
Bucket.RetentionPolicy |
getRetentionPolicy()
The bucket's retention policy.
|
Bucket.RetentionPolicyOrBuilder |
getRetentionPolicyOrBuilder()
The bucket's retention policy.
|
String |
getRpo()
The recovery point objective for cross-region replication of the bucket.
|
com.google.protobuf.ByteString |
getRpoBytes()
The recovery point objective for cross-region replication of the bucket.
|
boolean |
getSatisfiesPzs()
Reserved for future use.
|
int |
getSerializedSize() |
String |
getStorageClass()
The bucket's default storage class, used whenever no storageClass is
specified for a newly-created object.
|
com.google.protobuf.ByteString |
getStorageClassBytes()
The bucket's default storage class, used whenever no storageClass is
specified for a newly-created object.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
Bucket.Versioning |
getVersioning()
The bucket's versioning config.
|
Bucket.VersioningOrBuilder |
getVersioningOrBuilder()
The bucket's versioning config.
|
Bucket.Website |
getWebsite()
The bucket's website config, controlling how the service behaves
when accessing bucket contents as a web site.
|
Bucket.WebsiteOrBuilder |
getWebsiteOrBuilder()
The bucket's website config, controlling how the service behaves
when accessing bucket contents as a web site.
|
boolean |
hasAutoclass()
The bucket's Autoclass configuration.
|
boolean |
hasBilling()
The bucket's billing config.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasCustomPlacementConfig()
Configuration that, if present, specifies the data placement for a
[https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
|
boolean |
hasEncryption()
Encryption config for a bucket.
|
int |
hashCode() |
boolean |
hasIamConfig()
The bucket's IAM config.
|
boolean |
hasLifecycle()
The bucket's lifecycle config.
|
boolean |
hasLogging()
The bucket's logging config, which defines the destination bucket
and name prefix (if any) for the current bucket's logs.
|
boolean |
hasOwner()
Output only.
|
boolean |
hasRetentionPolicy()
The bucket's retention policy.
|
boolean |
hasUpdateTime()
Output only.
|
boolean |
hasVersioning()
The bucket's versioning config.
|
boolean |
hasWebsite()
The bucket's website config, controlling how the service behaves
when accessing bucket contents as a web site.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Bucket.Builder |
newBuilder() |
static Bucket.Builder |
newBuilder(Bucket prototype) |
Bucket.Builder |
newBuilderForType() |
protected Bucket.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Bucket |
parseDelimitedFrom(InputStream input) |
static Bucket |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Bucket |
parseFrom(byte[] data) |
static Bucket |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Bucket |
parseFrom(ByteBuffer data) |
static Bucket |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Bucket |
parseFrom(com.google.protobuf.ByteString data) |
static Bucket |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Bucket |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Bucket |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Bucket |
parseFrom(InputStream input) |
static Bucket |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Bucket> |
parser() |
Bucket.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int NAME_FIELD_NUMBER
public static final int BUCKET_ID_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER
public static final int METAGENERATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
public static final int LOCATION_TYPE_FIELD_NUMBER
public static final int STORAGE_CLASS_FIELD_NUMBER
public static final int RPO_FIELD_NUMBER
public static final int ACL_FIELD_NUMBER
public static final int DEFAULT_OBJECT_ACL_FIELD_NUMBER
public static final int LIFECYCLE_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int CORS_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int WEBSITE_FIELD_NUMBER
public static final int VERSIONING_FIELD_NUMBER
public static final int LOGGING_FIELD_NUMBER
public static final int OWNER_FIELD_NUMBER
public static final int ENCRYPTION_FIELD_NUMBER
public static final int BILLING_FIELD_NUMBER
public static final int RETENTION_POLICY_FIELD_NUMBER
public static final int IAM_CONFIG_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
public static final int CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER
public static final int AUTOCLASS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public String getName()
Immutable. The name of the bucket. Format: `projects/{project}/buckets/{bucket}`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
getName
in interface BucketOrBuilder
public com.google.protobuf.ByteString getNameBytes()
Immutable. The name of the bucket. Format: `projects/{project}/buckets/{bucket}`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
getNameBytes
in interface BucketOrBuilder
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];
getBucketId
in interface BucketOrBuilder
public com.google.protobuf.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];
getBucketIdBytes
in interface BucketOrBuilder
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;
getEtag
in interface BucketOrBuilder
public com.google.protobuf.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;
getEtagBytes
in interface BucketOrBuilder
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) = { ... }
getProject
in interface BucketOrBuilder
public com.google.protobuf.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) = { ... }
getProjectBytes
in interface BucketOrBuilder
public long getMetageneration()
Output only. The metadata generation of this bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getMetageneration
in interface BucketOrBuilder
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"][developer's guide] 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];
getLocation
in interface BucketOrBuilder
public com.google.protobuf.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"][developer's guide] 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];
getLocationBytes
in interface BucketOrBuilder
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];
getLocationType
in interface BucketOrBuilder
public com.google.protobuf.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];
getLocationTypeBytes
in interface BucketOrBuilder
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;
getStorageClass
in interface BucketOrBuilder
public com.google.protobuf.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;
getStorageClassBytes
in interface BucketOrBuilder
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;
getRpo
in interface BucketOrBuilder
public com.google.protobuf.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;
getRpoBytes
in interface BucketOrBuilder
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;
getAclList
in interface BucketOrBuilder
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;
getAclOrBuilderList
in interface BucketOrBuilder
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;
getAclCount
in interface BucketOrBuilder
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;
getAcl
in interface BucketOrBuilder
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;
getAclOrBuilder
in interface BucketOrBuilder
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;
getDefaultObjectAclList
in interface BucketOrBuilder
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;
getDefaultObjectAclOrBuilderList
in interface BucketOrBuilder
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;
getDefaultObjectAclCount
in interface BucketOrBuilder
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;
getDefaultObjectAcl
in interface BucketOrBuilder
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;
getDefaultObjectAclOrBuilder
in interface BucketOrBuilder
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;
hasLifecycle
in interface BucketOrBuilder
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;
getLifecycle
in interface BucketOrBuilder
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;
getLifecycleOrBuilder
in interface BucketOrBuilder
public boolean hasCreateTime()
Output only. The creation time of the bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime
in interface BucketOrBuilder
public com.google.protobuf.Timestamp getCreateTime()
Output only. The creation time of the bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime
in interface BucketOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time of the bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder
in interface BucketOrBuilder
public List<Bucket.Cors> getCorsList()
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
getCorsList
in interface BucketOrBuilder
public List<? extends Bucket.CorsOrBuilder> getCorsOrBuilderList()
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
getCorsOrBuilderList
in interface BucketOrBuilder
public int getCorsCount()
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
getCorsCount
in interface BucketOrBuilder
public Bucket.Cors getCors(int index)
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
getCors
in interface BucketOrBuilder
public Bucket.CorsOrBuilder getCorsOrBuilder(int index)
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;
getCorsOrBuilder
in interface BucketOrBuilder
public boolean hasUpdateTime()
Output only. The modification time of the bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime
in interface BucketOrBuilder
public com.google.protobuf.Timestamp getUpdateTime()
Output only. The modification time of the bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime
in interface BucketOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The modification time of the bucket. Attempting to set or update this field will result in a [FieldViolation][google.rpc.BadRequest.FieldViolation].
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder
in interface BucketOrBuilder
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;
getDefaultEventBasedHold
in interface BucketOrBuilder
public int getLabelsCount()
BucketOrBuilder
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
getLabelsCount
in interface BucketOrBuilder
public boolean containsLabels(String key)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
containsLabels
in interface BucketOrBuilder
@Deprecated public Map<String,String> getLabels()
getLabelsMap()
instead.getLabels
in interface BucketOrBuilder
public Map<String,String> getLabelsMap()
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
getLabelsMap
in interface BucketOrBuilder
public String getLabelsOrDefault(String key, String defaultValue)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
getLabelsOrDefault
in interface BucketOrBuilder
public String getLabelsOrThrow(String key)
User-provided labels, in key/value pairs.
map<string, string> labels = 15;
getLabelsOrThrow
in interface BucketOrBuilder
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][Static Website Examples] for more information.
.google.storage.v2.Bucket.Website website = 16;
hasWebsite
in interface BucketOrBuilder
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][Static Website Examples] for more information.
.google.storage.v2.Bucket.Website website = 16;
getWebsite
in interface BucketOrBuilder
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][Static Website Examples] for more information.
.google.storage.v2.Bucket.Website website = 16;
getWebsiteOrBuilder
in interface BucketOrBuilder
public boolean hasVersioning()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
hasVersioning
in interface BucketOrBuilder
public Bucket.Versioning getVersioning()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
getVersioning
in interface BucketOrBuilder
public Bucket.VersioningOrBuilder getVersioningOrBuilder()
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;
getVersioningOrBuilder
in interface BucketOrBuilder
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;
hasLogging
in interface BucketOrBuilder
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;
getLogging
in interface BucketOrBuilder
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;
getLoggingOrBuilder
in interface BucketOrBuilder
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];
hasOwner
in interface BucketOrBuilder
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];
getOwner
in interface BucketOrBuilder
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];
getOwnerOrBuilder
in interface BucketOrBuilder
public boolean hasEncryption()
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
hasEncryption
in interface BucketOrBuilder
public Bucket.Encryption getEncryption()
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
getEncryption
in interface BucketOrBuilder
public Bucket.EncryptionOrBuilder getEncryptionOrBuilder()
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;
getEncryptionOrBuilder
in interface BucketOrBuilder
public boolean hasBilling()
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
hasBilling
in interface BucketOrBuilder
public Bucket.Billing getBilling()
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
getBilling
in interface BucketOrBuilder
public Bucket.BillingOrBuilder getBillingOrBuilder()
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;
getBillingOrBuilder
in interface BucketOrBuilder
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;
hasRetentionPolicy
in interface BucketOrBuilder
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;
getRetentionPolicy
in interface BucketOrBuilder
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;
getRetentionPolicyOrBuilder
in interface BucketOrBuilder
public boolean hasIamConfig()
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
hasIamConfig
in interface BucketOrBuilder
public Bucket.IamConfig getIamConfig()
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
getIamConfig
in interface BucketOrBuilder
public Bucket.IamConfigOrBuilder getIamConfigOrBuilder()
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;
getIamConfigOrBuilder
in interface BucketOrBuilder
public boolean getSatisfiesPzs()
Reserved for future use.
bool satisfies_pzs = 25;
getSatisfiesPzs
in interface BucketOrBuilder
public boolean hasCustomPlacementConfig()
Configuration that, if present, specifies the data placement for a [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;
hasCustomPlacementConfig
in interface BucketOrBuilder
public Bucket.CustomPlacementConfig getCustomPlacementConfig()
Configuration that, if present, specifies the data placement for a [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;
getCustomPlacementConfig
in interface BucketOrBuilder
public Bucket.CustomPlacementConfigOrBuilder getCustomPlacementConfigOrBuilder()
Configuration that, if present, specifies the data placement for a [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].
.google.storage.v2.Bucket.CustomPlacementConfig custom_placement_config = 26;
getCustomPlacementConfigOrBuilder
in interface BucketOrBuilder
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;
hasAutoclass
in interface BucketOrBuilder
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;
getAutoclass
in interface BucketOrBuilder
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;
getAutoclassOrBuilder
in interface BucketOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Bucket parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Bucket parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Bucket parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Bucket parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Bucket parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Bucket parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Bucket parseFrom(InputStream input) throws IOException
IOException
public static Bucket parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Bucket parseDelimitedFrom(InputStream input) throws IOException
IOException
public static Bucket parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static Bucket parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static Bucket parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public Bucket.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Bucket.Builder newBuilder()
public static Bucket.Builder newBuilder(Bucket prototype)
public Bucket.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Bucket.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Bucket getDefaultInstance()
public static com.google.protobuf.Parser<Bucket> parser()
public com.google.protobuf.Parser<Bucket> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Bucket getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.