Package com.salesforce.multicloudj.blob.driver

Class UploadRequest

java.lang.Object

com.salesforce.multicloudj.blob.driver.UploadRequest

public class UploadRequest
extends Object

Wrapper object for upload data

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UploadRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UploadRequest.Builder	builder()
ChecksumMethod	getChecksumAlgorithm()	(Optional parameter) The checksum algorithm used for the checksumValue.
String	getChecksumValue()	(Optional parameter) The base64-encoded checksum value for upload validation.
long	getContentLength()	(Optional parameter) The length of the content in bytes.
String	getContentType()	(Optional parameter) The content type of the blob (e.g., "application/octet-stream", "application/x-directory", "text/plain")
String	getKey()	(Required parameter) The name of the blob
String	getKmsKeyId()	(Optional parameter) The KMS key ID or ARN to use for server-side encryption
Map<String,String>	getMetadata()
ObjectLockConfiguration	getObjectLock()	(Optional parameter) Object lock configuration for WORM protection.
String	getStorageClass()	(Optional parameter) The storage class for the blob (e.g., STANDARD, NEARLINE, COLDLINE, ARCHIVE for GCP)
Map<String,String>	getTags()	(Optional parameter) The map of tagName to tagValue to be associated with the blob
boolean	isUseKmsManagedKey()	Set the serviceSideEncryption Header but don't set the kmsKeyId.

Methods inherited from class java.lang.Object

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

Method Details

getMetadata

public Map<String,String> getMetadata()

builder

public static UploadRequest.Builder builder()

getKey

public String getKey()

(Required parameter) The name of the blob

getContentLength

public long getContentLength()

(Optional parameter) The length of the content in bytes. Note that specifying the contentLength can dramatically improve upload efficiency because the substrate SDKs do not need to buffer the contents and calculate it themselves.

getTags

public Map<String,String> getTags()

(Optional parameter) The map of tagName to tagValue to be associated with the blob

getStorageClass

public String getStorageClass()

(Optional parameter) The storage class for the blob (e.g., STANDARD, NEARLINE, COLDLINE, ARCHIVE for GCP)

getKmsKeyId

public String getKmsKeyId()

(Optional parameter) The KMS key ID or ARN to use for server-side encryption

isUseKmsManagedKey

public boolean isUseKmsManagedKey()

Set the serviceSideEncryption Header but don't set the kmsKeyId. When false and kmsKeyId is null, no SSE headers are sent (bucket default applies). This option will trigger the use of the cloud provider managed key

getChecksumValue

public String getChecksumValue()

(Optional parameter) The base64-encoded checksum value for upload validation.

getChecksumAlgorithm

public ChecksumMethod getChecksumAlgorithm()

(Optional parameter) The checksum algorithm used for the checksumValue. Defaults to CRC32C when checksumValue is set but no algorithm is specified.

getObjectLock

public ObjectLockConfiguration getObjectLock()

(Optional parameter) Object lock configuration for WORM protection.

getContentType

public String getContentType()

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