Package com.salesforce.multicloudj.blob.driver

Class BlobMetadata.BlobMetadataBuilder

java.lang.Object

com.salesforce.multicloudj.blob.driver.BlobMetadata.BlobMetadataBuilder

Enclosing class:

BlobMetadata

public static class BlobMetadata.BlobMetadataBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
BlobMetadata.BlobMetadataBuilder	archived(boolean archived)	Whether this entry records that the object was archived (deleted) at a point in time rather than a downloadable content version.
BlobMetadata.BlobMetadataBuilder	archivedAt(Instant archivedAt)	The instant at which this version stopped being the current version, or null if it is still current (or the store does not report it).
BlobMetadata	build()
BlobMetadata.BlobMetadataBuilder	checksum(Checksum checksum)	Checksum of the object as reported by the store, or null if the store does not report one.
BlobMetadata.BlobMetadataBuilder	clearMetadata()
BlobMetadata.BlobMetadataBuilder	contentType(String contentType)	The content type of the blob (e.g., "application/octet-stream", "application/x-directory")
BlobMetadata.BlobMetadataBuilder	correlationId(String correlationId)	The correlation ID associated with the operation that produced this metadata.
BlobMetadata.BlobMetadataBuilder	createdTime(Instant createdTime)	The creation time of the blob.
BlobMetadata.BlobMetadataBuilder	eTag(String eTag)
BlobMetadata.BlobMetadataBuilder	key(String key)
BlobMetadata.BlobMetadataBuilder	lastModified(Instant lastModified)
BlobMetadata.BlobMetadataBuilder	md5(byte[] md5)
BlobMetadata.BlobMetadataBuilder	metadata(String metadataKey, String metadataValue)
BlobMetadata.BlobMetadataBuilder	metadata(Map<? extends String,? extends String> metadata)
BlobMetadata.BlobMetadataBuilder	objectLockInfo(ObjectLockInfo objectLockInfo)	Object lock information for this blob. null if object lock is not configured.
BlobMetadata.BlobMetadataBuilder	objectSize(long objectSize)
String	toString()
BlobMetadata.BlobMetadataBuilder	versionId(String versionId)	The versionId of this blob.

Methods inherited from class java.lang.Object

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

Method Details

key

public BlobMetadata.BlobMetadataBuilder key(String key)

Returns:

this.

versionId

public BlobMetadata.BlobMetadataBuilder versionId(String versionId)

The versionId of this blob. This value only serves a purpose for buckets with versioning enabled, although non-versioned buckets may still return a value for it. Non-versioned buckets should simply ignore the versionId value as it serves no purpose for them.

Returns:

this.

eTag

public BlobMetadata.BlobMetadataBuilder eTag(String eTag)

Returns:

this.

objectSize

public BlobMetadata.BlobMetadataBuilder objectSize(long objectSize)

Returns:

this.

metadata

public BlobMetadata.BlobMetadataBuilder metadata(String metadataKey,
 String metadataValue)

metadata

public BlobMetadata.BlobMetadataBuilder metadata(Map<? extends String,? extends String> metadata)

clearMetadata

public BlobMetadata.BlobMetadataBuilder clearMetadata()

lastModified

public BlobMetadata.BlobMetadataBuilder lastModified(Instant lastModified)

Returns:

this.

createdTime

public BlobMetadata.BlobMetadataBuilder createdTime(Instant createdTime)

The creation time of the blob. This represents when the blob was originally created.

Returns:

this.

md5

public BlobMetadata.BlobMetadataBuilder md5(byte[] md5)

Returns:

this.

contentType

public BlobMetadata.BlobMetadataBuilder contentType(String contentType)

The content type of the blob (e.g., "application/octet-stream", "application/x-directory")

Returns:

this.

objectLockInfo

public BlobMetadata.BlobMetadataBuilder objectLockInfo(ObjectLockInfo objectLockInfo)

Object lock information for this blob. null if object lock is not configured.

Returns:

this.

checksum

public BlobMetadata.BlobMetadataBuilder checksum(Checksum checksum)

Checksum of the object as reported by the store, or null if the store does not report one. Populated on responses from getMetadata and download.

Returns:

this.

correlationId

public BlobMetadata.BlobMetadataBuilder correlationId(String correlationId)

The correlation ID associated with the operation that produced this metadata.

Returns:

this.

archived

public BlobMetadata.BlobMetadataBuilder archived(boolean archived)

Whether this entry records that the object was archived (deleted) at a point in time rather than a downloadable content version. Defaults to false for content versions and for stores that do not surface archived entries.

Returns:

this.

archivedAt

public BlobMetadata.BlobMetadataBuilder archivedAt(Instant archivedAt)

The instant at which this version stopped being the current version, or null if it is still current (or the store does not report it). Together with createdTime this defines the version's validity interval [createdTime, archivedAt), with the end instant exclusive.

Returns:

this.

build

public BlobMetadata build()

toString

public String toString()

Overrides:

toString in class Object