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

  • Method Details

    • getMetadata

      public Map<String,String> getMetadata()

    • builder

      public static UploadRequest.Builder builder()

    • toBuilder

      public UploadRequest.Builder toBuilder()
      Returns a UploadRequest.Builder pre-populated with this request's current field values, so callers can produce a modified copy without restating every field. Adding a new field to UploadRequest requires only extending this method (and the corresponding builder setter) — not every callsite that copies a request.

    • 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

    • isCreateIfAbsent

      public boolean isCreateIfAbsent()
      (Optional parameter) When true, the upload succeeds only if no live blob exists at the target key when the write is committed. The default is false, which preserves overwrite behavior. This option applies only to uploads using UploadRequest; multipart uploads do not honor it.

    • 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")

    • getOperationContext

      public OperationContext getOperationContext()
      (Optional parameter) Per-call observability context carrying the correlation ID. The correlation ID is never auto-generated; when it is null or missing it defaults to an empty string and tracing is treated as disabled. When supplied, it is echoed back via the response object.