Package software.amazon.payloadoffloading

Interface PayloadStoreAsync

All Known Implementing Classes:
S3BackedPayloadStoreAsync
public interface PayloadStoreAsync
An AWS storage service that supports saving high payload sizes.

  • Method Details

    • storeOriginalPayload

      CompletableFuture<String> storeOriginalPayload(String payload)
      Stores payload in a store that has higher payload size limit than that is supported by original payload store.

      This call is asynchronous, and so documented return values and exceptions are propagated through the returned CompletableFuture.

      Parameters:
      payload -
      Returns:
      future value of a pointer that must be used to retrieve the original payload later.
      Throws:
      software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response. For example if a network connection is not available.
      software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating either a problem with the data in the request, or a server side issue.

    • storeOriginalPayload

      CompletableFuture<String> storeOriginalPayload(String payload, String s3Key)
      Stores payload in a store that has higher payload size limit than that is supported by original payload store.

      This call is asynchronous, and so documented return values and exceptions are propagated through the returned CompletableFuture.

      Parameters:
      payload -
      s3Key -
      Returns:
      future value of a pointer that must be used to retrieve the original payload later.
      Throws:
      software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response. For example if a network connection is not available.
      software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating either a problem with the data in the request, or a server side issue.

    • getOriginalPayload

      CompletableFuture<String> getOriginalPayload(String payloadPointer)
      Retrieves the original payload using the given payloadPointer. The pointer must have been obtained using storeOriginalPayload(String)

      This call is asynchronous, and so documented return values and exceptions are propagated through the returned CompletableFuture.

      Parameters:
      payloadPointer -
      Returns:
      future value of the original payload
      Throws:
      software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response. For example if payloadPointer is invalid or a network connection is not available.
      software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating a server side issue.

    • deleteOriginalPayload

      CompletableFuture<Void> deleteOriginalPayload(String payloadPointer)
      Deletes the original payload using the given payloadPointer. The pointer must have been obtained using storeOriginalPayload(String)

      This call is asynchronous, and so documented return values and exceptions are propagated through the returned CompletableFuture.

      Parameters:
      payloadPointer -
      Returns:
      future value that completes when the delete operation finishes
      Throws:
      software.amazon.awssdk.core.exception.SdkClientException - If any internal errors are encountered on the client side while attempting to make the request or handle the response to/from PayloadStore. For example, if payloadPointer is invalid or a network connection is not available.
      software.amazon.awssdk.services.s3.model.S3Exception - If an error response is returned by actual PayloadStore indicating a server side issue.