Package com.google.cloud.storage

Class Blob.Builder

java.lang.Object

com.google.cloud.storage.BlobInfo.Builder

com.google.cloud.storage.Blob.Builder

Enclosing class:

Blob

public static class Blob.Builder
extends BlobInfo.Builder

Builder for Blob.

Method Summary

Modifier and Type	Method	Description
Blob	build()	Creates a BlobInfo object.
Blob.Builder	setAcl(List<Acl> acl)	Sets the blob's access control configuration.
Blob.Builder	setBlobId(BlobId blobId)	Sets the blob identity.
Blob.Builder	setCacheControl(String cacheControl)	Sets the blob's data cache control.
Blob.Builder	setContentDisposition(String contentDisposition)	Sets the blob's data content disposition.
Blob.Builder	setContentEncoding(String contentEncoding)	Sets the blob's data content encoding.
Blob.Builder	setContentLanguage(String contentLanguage)	Sets the blob's data content language.
Blob.Builder	setContentType(String contentType)	Sets the blob's data content type.
Blob.Builder	setCrc32c(String crc32c)	Sets the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; encoded in base64 in big-endian order.
Blob.Builder	setCrc32cFromHexString(String crc32cHexString)	Sets the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; from hex string.
Blob.Builder	setCustomTime(Long customTime)	Deprecated. Use setCustomTimeOffsetDateTime(OffsetDateTime)
BlobInfo.Builder	setCustomTimeOffsetDateTime(OffsetDateTime customTime)	Sets the custom time for an object.
Blob.Builder	setEventBasedHold(Boolean eventBasedHold)	Sets the blob's event-based hold.
Blob.Builder	setMd5(String md5)	Sets the MD5 hash of blob's data.
Blob.Builder	setMd5FromHexString(String md5HexString)	Sets the MD5 hash of blob's data from hex string.
Blob.Builder	setMetadata(Map<String,String> metadata)	Sets the blob's user provided metadata.
Blob.Builder	setRetention(BlobInfo.Retention retention)
Blob.Builder	setStorageClass(StorageClass storageClass)	Sets the blob's storage class.
Blob.Builder	setTemporaryHold(Boolean temporaryHold)	Sets the blob's temporary hold.
Blob.Builder	setTimeStorageClassUpdated(Long timeStorageClassUpdated)	Deprecated. Use setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime)
BlobInfo.Builder	setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime timeStorageClassUpdated)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

setBlobId

public Blob.Builder setBlobId(BlobId blobId)

Description copied from class: BlobInfo.Builder

Sets the blob identity.

Specified by:

setBlobId in class BlobInfo.Builder

setContentType

public Blob.Builder setContentType(String contentType)

Description copied from class: BlobInfo.Builder

Sets the blob's data content type.

Specified by:

setContentType in class BlobInfo.Builder

See Also:

• Content-Type

setContentDisposition

public Blob.Builder setContentDisposition(String contentDisposition)

Description copied from class: BlobInfo.Builder

Sets the blob's data content disposition.

Specified by:

setContentDisposition in class BlobInfo.Builder

See Also:

• Content-Disposition

setContentLanguage

public Blob.Builder setContentLanguage(String contentLanguage)

Description copied from class: BlobInfo.Builder

Sets the blob's data content language.

Specified by:

setContentLanguage in class BlobInfo.Builder

See Also:

• Content-Language

setContentEncoding

public Blob.Builder setContentEncoding(String contentEncoding)

Description copied from class: BlobInfo.Builder

Sets the blob's data content encoding.

Specified by:

setContentEncoding in class BlobInfo.Builder

See Also:

• Content-Encoding

setCacheControl

public Blob.Builder setCacheControl(String cacheControl)

Description copied from class: BlobInfo.Builder

Sets the blob's data cache control.

Specified by:

setCacheControl in class BlobInfo.Builder

See Also:

• Cache-Control

setAcl

public Blob.Builder setAcl(List<Acl> acl)

Description copied from class: BlobInfo.Builder

Sets the blob's access control configuration.

Specified by:

setAcl in class BlobInfo.Builder

See Also:

• About Access Control Lists

setMd5

public Blob.Builder setMd5(String md5)

Description copied from class: BlobInfo.Builder

Sets the MD5 hash of blob's data. MD5 value must be encoded in base64.

Specified by:

setMd5 in class BlobInfo.Builder

See Also:

