com.netflix.conductor.common.utils

Interface ExternalPayloadStorage

public interface ExternalPayloadStorage

Interface used to externalize the storage of large JSON payloads in workflow and task input/output

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExternalPayloadStorage.Operation
static class	ExternalPayloadStorage.PayloadType

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	download(java.lang.String path) Download the json payload from the specified external storage location.
ExternalStorageLocation	getLocation(ExternalPayloadStorage.Operation operation, ExternalPayloadStorage.PayloadType payloadType, java.lang.String path) Obtain a uri used to store/access a json payload in external storage.
void	upload(java.lang.String path, java.io.InputStream payload, long payloadSize) Upload a json payload to the specified external storage location.

Method Detail

getLocation

ExternalStorageLocation getLocation(ExternalPayloadStorage.Operation operation,
                                    ExternalPayloadStorage.PayloadType payloadType,
                                    java.lang.String path)

Obtain a uri used to store/access a json payload in external storage.

Parameters:

operation - the type of ExternalPayloadStorage.Operation to be performed with the uri

payloadType - the ExternalPayloadStorage.PayloadType that is being accessed at the uri

path - (optional) the relative path for which the external storage location object is to be populated. If path is not specified, it will be computed and populated.

Returns:

a ExternalStorageLocation object which contains the uri and the path for the json payload

upload

void upload(java.lang.String path,
            java.io.InputStream payload,
            long payloadSize)

Upload a json payload to the specified external storage location.

Parameters:

path - the location to which the object is to be uploaded

payload - an InputStream containing the json payload which is to be uploaded

payloadSize - the size of the json payload in bytes

download

java.io.InputStream download(java.lang.String path)

Download the json payload from the specified external storage location.

Parameters:

path - the location from where the object is to be downloaded

Returns:

an InputStream of the json payload at the specified location