Package com.google.cloud.storage

Class BlobInfo.Builder

java.lang.Object

com.google.cloud.storage.BlobInfo.Builder

Direct Known Subclasses:

Blob.Builder

Enclosing class:

BlobInfo

public abstract static class BlobInfo.Builder
extends Object

Builder for BlobInfo.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Constructor Details

Builder

public Builder()

Method Details

setBlobId

public abstract BlobInfo.Builder setBlobId(BlobId blobId)

Sets the blob identity.

setContentType

public abstract BlobInfo.Builder setContentType(String contentType)

Sets the blob's data content type.

See Also:

• Content-Type

setContentDisposition

public abstract BlobInfo.Builder setContentDisposition(String contentDisposition)

Sets the blob's data content disposition.

See Also:

• Content-Disposition

setContentLanguage

public abstract BlobInfo.Builder setContentLanguage(String contentLanguage)

Sets the blob's data content language.

See Also:

• Content-Language

setContentEncoding

public abstract BlobInfo.Builder setContentEncoding(String contentEncoding)

Sets the blob's data content encoding.

See Also:

• Content-Encoding

setCacheControl

public abstract BlobInfo.Builder setCacheControl(String cacheControl)

Sets the blob's data cache control.

See Also:

• Cache-Control

setAcl

public abstract BlobInfo.Builder setAcl(List<Acl> acl)

Sets the blob's access control configuration.

See Also:

• About Access Control Lists

setMd5

public abstract BlobInfo.Builder setMd5(String md5)

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

See Also:

• Hashes and ETags: Best Practices

setMd5FromHexString

public abstract BlobInfo.Builder setMd5FromHexString(String md5HexString)

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

Throws:

IllegalArgumentException - when given an invalid hexadecimal value.

See Also:

• Hashes and ETags: Best Practices

setCrc32c

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

See Also:

• Hashes and ETags: Best Practices

setCustomTime

@Deprecated
public BlobInfo.Builder setCustomTime(Long customTime)

Deprecated.

Use setCustomTimeOffsetDateTime(OffsetDateTime)

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

setCustomTimeOffsetDateTime

public BlobInfo.Builder setCustomTimeOffsetDateTime(OffsetDateTime customTime)

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

setCrc32cFromHexString

public abstract BlobInfo.Builder setCrc32cFromHexString(String crc32cHexString)

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

Throws:

IllegalArgumentException - when given an invalid hexadecimal value.

See Also:

• Hashes and ETags: Best Practices

setStorageClass

public abstract BlobInfo.Builder setStorageClass(StorageClass storageClass)

Sets the blob's storage class.

setTimeStorageClassUpdated

@Deprecated
public BlobInfo.Builder setTimeStorageClassUpdated(Long timeStorageClassUpdated)

Deprecated.

Use setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime)

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.

setTimeStorageClassUpdatedOffsetDateTime

public BlobInfo.Builder setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime timeStorageClassUpdated)

setMetadata

public abstract BlobInfo.Builder setMetadata(@Nullable Map<@NonNull String,@Nullable String> metadata)

Sets the blob's user provided metadata.

setEventBasedHold

@BetaApi
public abstract BlobInfo.Builder setEventBasedHold(Boolean eventBasedHold)

Sets the blob's event-based hold.

setTemporaryHold

@BetaApi
public abstract BlobInfo.Builder setTemporaryHold(Boolean temporaryHold)

Sets the blob's temporary hold.

setRetention

public abstract BlobInfo.Builder setRetention(BlobInfo.Retention retention)

build

public abstract BlobInfo build()

Creates a BlobInfo object.