Class Bucket (2.44.1)

public final class Bucket extends GeneratedMessageV3 implements BucketOrBuilder

A bucket.

Protobuf type google.storage.v2.Bucket

Inheritance

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

Implements

BucketOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACL_FIELD_NUMBER

public static final int ACL_FIELD_NUMBER

Field Value
Type	Description
`int`

AUTOCLASS_FIELD_NUMBER

public static final int AUTOCLASS_FIELD_NUMBER

Field Value
Type	Description
`int`

BILLING_FIELD_NUMBER

public static final int BILLING_FIELD_NUMBER

Field Value
Type	Description
`int`

BUCKET_ID_FIELD_NUMBER

public static final int BUCKET_ID_FIELD_NUMBER

Field Value
Type	Description
`int`

CORS_FIELD_NUMBER

public static final int CORS_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER

public static final int CUSTOM_PLACEMENT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER

public static final int DEFAULT_EVENT_BASED_HOLD_FIELD_NUMBER

Field Value
Type	Description
`int`

DEFAULT_OBJECT_ACL_FIELD_NUMBER

public static final int DEFAULT_OBJECT_ACL_FIELD_NUMBER

Field Value
Type	Description
`int`

ENCRYPTION_FIELD_NUMBER

public static final int ENCRYPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

Field Value
Type	Description
`int`

HIERARCHICAL_NAMESPACE_FIELD_NUMBER

public static final int HIERARCHICAL_NAMESPACE_FIELD_NUMBER

Field Value
Type	Description
`int`

IAM_CONFIG_FIELD_NUMBER

public static final int IAM_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value
Type	Description
`int`

LIFECYCLE_FIELD_NUMBER

public static final int LIFECYCLE_FIELD_NUMBER

Field Value
Type	Description
`int`

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER

Field Value
Type	Description
`int`

LOCATION_TYPE_FIELD_NUMBER

public static final int LOCATION_TYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

LOGGING_FIELD_NUMBER

public static final int LOGGING_FIELD_NUMBER

Field Value
Type	Description
`int`

METAGENERATION_FIELD_NUMBER

public static final int METAGENERATION_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

OWNER_FIELD_NUMBER

public static final int OWNER_FIELD_NUMBER

Field Value
Type	Description
`int`

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER

Field Value
Type	Description
`int`

RETENTION_POLICY_FIELD_NUMBER

public static final int RETENTION_POLICY_FIELD_NUMBER

Field Value
Type	Description
`int`

RPO_FIELD_NUMBER

public static final int RPO_FIELD_NUMBER

Field Value
Type	Description
`int`

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER

Field Value
Type	Description
`int`

SOFT_DELETE_POLICY_FIELD_NUMBER

public static final int SOFT_DELETE_POLICY_FIELD_NUMBER

Field Value
Type	Description
`int`

STORAGE_CLASS_FIELD_NUMBER

public static final int STORAGE_CLASS_FIELD_NUMBER

Field Value
Type	Description
`int`

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

VERSIONING_FIELD_NUMBER

public static final int VERSIONING_FIELD_NUMBER

Field Value
Type	Description
`int`

WEBSITE_FIELD_NUMBER

public static final int WEBSITE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Bucket getDefaultInstance()

Returns
Type	Description
`Bucket`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Bucket.Builder newBuilder()

Returns
Type	Description
`Bucket.Builder`

newBuilder(Bucket prototype)

public static Bucket.Builder newBuilder(Bucket prototype)

Parameter
Name	Description
`prototype`	`Bucket`

Returns
Type	Description
`Bucket.Builder`

parseDelimitedFrom(InputStream input)

public static Bucket parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Bucket parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Bucket parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Bucket parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Bucket parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Bucket parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Bucket parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Bucket parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Bucket parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Bucket parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Bucket`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Bucket> parser()

Returns
Type	Description
`Parser<Bucket>`

Methods

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`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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`

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.

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.

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()

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`

getCorsCount()

public int getCorsCount()

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

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

Returns
Type	Description
`int`

getCorsList()

public List<Bucket.Cors> getCorsList()

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

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

Returns
Type	Description
`List<Cors>`

getCorsOrBuilder(int index)

public Bucket.CorsOrBuilder getCorsOrBuilder(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Bucket.CorsOrBuilder`

getCorsOrBuilderList()

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

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

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

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time of the bucket.

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

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the bucket.

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

Returns
Type	Description
`TimestampOrBuilder`

getCustomPlacementConfig()

public Bucket.CustomPlacementConfig getCustomPlacementConfig()

Configuration that, if present, specifies the data placement for a https://cloud.google.com/storage/docs/locations#location-dr.

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

Returns
Type	Description
`Bucket.CustomPlacementConfig`	The customPlacementConfig.

getCustomPlacementConfigOrBuilder()

public Bucket.CustomPlacementConfigOrBuilder getCustomPlacementConfigOrBuilder()

Configuration that, if present, specifies the data placement for a https://cloud.google.com/storage/docs/locations#location-dr.

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

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>`

getEncryption()

public Bucket.Encryption getEncryption()

Encryption config for a bucket.

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

Returns
Type	Description
`Bucket.Encryption`	The encryption.

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.

getHierarchicalNamespace()

public Bucket.HierarchicalNamespace 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];

Returns
Type	Description
`Bucket.HierarchicalNamespace`	The hierarchicalNamespace.

getHierarchicalNamespaceOrBuilder()

public Bucket.HierarchicalNamespaceOrBuilder 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];

Returns
Type	Description
`Bucket.HierarchicalNamespaceOrBuilder`

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.

getIamConfigOrBuilder()

public Bucket.IamConfigOrBuilder getIamConfigOrBuilder()

The bucket's IAM config.

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

Returns
Type	Description
`Bucket.IamConfigOrBuilder`

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-provided labels, in key/value pairs.

map<string, string> labels = 15;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

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

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()

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.

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.

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

Returns
Type	Description
`long`	The metageneration.

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.

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`

getParserForType()

public Parser<Bucket> getParserForType()

Returns
Type	Description
`Parser<Bucket>`

Overrides

GeneratedMessageV3.getParserForType()

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.

getRetentionPolicyOrBuilder()

public Bucket.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()

.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/availability-durability#turbo-replication.

string rpo = 27;

Returns
Type	Description
`String`	The rpo.

getRpoBytes()

public ByteString getRpoBytes()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSoftDeletePolicy()

public Bucket.SoftDeletePolicy 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];

Returns
Type	Description
`Bucket.SoftDeletePolicy`	The softDeletePolicy.

getSoftDeletePolicyOrBuilder()

public Bucket.SoftDeletePolicyOrBuilder 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];

Returns
Type	Description
`Bucket.SoftDeletePolicyOrBuilder`

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()

string storage_class = 7;

Returns
Type	Description
`ByteString`	The bytes for storageClass.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The modification time of the bucket.

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

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The modification time of the bucket.

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

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.

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.

.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/locations#location-dr.

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

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];

Returns
Type	Description
`boolean`	Whether the hierarchicalNamespace 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()

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

Returns
Type	Description
`boolean`	Whether the retentionPolicy field is set.

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];

Returns
Type	Description
`boolean`	Whether the softDeletePolicy field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The modification time of the bucket.

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

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Bucket.Builder newBuilderForType()

Returns
Type	Description
`Bucket.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Bucket.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Bucket.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Bucket.Builder toBuilder()

Returns
Type	Description
`Bucket.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`