Class BlobInfo.Builder (2.38.0)

Version 2.38.0

• 2.44.1 (latest)
• 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 abstract static class BlobInfo.Builder

Builder for BlobInfo.

Inheritance

java.lang.Object > BlobInfo.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

public Builder()

Methods

build()

public abstract BlobInfo build()

Creates a BlobInfo object.

Returns
Type	Description
BlobInfo

setAcl(List<Acl> acl)

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

Sets the blob's access control configuration. See Also: About Access Control Lists

Parameter
Name	Description
acl	List<Acl>

Returns
Type	Description
BlobInfo.Builder

setBlobId(BlobId blobId)

public abstract BlobInfo.Builder setBlobId(BlobId blobId)

Sets the blob identity.

Parameter
Name	Description
blobId	BlobId

Returns
Type	Description
BlobInfo.Builder

setCacheControl(String cacheControl)

public abstract BlobInfo.Builder setCacheControl(String cacheControl)

Sets the blob's data cache control. See Also: Cache-Control

Parameter
Name	Description
cacheControl	String

Returns
Type	Description
BlobInfo.Builder

setContentDisposition(String contentDisposition)

public abstract BlobInfo.Builder setContentDisposition(String contentDisposition)

Sets the blob's data content disposition. See Also: Content-Disposition

Parameter
Name	Description
contentDisposition	String

Returns
Type	Description
BlobInfo.Builder

setContentEncoding(String contentEncoding)

public abstract BlobInfo.Builder setContentEncoding(String contentEncoding)

Sets the blob's data content encoding. See Also: Content-Encoding

Parameter
Name	Description
contentEncoding	String

Returns
Type	Description
BlobInfo.Builder

setContentLanguage(String contentLanguage)

public abstract BlobInfo.Builder setContentLanguage(String contentLanguage)

Sets the blob's data content language. See Also: Content-Language

Parameter
Name	Description
contentLanguage	String

Returns
Type	Description
BlobInfo.Builder

setContentType(String contentType)

public abstract BlobInfo.Builder setContentType(String contentType)

Sets the blob's data content type. See Also: Content-Type

Parameter
Name	Description
contentType	String

Returns
Type	Description
BlobInfo.Builder

setCrc32c(String crc32c)

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

Parameter
Name	Description
crc32c	String

Returns
Type	Description
BlobInfo.Builder

setCrc32cFromHexString(String crc32cHexString)

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. See Also: Hashes and ETags: Best Practices

Parameter
Name	Description
crc32cHexString	String

Returns
Type	Description
BlobInfo.Builder

setCustomTime(Long customTime) (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();
 

Parameter
Name	Description
customTime	Long

Returns
Type	Description
BlobInfo.Builder

setCustomTimeOffsetDateTime(OffsetDateTime customTime)

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

Parameter
Name	Description
customTime	OffsetDateTime

Returns
Type	Description
BlobInfo.Builder

setEventBasedHold(Boolean eventBasedHold)

public abstract BlobInfo.Builder setEventBasedHold(Boolean eventBasedHold)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Sets the blob's event-based hold.

Parameter
Name	Description
eventBasedHold	Boolean

Returns
Type	Description
BlobInfo.Builder

setMd5(String md5)

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

Parameter
Name	Description
md5	String

Returns
Type	Description
BlobInfo.Builder

setMd5FromHexString(String md5HexString)

public abstract BlobInfo.Builder setMd5FromHexString(String md5HexString)

Sets the MD5 hash of blob's data from hex string. See Also: Hashes and ETags: Best Practices

Parameter
Name	Description
md5HexString	String

Returns
Type	Description
BlobInfo.Builder

setMetadata(@Nullable Map<@NonNull String,@Nullable String> metadata)

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

Sets the blob's user provided metadata.

Parameter
Name	Description
metadata	@org.checkerframework.checker.nullness.qual.Nullable java.util.Map<@org.checkerframework.checker.nullness.qual.NonNull java.lang.String,@org.checkerframework.checker.nullness.qual.Nullable java.lang.String>

Returns
Type	Description
BlobInfo.Builder

setRetention(BlobInfo.Retention retention)

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

Parameter
Name	Description
retention	BlobInfo.Retention

Returns
Type	Description
BlobInfo.Builder

setStorageClass(StorageClass storageClass)

public abstract BlobInfo.Builder setStorageClass(StorageClass storageClass)

Sets the blob's storage class.

Parameter
Name	Description
storageClass	StorageClass

Returns
Type	Description
BlobInfo.Builder

setTemporaryHold(Boolean temporaryHold)

public abstract BlobInfo.Builder setTemporaryHold(Boolean temporaryHold)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Sets the blob's temporary hold.

Parameter
Name	Description
temporaryHold	Boolean

Returns
Type	Description
BlobInfo.Builder

setTimeStorageClassUpdated(Long timeStorageClassUpdated) (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.

Parameter
Name	Description
timeStorageClassUpdated	Long

Returns
Type	Description
BlobInfo.Builder

setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime timeStorageClassUpdated)

public BlobInfo.Builder setTimeStorageClassUpdatedOffsetDateTime(OffsetDateTime timeStorageClassUpdated)

Parameter
Name	Description
timeStorageClassUpdated	OffsetDateTime

Returns
Type	Description
BlobInfo.Builder