• Hashes and ETags: Best Practices

setMd5FromHexString

public Blob.Builder setMd5FromHexString(String md5HexString)

Description copied from class: BlobInfo.Builder

Sets the MD5 hash of blob's data from hex string.

Specified by:

setMd5FromHexString in class BlobInfo.Builder

See Also:

• Hashes and ETags: Best Practices

setCrc32c

public Blob.Builder setCrc32c(String crc32c)

Description copied from class: BlobInfo.Builder

Sets the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; encoded in base64 in big-endian order.

Specified by:

setCrc32c in class BlobInfo.Builder

See Also:

• Hashes and ETags: Best Practices

setCrc32cFromHexString

public Blob.Builder setCrc32cFromHexString(String crc32cHexString)

Description copied from class: BlobInfo.Builder

Sets the CRC32C checksum of blob's data as described in RFC 4960, Appendix B; from hex string.

Specified by:

setCrc32cFromHexString in class BlobInfo.Builder

See Also:

• Hashes and ETags: Best Practices

setMetadata

public Blob.Builder setMetadata(Map<String,String> metadata)

Description copied from class: BlobInfo.Builder

Sets the blob's user provided metadata.

Specified by:

setMetadata in class BlobInfo.Builder

setStorageClass

public Blob.Builder setStorageClass(StorageClass storageClass)

Description copied from class: BlobInfo.Builder

Sets the blob's storage class.

Specified by:

setStorageClass in class BlobInfo.Builder

setTimeStorageClassUpdated

@Deprecated
public Blob.Builder setTimeStorageClassUpdated(Long timeStorageClassUpdated)

Deprecated.

Use setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime)

Description copied from class: BlobInfo.Builder

Sets the modification time of an object's storage class. Once set it can't be unset directly, the only way is to rewrite the object with the desired storage class.

Overrides:

setTimeStorageClassUpdated in class BlobInfo.Builder

setTimeStorageClassUpdatedOffsetDateTime

public BlobInfo.Builder setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime timeStorageClassUpdated)

Overrides:

setTimeStorageClassUpdatedOffsetDateTime in class BlobInfo.Builder

setCustomTime

@Deprecated
public Blob.Builder setCustomTime(Long customTime)

Deprecated.

Use setCustomTimeOffsetDateTime(OffsetDateTime)

Description copied from class: BlobInfo.Builder

Sets the custom time for an object. Once set it can't be unset and only changed to a custom datetime in the future. To unset the custom time, you must either perform a rewrite operation or upload the data again.

Example of setting the custom time.

 String bucketName = "my-unique-bucket";
 String blobName = "my-blob-name";
 long customTime = 1598423868301L;
 BlobInfo blob = BlobInfo.newBuilder(bucketName, blobName).setCustomTime(customTime).build();
 

Overrides:

setCustomTime in class BlobInfo.Builder

setCustomTimeOffsetDateTime

public BlobInfo.Builder setCustomTimeOffsetDateTime(OffsetDateTime customTime)

Description copied from class: BlobInfo.Builder

Sets the custom time for an object. Once set it can't be unset and only changed to a custom datetime in the future. To unset the custom time, you must either perform a rewrite operation or upload the data again.

Example of setting the custom time.

 String bucketName = "my-unique-bucket";
 String blobName = "my-blob-name";
 OffsetDateTime customTime = Instant.ofEpochMilli(1598423868301L).atOffset(0); // UTC
 BlobInfo blob = BlobInfo.newBuilder(bucketName, blobName).setCustomTime(customTime).build();
 

Overrides:

setCustomTimeOffsetDateTime in class BlobInfo.Builder

setEventBasedHold

public Blob.Builder setEventBasedHold(Boolean eventBasedHold)

Description copied from class: BlobInfo.Builder

Sets the blob's event-based hold.

Specified by:

setEventBasedHold in class BlobInfo.Builder

setTemporaryHold

public Blob.Builder setTemporaryHold(Boolean temporaryHold)

Description copied from class: BlobInfo.Builder

Sets the blob's temporary hold.

Specified by:

setTemporaryHold in class BlobInfo.Builder

setRetention

public Blob.Builder setRetention(BlobInfo.Retention retention)

Specified by:

setRetention in class BlobInfo.Builder

build

public Blob build()

Description copied from class: BlobInfo.Builder

Creates a BlobInfo object.

Specified by:

build in class BlobInfo.Builder