Package 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	Description
static enum	ExternalPayloadStorage.Operation
static enum	ExternalPayloadStorage.PayloadType

Method Summary

Modifier and Type	Method	Description
InputStream	download(String path)	Download the json payload from the specified external storage location.
ExternalStorageLocation	getLocation(ExternalPayloadStorage.Operation operation, ExternalPayloadStorage.PayloadType payloadType, String path)	Obtain a uri used to store/access a json payload in external storage.
default ExternalStorageLocation	getLocation(ExternalPayloadStorage.Operation operation, ExternalPayloadStorage.PayloadType payloadType, String path, byte[] payloadBytes)	Obtain an uri used to store/access a json payload in external storage with deduplication of data based on payloadBytes digest.
void	upload(String path, InputStream payload, long payloadSize)	Upload a json payload to the specified external storage location.

Method Details

getLocation

ExternalStorageLocation getLocation(ExternalPayloadStorage.Operation operation,
 ExternalPayloadStorage.PayloadType payloadType,
 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

getLocation

default ExternalStorageLocation getLocation(ExternalPayloadStorage.Operation operation,
 ExternalPayloadStorage.PayloadType payloadType,
 String path,
 byte[] payloadBytes)

Obtain an uri used to store/access a json payload in external storage with deduplication of data based on payloadBytes digest.

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.

payloadBytes - for calculating digest which is used for objectKey

Returns:

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

upload

void upload(String path,
 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

InputStream download(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