# Class Bucket (2.69.0)

2.69.0 (latest) 2.67.0 2.64.0 2.63.0 2.62.1 2.60.0 2.59.0 2.58.1 2.57.0 2.56.0 2.55.0 2.54.0 2.53.3 2.52.3 2.50.0 2.49.0 2.48.2 2.47.0 2.46.0 2.45.0 2.44.1 2.43.2 2.42.0 2.41.0 2.40.1 2.39.0 2.38.0 2.37.0 2.36.1 2.34.0 2.33.0 2.32.1 2.30.1 2.29.1 2.28.0 2.27.1 2.24.0 2.23.0 2.22.6 2.21.0 2.20.2 2.19.0 2.18.0 2.17.2 2.16.0 2.15.1 2.14.0 2.13.1 2.12.0 2.11.3 2.10.0 2.9.3 2.8.1 2.7.1 2.6.1 2.5.1 2.4.5 2.3.0 2.2.3 2.1.10

    public class Bucket extends BucketInfo

A Google cloud storage bucket.

Objects of this class are immutable. Operations that modify the bucket like [#update](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket#com_google_cloud_storage_Bucket_update_)
return a new object. To get a `Bucket` object with the most recent information use [#reload](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket#com_google_cloud_storage_Bucket_reload_). `Bucket` adds a layer of service-related functionality over [BucketInfo](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo).

## Inheritance

[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> [BucketInfo](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo) \> Bucket

## Inherited Members

[BucketInfo.equals(Object)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_equals_java_lang_Object_) [BucketInfo.getAcl()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getAcl__) [BucketInfo.getAutoclass()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getAutoclass__) [BucketInfo.getCors()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getCors__) [BucketInfo.getCreateTime()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getCreateTime__) [BucketInfo.getCreateTimeOffsetDateTime()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getCreateTimeOffsetDateTime__) [BucketInfo.getCustomPlacementConfig()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getCustomPlacementConfig__) [BucketInfo.getCustomerManagedEncryptionEnforcementConfig()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getCustomerManagedEncryptionEnforcementConfig__) [BucketInfo.getCustomerSuppliedEncryptionEnforcementConfig()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getCustomerSuppliedEncryptionEnforcementConfig__) [BucketInfo.getDefaultAcl()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getDefaultAcl__) [BucketInfo.getDefaultEventBasedHold()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getDefaultEventBasedHold__) [BucketInfo.getDefaultKmsKeyName()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getDefaultKmsKeyName__) [BucketInfo.getDeleteRules()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getDeleteRules__) [BucketInfo.getEtag()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getEtag__) [BucketInfo.getGeneratedId()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getGeneratedId__) [BucketInfo.getGoogleManagedEncryptionEnforcementConfig()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getGoogleManagedEncryptionEnforcementConfig__) [BucketInfo.getHierarchicalNamespace()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getHierarchicalNamespace__) [BucketInfo.getIamConfiguration()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getIamConfiguration__) [BucketInfo.getIndexPage()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getIndexPage__) [BucketInfo.getIpFilter()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getIpFilter__) [BucketInfo.getLabels()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getLabels__) [BucketInfo.getLifecycleRules()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getLifecycleRules__) [BucketInfo.getLocation()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getLocation__) [BucketInfo.getLocationType()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getLocationType__) [BucketInfo.getLogging()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getLogging__) [BucketInfo.getMetageneration()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getMetageneration__) [BucketInfo.getName()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getName__) [BucketInfo.getNotFoundPage()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getNotFoundPage__) [BucketInfo.getObjectRetention()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getObjectRetention__) [BucketInfo.getOwner()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getOwner__) [BucketInfo.getProject()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getProject__) [BucketInfo.getRetentionEffectiveTime()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getRetentionEffectiveTime__) [BucketInfo.getRetentionEffectiveTimeOffsetDateTime()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getRetentionEffectiveTimeOffsetDateTime__) [BucketInfo.getRetentionPeriod()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getRetentionPeriod__) [BucketInfo.getRetentionPeriodDuration()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getRetentionPeriodDuration__) [BucketInfo.getRpo()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getRpo__) [BucketInfo.getSelfLink()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getSelfLink__) [BucketInfo.getSoftDeletePolicy()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getSoftDeletePolicy__) [BucketInfo.getStorageClass()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getStorageClass__) [BucketInfo.getUpdateTime()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getUpdateTime__) [BucketInfo.getUpdateTimeOffsetDateTime()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_getUpdateTimeOffsetDateTime__) [BucketInfo.hashCode()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_hashCode__) [BucketInfo.isUnreachable()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_isUnreachable__) [BucketInfo.newBuilder(String)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_newBuilder_java_lang_String_) [BucketInfo.of(String)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_of_java_lang_String_) [BucketInfo.requesterPays()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_requesterPays__) [BucketInfo.retentionPolicyIsLocked()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_retentionPolicyIsLocked__) [BucketInfo.toBuilder()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_toBuilder__) [BucketInfo.toString()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_toString__) [BucketInfo.versioningEnabled()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_versioningEnabled__) [Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Methods

### asBucketInfo()

    public BucketInfo asBucketInfo()

Drop the held [Storage](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage) instance.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo` |   |

### create(String blob, byte\[\] content, Bucket.BlobTargetOption\[\] options)

    public Blob create(String blob, byte[] content, Bucket.BlobTargetOption[] options)

Creates a new blob in this bucket. Direct upload is used to upload `content`. For large
content, [Blob#writer(com.google.cloud.storage.Storage.BlobWriteOption...)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob#com_google_cloud_storage_Blob_writer_com_google_cloud_storage_Storage_BlobWriteOption____) is
recommended as it uses resumable upload. MD5 and CRC32C hashes of `content` are computed
and used for validating transferred data.

Example of creating a blob in the bucket from a byte array.


     String blobName = "my_blob_name";
     Blob blob = bucket.create(blobName, "Hello, World!".getBytes(UTF_8));
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blob` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` a blob name |
| `content` | `byte[]` the blob content |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BlobTargetOption[]` options for blob creation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob` | a complete blob information |

### create(String blob, byte\[\] content, String contentType, Bucket.BlobTargetOption\[\] options)

    public Blob create(String blob, byte[] content, String contentType, Bucket.BlobTargetOption[] options)

Creates a new blob in this bucket. Direct upload is used to upload `content`. For large
content, [Blob#writer(com.google.cloud.storage.Storage.BlobWriteOption...)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob#com_google_cloud_storage_Blob_writer_com_google_cloud_storage_Storage_BlobWriteOption____) is
recommended as it uses resumable upload. MD5 and CRC32C hashes of `content` are computed
and used for validating transferred data.

Example of creating a blob in the bucket from a byte array with a content type.


     String blobName = "my_blob_name";
     Blob blob = bucket.create(blobName, "Hello, World!".getBytes(UTF_8), "text/plain");
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blob` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` a blob name |
| `content` | `byte[]` the blob content |
| `contentType` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the blob content type |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BlobTargetOption[]` options for blob creation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob` | a complete blob information |

### create(String blob, InputStream content, Bucket.BlobWriteOption\[\] options)

    public Blob create(String blob, InputStream content, Bucket.BlobWriteOption[] options)

Creates a new blob in this bucket. Direct upload is used to upload `content`. For large
content, [Blob#writer(com.google.cloud.storage.Storage.BlobWriteOption...)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob#com_google_cloud_storage_Blob_writer_com_google_cloud_storage_Storage_BlobWriteOption____) is
recommended as it uses resumable upload.

Example of creating a blob in the bucket from an input stream.


     String blobName = "my_blob_name";
     InputStream content = new ByteArrayInputStream("Hello, World!".getBytes(UTF_8));
     Blob blob = bucket.create(blobName, content);
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blob` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` a blob name |
| `content` | `https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html` the blob content as a stream |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BlobWriteOption[]` options for blob creation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob` | a complete blob information |

### create(String blob, InputStream content, String contentType, Bucket.BlobWriteOption\[\] options)

    public Blob create(String blob, InputStream content, String contentType, Bucket.BlobWriteOption[] options)

Creates a new blob in this bucket. Direct upload is used to upload `content`. For large
content, [Blob#writer(com.google.cloud.storage.Storage.BlobWriteOption...)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob#com_google_cloud_storage_Blob_writer_com_google_cloud_storage_Storage_BlobWriteOption____) is
recommended as it uses resumable upload.

Example of creating a blob in the bucket from an input stream with a content type.


     String blobName = "my_blob_name";
     InputStream content = new ByteArrayInputStream("Hello, World!".getBytes(UTF_8));
     Blob blob = bucket.create(blobName, content, "text/plain");
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blob` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` a blob name |
| `content` | `https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html` the blob content as a stream |
| `contentType` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the blob content type |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BlobWriteOption[]` options for blob creation |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob` | a complete blob information |

### createAcl(Acl acl)

    public Acl createAcl(Acl acl)

Creates a new ACL entry on this bucket.

Example of creating a new ACL entry.


     Acl acl = bucket.createAcl(Acl.of(User.ofAllAuthenticatedUsers(), Acl.Role.READER));
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `acl` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |   |

### createDefaultAcl(Acl acl)

    public Acl createDefaultAcl(Acl acl)

Creates a new default blob ACL entry on this bucket.

Default ACLs are applied to a new blob within the bucket when no ACL was provided for that
blob.

Example of creating a new default ACL entry.


     Acl acl = bucket.createDefaultAcl(Acl.of(User.ofAllAuthenticatedUsers(), Acl.Role.READER));
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `acl` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |   |

### delete(Bucket.BucketSourceOption\[\] options)

    public boolean delete(Bucket.BucketSourceOption[] options)

Deletes this bucket.

Example of deleting the bucket, if its metageneration matches the [Bucket#getMetageneration()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket#com_google_storage_v2_Bucket_getMetageneration__) value, otherwise a [StorageException](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.StorageException) is thrown.


     boolean deleted = bucket.delete(BucketSourceOption.metagenerationMatch());
     if (deleted) {
       // the bucket was deleted
     } else {
       // the bucket was not found
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BucketSourceOption[]` bucket delete options |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | `true` if bucket was deleted, `false` if it was not found |

### deleteAcl(Acl.Entity entity)

    public boolean deleteAcl(Acl.Entity entity)

Deletes the ACL entry for the specified entity on this bucket.

Example of deleting the ACL entry for an entity.


     boolean deleted = bucket.deleteAcl(User.ofAllAuthenticatedUsers());
     if (deleted) {
       // the acl entry was deleted
     } else {
       // the acl entry was not found
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `entity` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl.Entity` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | `true` if the ACL was deleted, `false` if it was not found |

### deleteDefaultAcl(Acl.Entity entity)

    public boolean deleteDefaultAcl(Acl.Entity entity)

Deletes the default object ACL entry for the specified entity on this bucket.

Default ACLs are applied to a new blob within the bucket when no ACL was provided for that
blob.

Example of deleting the default ACL entry for an entity.


     boolean deleted = bucket.deleteDefaultAcl(User.ofAllAuthenticatedUsers());
     if (deleted) {
       // the acl entry was deleted
     } else {
       // the acl entry was not found
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `entity` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl.Entity` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | `true` if the ACL was deleted, `false` if it was not found |

### equals(Object obj)

    public final boolean equals(Object obj)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

**Overrides** [BucketInfo.equals(Object o)](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_equals_java_lang_Object_)

### exists(Bucket.BucketSourceOption\[\] options)

    public boolean exists(Bucket.BucketSourceOption[] options)

Checks if this bucket exists.

Example of checking if the bucket exists.


     boolean exists = bucket.exists();
     if (exists) {
       // the bucket exists
     } else {
       // the bucket was not found
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BucketSourceOption[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | true if this bucket exists, false otherwise |

### get(Iterable\<String\> blobNames)

    public List<Blob> get(Iterable<String> blobNames)

Returns a list of requested blobs in this bucket. Blobs that do not exist are null.

Example of getting some blobs in the bucket, using a batch request.


     String blobName1 = "my_blob_name1";
     String blobName2 = "my_blob_name2";
     List<String> blobNames = new LinkedList<>();
     blobNames.add(blobName1);
     blobNames.add(blobName2);
     List<Blob> blobs = bucket.get(blobNames);
     for (Blob blob : blobs) {
       if (blob == null) {
         // the blob was not found
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `blobNames` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` blobs to get |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob>` | an immutable list of `Blob` objects |

### get(String blob, Storage.BlobGetOption\[\] options)

    public Blob get(String blob, Storage.BlobGetOption[] options)

Returns the requested blob in this bucket or `null` if not found.

Example of getting a blob in the bucket, only if its metageneration matches a value,
otherwise a [StorageException](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.StorageException) is thrown.


     String blobName = "my_blob_name";
     long generation = 42;
     Blob blob = bucket.get(blobName, BlobGetOption.generationMatch(generation));
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blob` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the requested blob |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage.BlobGetOption[]` blob search options |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob` |   |

### get(String blob, Long generation, Storage.BlobGetOption\[\] options)

    public Blob get(String blob, Long generation, Storage.BlobGetOption[] options)

Returns the requested blob in this bucket of a specific generation or `null` if not
found.

Example of getting a blob of a specific in the bucket.


     String blobName = "my_blob_name";
     long generation = 42;
     Blob blob = bucket.get(blobName, generation);
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blob` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the requested blob |
| `generation` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html` the generation to get |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage.BlobGetOption[]` blob search options |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob` |   |

### get(String blobName1, String blobName2, String\[\] blobNames)

    public List<Blob> get(String blobName1, String blobName2, String[] blobNames)

Returns a list of requested blobs in this bucket. Blobs that do not exist are null.

Example of getting some blobs in the bucket, using a batch request.


     String blobName1 = "my_blob_name1";
     String blobName2 = "my_blob_name2";
     List<Blob> blobs = bucket.get(blobName1, blobName2);
     for (Blob blob : blobs) {
       if (blob == null) {
         // the blob was not found
       }
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `blobName1` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` first blob to get |
| `blobName2` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` second blob to get |
| `blobNames` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[]` other blobs to get |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob>` | an immutable list of `Blob` objects |

### getAcl(Acl.Entity entity)

    public Acl getAcl(Acl.Entity entity)

Returns the ACL entry for the specified entity on this bucket or `null` if not found.

Example of getting the ACL entry for an entity.


     Acl acl = bucket.getAcl(User.ofAllAuthenticatedUsers());
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `entity` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl.Entity` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |   |

### getDefaultAcl(Acl.Entity entity)

    public Acl getDefaultAcl(Acl.Entity entity)

Returns the default object ACL entry for the specified entity on this bucket or `null` if
not found.

Default ACLs are applied to a new blob within the bucket when no ACL was provided for that
blob.

Example of getting the default ACL entry for an entity.


     Acl acl = bucket.getDefaultAcl(User.ofAllAuthenticatedUsers());
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `entity` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl.Entity` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |   |

### getStorage()

    public Storage getStorage()

Returns the bucket's `Storage` object used to issue requests.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage` |   |

### hashCode()

    public final int hashCode()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

**Overrides** [BucketInfo.hashCode()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_hashCode__)

### list(Storage.BlobListOption\[\] options)

    public Page<Blob> list(Storage.BlobListOption[] options)

Returns the paginated list of `Blob` in this bucket.

Example of listing the blobs in the bucket.


     Page<Blob> blobs = bucket.list();
     Iterator<Blob> blobIterator = blobs.iterateAll();
     while (blobIterator.hasNext()) {
       Blob blob = blobIterator.next();
       // do something with the blob
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage.BlobListOption[]` options for listing blobs |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.paging.Page.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Blob>` |   |

### listAcls()

    public List<Acl> listAcls()

Lists the ACL entries for this bucket.

Example of listing the ACL entries.


     List<Acl> acls = bucket.listAcls();
     for (Acl acl : acls) {
       // do something with ACL entry
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl>` |   |

### listDefaultAcls()

    public List<Acl> listDefaultAcls()

Lists the default blob ACL entries for this bucket.

Default ACLs are applied to a new blob within the bucket when no ACL was provided for that
blob.

Example of listing the default ACL entries.


     List<Acl> acls = bucket.listDefaultAcls();
     for (Acl acl : acls) {
       // do something with ACL entry
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl>` |   |

### lockRetentionPolicy(Storage.BucketTargetOption\[\] options)

    public Bucket lockRetentionPolicy(Storage.BucketTargetOption[] options)

Locks bucket retention policy. Requires a local metageneration value in the request. Review
example below.

Accepts an optional userProject [BucketTargetOption](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage.BucketTargetOption) option which defines the project
id to assign operational costs.

Warning: Once a retention policy is locked, it can't be unlocked, removed, or shortened.

Example of locking a retention policy on a bucket, only if its local metageneration value
matches the bucket's service metageneration otherwise a [StorageException](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.StorageException) is thrown.


     String bucketName = "my_unique_bucket";
     Bucket bucket = storage.get(bucketName, BucketGetOption.fields(BucketField.METAGENERATION));
     storage.lockRetentionPolicy(bucket, BucketTargetOption.metagenerationMatch());
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage.BucketTargetOption[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket` | a `Bucket` object of the locked bucket |

### reload(Bucket.BucketSourceOption\[\] options)

    public Bucket reload(Bucket.BucketSourceOption[] options)

Fetches current bucket's latest information. Returns `null` if the bucket does not exist.

Example of getting the bucket's latest information, if its generation does not match the
[Bucket#getMetageneration()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.storage.v2.Bucket#com_google_storage_v2_Bucket_getMetageneration__) value, otherwise a [StorageException](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.StorageException) is thrown.


     Bucket latestBucket = bucket.reload(BucketSourceOption.metagenerationMatch());
     if (latestBucket == null) {
       // the bucket was not found
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.BucketSourceOption[]` bucket read options |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket` | a `Bucket` object with latest information or `null` if not found |

### toBuilder()

    public Bucket.Builder toBuilder()

Returns a builder for the current bucket.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket.Builder` |   |

**Overrides** [BucketInfo.toBuilder()](https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.BucketInfo#com_google_cloud_storage_BucketInfo_toBuilder__)

### update(Storage.BucketTargetOption\[\] options)

    public Bucket update(Storage.BucketTargetOption[] options)

Updates the bucket's information. Bucket's name cannot be changed. A new `Bucket` object
is returned. By default no checks are made on the metadata generation of the current bucket. If
you want to update the information only if the current bucket metadata are at their latest
version use the `metagenerationMatch` option: `
bucket.update(BucketTargetOption.metagenerationMatch())`

Example of updating the bucket's information.


     Bucket updatedBucket = bucket.toBuilder().setVersioningEnabled(true).build().update();
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Storage.BucketTargetOption[]` update options |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Bucket` | a `Bucket` object with updated information |

### updateAcl(Acl acl)

    public Acl updateAcl(Acl acl)

Updates an ACL entry on this bucket.

Example of updating a new ACL entry.


     Acl acl = bucket.updateAcl(Acl.of(User.ofAllAuthenticatedUsers(), Acl.Role.OWNER));
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `acl` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |   |

### updateDefaultAcl(Acl acl)

    public Acl updateDefaultAcl(Acl acl)

Updates a default blob ACL entry on this bucket.

Default ACLs are applied to a new blob within the bucket when no ACL was provided for that
blob.

Example of updating a new default ACL entry.


     Acl acl = bucket.updateDefaultAcl(Acl.of(User.ofAllAuthenticatedUsers(), Acl.Role.OWNER));
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `acl` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-storage/latest/com.google.cloud.storage.Acl` |   |