Package com.google.storage.v2
Class Bucket
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.Bucket
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,BucketOrBuilder,Serializable
A bucket.Protobuf type
google.storage.v2.Bucket- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classConfiguration for a bucket's Autoclass feature.static interfacestatic final classBilling properties of a bucket.static interfacestatic final classA bucket.static final classCross-Origin Response sharing (CORS) properties for a bucket.static interfacestatic final classConfiguration for Custom Dual Regions.static interfacestatic final classEncryption properties of a bucket.static interfacestatic final classConfiguration for a bucket's hierarchical namespace feature.static interfacestatic final classBucket restriction options.static interfacestatic final classLifecycle properties of a bucket.static interfacestatic final classLogging-related properties of a bucket.static interfacestatic final classRetention policy properties of a bucket.static interfacestatic final classSoft delete policy properties of a bucket.static interfacestatic final classProperties of a bucket related to versioning.static interfacestatic final classProperties of a bucket related to accessing the contents as a static website.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
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 Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) User-provided labels, in key/value pairs.booleangetAcl(int index) Access controls on the bucket.intAccess controls on the bucket.Access controls on the bucket.getAclOrBuilder(int index) Access controls on the bucket.List<? extends BucketAccessControlOrBuilder>Access controls on the bucket.The bucket's Autoclass configuration.The bucket's Autoclass configuration.The bucket's billing config.The bucket's billing config.Output only.com.google.protobuf.ByteStringOutput only.getCors(int index) The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.intThe bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.getCorsOrBuilder(int index) The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.List<? extends Bucket.CorsOrBuilder>The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Configuration that, if present, specifies the data placement for a [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].Configuration that, if present, specifies the data placement for a [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].booleanThe default value for event-based hold on newly created objects in this bucket.static BucketgetDefaultObjectAcl(int index) Default access controls to apply to new objects when no ACL is provided.intDefault access controls to apply to new objects when no ACL is provided.Default access controls to apply to new objects when no ACL is provided.getDefaultObjectAclOrBuilder(int index) Default access controls to apply to new objects when no ACL is provided.List<? extends ObjectAccessControlOrBuilder>Default access controls to apply to new objects when no ACL is provided.static final com.google.protobuf.Descriptors.DescriptorEncryption config for a bucket.Encryption config for a bucket.getEtag()The etag of the bucket.com.google.protobuf.ByteStringThe etag of the bucket.Optional.Optional.The bucket's IAM config.The bucket's IAM config.Deprecated.intUser-provided labels, in key/value pairs.User-provided labels, in key/value pairs.getLabelsOrDefault(String key, String defaultValue) User-provided labels, in key/value pairs.getLabelsOrThrow(String key) User-provided labels, in key/value pairs.The bucket's lifecycle config.The bucket's lifecycle config.Immutable.com.google.protobuf.ByteStringImmutable.Output only.com.google.protobuf.ByteStringOutput only.The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.The bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.longOutput only.getName()Immutable.com.google.protobuf.ByteStringImmutable.getOwner()Output only.Output only.com.google.protobuf.Parser<Bucket>Immutable.com.google.protobuf.ByteStringImmutable.The bucket's retention policy.The bucket's retention policy.getRpo()The recovery point objective for cross-region replication of the bucket.com.google.protobuf.ByteStringThe recovery point objective for cross-region replication of the bucket.booleanReserved for future use.intOptional.Optional.The bucket's default storage class, used whenever no storageClass is specified for a newly-created object.com.google.protobuf.ByteStringThe bucket's default storage class, used whenever no storageClass is specified for a newly-created object.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.The bucket's versioning config.The bucket's versioning config.The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site.The bucket's website config, controlling how the service behaves when accessing bucket contents as a web site.booleanThe bucket's Autoclass configuration.booleanThe bucket's billing config.booleanOutput only.booleanConfiguration that, if present, specifies the data placement for a [https://cloud.google.com/storage/docs/use-dual-regions][Dual Region].booleanEncryption config for a bucket.inthashCode()booleanOptional.booleanThe bucket's IAM config.booleanThe bucket's lifecycle config.booleanThe bucket's logging config, which defines the destination bucket and name prefix (if any) for the current bucket's logs.booleanhasOwner()Output only.booleanThe bucket's retention policy.booleanOptional.booleanOutput only.booleanThe bucket's versioning config.booleanThe bucket's website config, controlling how the service behaves when accessing bucket contents as a web site.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Bucket.Builderstatic Bucket.BuildernewBuilder(Bucket prototype) protected Bucket.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static BucketparseDelimitedFrom(InputStream input) static BucketparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BucketparseFrom(byte[] data) static BucketparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BucketparseFrom(com.google.protobuf.ByteString data) static BucketparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BucketparseFrom(com.google.protobuf.CodedInputStream input) static BucketparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BucketparseFrom(InputStream input) static BucketparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BucketparseFrom(ByteBuffer data) static BucketparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Bucket>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
BUCKET_ID_FIELD_NUMBER
public static final int BUCKET_ID_FIELD_NUMBER- See Also:
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER- See Also:
-
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER- See Also:
-
METAGENERATION_FIELD_NUMBER
public static final int METAGENERATION_FIELD_NUMBER- See Also:
-
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER- See Also:
-
LOCATION_TYPE_FIELD_NUMBER
public static final int LOCATION_TYPE_FIELD_NUMBER- See Also:
-
STORAGE_CLASS_FIELD_NUMBER
public static final int STORAGE_CLASS_FIELD_NUMBER- See Also:
-
RPO_FIELD_NUMBER
public static final int RPO_FIELD_NUMBER- See Also:
-
ACL_FIELD_NUMBER
public static final int ACL_FIELD_NUMBER- See Also:
-
DEFAULT_OBJECT_ACL_FIELD_NUMBER
public static final int DEFAULT_OBJECT_ACL_FIELD_NUMBER- See Also:
-
LIFECYCLE_FIELD_NUMBER
public static final int LIFECYCLE_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
CORS_FIELD_NUMBER
public static final int CORS_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER
public static final int DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
WEBSITE_FIELD_NUMBER
public static final int WEBSITE_FIELD_NUMBER- See Also:
-
VERSIONING_FIELD_NUMBER
public static final int VERSIONING_FIELD_NUMBER- See Also:
-
LOGGING_FIELD_NUMBER
public static final int LOGGING_FIELD_NUMBER- See Also:
-
OWNER_FIELD_NUMBER
public static final int OWNER_FIELD_NUMBER- See Also:
-
ENCRYPTION_FIELD_NUMBER
public static final int ENCRYPTION_FIELD_NUMBER- See Also:
-
BILLING_FIELD_NUMBER
public static final int BILLING_FIELD_NUMBER- See Also:
-
RETENTION_POLICY_FIELD_NUMBER
public static final int RETENTION_POLICY_FIELD_NUMBER- See Also:
-
IAM_CONFIG_FIELD_NUMBER
public static final int IAM_CONFIG_FIELD_NUMBER- See Also:
-
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER- See Also:
-
CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER
public static final int CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER- See Also:
-
AUTOCLASS_FIELD_NUMBER
public static final int AUTOCLASS_FIELD_NUMBER- See Also:
-
HIERARCHICAL_NAMESPACE_FIELD_NUMBER
public static final int HIERARCHICAL_NAMESPACE_FIELD_NUMBER- See Also:
-
SOFT_DELETE_POLICY_FIELD_NUMBER
public static final int SOFT_DELETE_POLICY_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getName
Immutable. The name of the bucket. Format: `projects/{project}/buckets/{bucket}`string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNamein interfaceBucketOrBuilder- Returns:
- The name.
-
getNameBytes
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];- Specified by:
getNameBytesin interfaceBucketOrBuilder- Returns:
- The bytes for name.
-
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];- Specified by:
getBucketIdin interfaceBucketOrBuilder- Returns:
- The bucketId.
-
getBucketIdBytes
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];- Specified by:
getBucketIdBytesin interfaceBucketOrBuilder- Returns:
- The bytes for bucketId.
-
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;- Specified by:
getEtagin interfaceBucketOrBuilder- Returns:
- The etag.
-
getEtagBytes
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;- Specified by:
getEtagBytesin interfaceBucketOrBuilder- Returns:
- The bytes for etag.
-
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) = { ... }- Specified by:
getProjectin interfaceBucketOrBuilder- Returns:
- The project.
-
getProjectBytes
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) = { ... }- Specified by:
getProjectBytesin interfaceBucketOrBuilder- Returns:
- The bytes for project.
-
getMetageneration
public long getMetageneration()Output only. The metadata generation of this bucket.
int64 metageneration = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getMetagenerationin interfaceBucketOrBuilder- Returns:
- The metageneration.
-
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];- Specified by:
getLocationin interfaceBucketOrBuilder- Returns:
- The location.
-
getLocationBytes
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];- Specified by:
getLocationBytesin interfaceBucketOrBuilder- Returns:
- The bytes for location.
-
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];- Specified by:
getLocationTypein interfaceBucketOrBuilder- Returns:
- The locationType.
-
getLocationTypeBytes
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];- Specified by:
getLocationTypeBytesin interfaceBucketOrBuilder- Returns:
- The bytes for locationType.
-
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;- Specified by:
getStorageClassin interfaceBucketOrBuilder- Returns:
- The storageClass.
-
getStorageClassBytes
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;- Specified by:
getStorageClassBytesin interfaceBucketOrBuilder- Returns:
- The bytes for storageClass.
-
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/availability-durability#turbo-replication.
string rpo = 27;- Specified by:
getRpoin interfaceBucketOrBuilder- Returns:
- The rpo.
-
getRpoBytes
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/availability-durability#turbo-replication.
string rpo = 27;- Specified by:
getRpoBytesin interfaceBucketOrBuilder- Returns:
- The bytes for rpo.
-
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;- Specified by:
getAclListin interfaceBucketOrBuilder
-
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;- Specified by:
getAclOrBuilderListin interfaceBucketOrBuilder
-
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;- Specified by:
getAclCountin interfaceBucketOrBuilder
-
getAcl
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;- Specified by:
getAclin interfaceBucketOrBuilder
-
getAclOrBuilder
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;- Specified by:
getAclOrBuilderin interfaceBucketOrBuilder
-
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;- Specified by:
getDefaultObjectAclListin interfaceBucketOrBuilder
-
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;- Specified by:
getDefaultObjectAclOrBuilderListin interfaceBucketOrBuilder
-
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;- Specified by:
getDefaultObjectAclCountin interfaceBucketOrBuilder
-
getDefaultObjectAcl
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;- Specified by:
getDefaultObjectAclin interfaceBucketOrBuilder
-
getDefaultObjectAclOrBuilder
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;- Specified by:
getDefaultObjectAclOrBuilderin interfaceBucketOrBuilder
-
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;- Specified by:
hasLifecyclein interfaceBucketOrBuilder- Returns:
- Whether the lifecycle field is set.
-
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;- Specified by:
getLifecyclein interfaceBucketOrBuilder- Returns:
- The lifecycle.
-
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;- Specified by:
getLifecycleOrBuilderin interfaceBucketOrBuilder
-
hasCreateTime
public boolean hasCreateTime()Output only. The creation time of the bucket.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceBucketOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. The creation time of the bucket.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceBucketOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The creation time of the bucket.
.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceBucketOrBuilder
-
getCorsList
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;- Specified by:
getCorsListin interfaceBucketOrBuilder
-
getCorsOrBuilderList
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;- Specified by:
getCorsOrBuilderListin interfaceBucketOrBuilder
-
getCorsCount
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;- Specified by:
getCorsCountin interfaceBucketOrBuilder
-
getCors
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;- Specified by:
getCorsin interfaceBucketOrBuilder
-
getCorsOrBuilder
The bucket's [https://www.w3.org/TR/cors/][Cross-Origin Resource Sharing] (CORS) config.
repeated .google.storage.v2.Bucket.Cors cors = 12;- Specified by:
getCorsOrBuilderin interfaceBucketOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. The modification time of the bucket.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceBucketOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. The modification time of the bucket.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceBucketOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The modification time of the bucket.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceBucketOrBuilder
-
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;- Specified by:
getDefaultEventBasedHoldin interfaceBucketOrBuilder- Returns:
- The defaultEventBasedHold.
-
getLabelsCount
public int getLabelsCount()Description copied from interface:BucketOrBuilderUser-provided labels, in key/value pairs.
map<string, string> labels = 15;- Specified by:
getLabelsCountin interfaceBucketOrBuilder
-
containsLabels
User-provided labels, in key/value pairs.
map<string, string> labels = 15;- Specified by:
containsLabelsin interfaceBucketOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceBucketOrBuilder
-
getLabelsMap
User-provided labels, in key/value pairs.
map<string, string> labels = 15;- Specified by:
getLabelsMapin interfaceBucketOrBuilder
-
getLabelsOrDefault
User-provided labels, in key/value pairs.
map<string, string> labels = 15;- Specified by:
getLabelsOrDefaultin interfaceBucketOrBuilder
-
getLabelsOrThrow
User-provided labels, in key/value pairs.
map<string, string> labels = 15;- Specified by:
getLabelsOrThrowin interfaceBucketOrBuilder
-
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][Static Website Examples] for more information.
.google.storage.v2.Bucket.Website website = 16;- Specified by:
hasWebsitein interfaceBucketOrBuilder- Returns:
- Whether the website field is set.
-
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;- Specified by:
getWebsitein interfaceBucketOrBuilder- Returns:
- The website.
-
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;- Specified by:
getWebsiteOrBuilderin interfaceBucketOrBuilder
-
hasVersioning
public boolean hasVersioning()The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;- Specified by:
hasVersioningin interfaceBucketOrBuilder- Returns:
- Whether the versioning field is set.
-
getVersioning
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;- Specified by:
getVersioningin interfaceBucketOrBuilder- Returns:
- The versioning.
-
getVersioningOrBuilder
The bucket's versioning config.
.google.storage.v2.Bucket.Versioning versioning = 17;- Specified by:
getVersioningOrBuilderin interfaceBucketOrBuilder
-
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;- Specified by:
hasLoggingin interfaceBucketOrBuilder- Returns:
- Whether the logging field is set.
-
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;- Specified by:
getLoggingin interfaceBucketOrBuilder- Returns:
- The logging.
-
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;- Specified by:
getLoggingOrBuilderin interfaceBucketOrBuilder
-
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];- Specified by:
hasOwnerin interfaceBucketOrBuilder- Returns:
- Whether the owner field is set.
-
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];- Specified by:
getOwnerin interfaceBucketOrBuilder- Returns:
- The owner.
-
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];- Specified by:
getOwnerOrBuilderin interfaceBucketOrBuilder
-
hasEncryption
public boolean hasEncryption()Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;- Specified by:
hasEncryptionin interfaceBucketOrBuilder- Returns:
- Whether the encryption field is set.
-
getEncryption
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;- Specified by:
getEncryptionin interfaceBucketOrBuilder- Returns:
- The encryption.
-
getEncryptionOrBuilder
Encryption config for a bucket.
.google.storage.v2.Bucket.Encryption encryption = 20;- Specified by:
getEncryptionOrBuilderin interfaceBucketOrBuilder
-
hasBilling
public boolean hasBilling()The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;- Specified by:
hasBillingin interfaceBucketOrBuilder- Returns:
- Whether the billing field is set.
-
getBilling
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;- Specified by:
getBillingin interfaceBucketOrBuilder- Returns:
- The billing.
-
getBillingOrBuilder
The bucket's billing config.
.google.storage.v2.Bucket.Billing billing = 21;- Specified by:
getBillingOrBuilderin interfaceBucketOrBuilder
-
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;- Specified by:
hasRetentionPolicyin interfaceBucketOrBuilder- Returns:
- Whether the retentionPolicy field is set.
-
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;- Specified by:
getRetentionPolicyin interfaceBucketOrBuilder- Returns:
- The retentionPolicy.
-
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;- Specified by:
getRetentionPolicyOrBuilderin interfaceBucketOrBuilder
-
hasIamConfig
public boolean hasIamConfig()The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;- Specified by:
hasIamConfigin interfaceBucketOrBuilder- Returns:
- Whether the iamConfig field is set.
-
getIamConfig
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;- Specified by:
getIamConfigin interfaceBucketOrBuilder- Returns:
- The iamConfig.
-
getIamConfigOrBuilder
The bucket's IAM config.
.google.storage.v2.Bucket.IamConfig iam_config = 23;- Specified by:
getIamConfigOrBuilderin interfaceBucketOrBuilder
-
getSatisfiesPzs
public boolean getSatisfiesPzs()Reserved for future use.
bool satisfies_pzs = 25;- Specified by:
getSatisfiesPzsin interfaceBucketOrBuilder- Returns:
- The satisfiesPzs.
-
hasCustomPlacementConfig
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;- Specified by:
hasCustomPlacementConfigin interfaceBucketOrBuilder- Returns:
- Whether the customPlacementConfig field is set.
-
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;- Specified by:
getCustomPlacementConfigin interfaceBucketOrBuilder- Returns:
- The customPlacementConfig.
-
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;- Specified by:
getCustomPlacementConfigOrBuilderin interfaceBucketOrBuilder
-
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;- Specified by:
hasAutoclassin interfaceBucketOrBuilder- Returns:
- Whether the autoclass field is set.
-
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;- Specified by:
getAutoclassin interfaceBucketOrBuilder- Returns:
- The autoclass.
-
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;- Specified by:
getAutoclassOrBuilderin interfaceBucketOrBuilder
-
hasHierarchicalNamespace
public boolean hasHierarchicalNamespace()Optional. The bucket's hierarchical namespace configuration. If there is no configuration, the hierarchical namespace feature will be disabled and have no effect on the bucket.
.google.storage.v2.Bucket.HierarchicalNamespace hierarchical_namespace = 32 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasHierarchicalNamespacein interfaceBucketOrBuilder- Returns:
- Whether the hierarchicalNamespace field is set.
-
getHierarchicalNamespace
Optional. The bucket's hierarchical namespace configuration. If there is no configuration, the hierarchical namespace feature will be disabled and have no effect on the bucket.
.google.storage.v2.Bucket.HierarchicalNamespace hierarchical_namespace = 32 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHierarchicalNamespacein interfaceBucketOrBuilder- Returns:
- The hierarchicalNamespace.
-
getHierarchicalNamespaceOrBuilder
Optional. The bucket's hierarchical namespace configuration. If there is no configuration, the hierarchical namespace feature will be disabled and have no effect on the bucket.
.google.storage.v2.Bucket.HierarchicalNamespace hierarchical_namespace = 32 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getHierarchicalNamespaceOrBuilderin interfaceBucketOrBuilder
-
hasSoftDeletePolicy
public boolean hasSoftDeletePolicy()Optional. The bucket's soft delete policy. The soft delete policy prevents soft-deleted objects from being permanently deleted.
.google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasSoftDeletePolicyin interfaceBucketOrBuilder- Returns:
- Whether the softDeletePolicy field is set.
-
getSoftDeletePolicy
Optional. The bucket's soft delete policy. The soft delete policy prevents soft-deleted objects from being permanently deleted.
.google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSoftDeletePolicyin interfaceBucketOrBuilder- Returns:
- The softDeletePolicy.
-
getSoftDeletePolicyOrBuilder
Optional. The bucket's soft delete policy. The soft delete policy prevents soft-deleted objects from being permanently deleted.
.google.storage.v2.Bucket.SoftDeletePolicy soft_delete_policy = 31 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSoftDeletePolicyOrBuilderin interfaceBucketOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Bucket parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Bucket parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Bucket parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Bucket parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Bucket parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Bucket parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Bucket parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Bucket parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Bucket parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Bucket.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-