com.sdl.delivery.deployer.api.processing.pipeline

Interface StepDataStore

public interface StepDataStore

Provide operations to store and retrieve step data by different criteria.

Method Summary

Modifier and Type	Method and Description
void	deleteStepDataFromBS(String location) Search for step data in state store which has binary associated.
List<StepData>	findData(String executionId) Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution'.
List<StepData>	findData(String executionId, Set<String> keys) Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution' that contain the properties referenced by the given keys.
List<StepData>	findData(String executionId, String key) Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution' that contain a property referenced by the given key.
List<StepData>	findData(String executionId, String pipelineId, String stepId) Find the list of 'Step Data' for the given step in the scope of the referenced 'Deployment Execution'.
Optional<StepData>	findData(String executionId, String pipelineId, String stepId, String key) Find the 'Step Data' as optional for given step in the scope of the reference 'Deployment Execution'.
List<StepData>	findDataWhereKeyStartsWith(String executionId, String keyPrefix) Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution' that contain a property which key starts with the provided key prefix.
List<String>	findStepDataKeys(String executionId, String keyPrefix) Find the list of 'Step Data Keys' for all the steps in the scope of the referenced 'Deployment Execution' that contain a property which key starts with the provided key prefix.
List<String>	getBinaryStepDataForRemove(String executionId) Search for step data in state store which has binary associated.
void	removeData(String executionId, String key) Remove 'Step Data' identified by given key for a particular execution id.
void	removeDataWhereKeyStartsWith(String executionId, String keyPrefix) Remove all 'Step Data' identified by given key prefix for a particular execution id.
void	storeData(String executionId, String pipelineId, String stepId, ExecutableStepResult stepResults) Store some 'Executable Step Results' for the given step in the scope of the referenced 'Deployment Execution'.

Method Detail

storeData

void storeData(String executionId,
               String pipelineId,
               String stepId,
               ExecutableStepResult stepResults)
        throws ProcessingException

Store some 'Executable Step Results' for the given step in the scope of the referenced 'Deployment Execution'.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

pipelineId - The id of the pipeline containing the step to set the status for.

stepId - The id of the step to set the status for.

stepResults - The executable step result step data to be stored.

Throws:

ProcessingException

findData

List<StepData> findData(String executionId,
                        String pipelineId,
                        String stepId)

Find the list of 'Step Data' for the given step in the scope of the referenced 'Deployment Execution'.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

pipelineId - The id of the pipeline containing the step to set the status for.

stepId - The id of the step to set the status for.

Returns:

The list of 'Step Data'.

findData

List<StepData> findData(String executionId)

Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution'.

Parameters:

executionId - The id of the referenced 'Deployment Execution'.

Returns:

The list of 'Step Data'.

findData

List<StepData> findData(String executionId,
                        String key)

Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution' that contain a property referenced by the given key.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

key - The given property key.

Returns:

The list of 'Step Data'.

findDataWhereKeyStartsWith

List<StepData> findDataWhereKeyStartsWith(String executionId,
                                          String keyPrefix)

Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution' that contain a property which key starts with the provided key prefix.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

keyPrefix - The given property key prefix.

Returns:

The list of 'Step Data'.

findStepDataKeys

List<String> findStepDataKeys(String executionId,
                              String keyPrefix)

Find the list of 'Step Data Keys' for all the steps in the scope of the referenced 'Deployment Execution' that contain a property which key starts with the provided key prefix.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

keyPrefix - The given property key prefix.

Returns:

The list of keys for 'Step Data'.

removeData

void removeData(String executionId,
                String key)

Remove 'Step Data' identified by given key for a particular execution id.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

key - The given property key.

removeDataWhereKeyStartsWith

void removeDataWhereKeyStartsWith(String executionId,
                                  String keyPrefix)

Remove all 'Step Data' identified by given key prefix for a particular execution id.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

keyPrefix - The given property key prefix.

findData

List<StepData> findData(String executionId,
                        Set<String> keys)

Find the list of 'Step Data' for all the steps in the scope of the referenced 'Deployment Execution' that contain the properties referenced by the given keys.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

keys - The given property keys.

Returns:

The list of 'Step Data'.

findData

Optional<StepData> findData(String executionId,
                            String pipelineId,
                            String stepId,
                            String key)

Find the 'Step Data' as optional for given step in the scope of the reference 'Deployment Execution'.

Parameters:

executionId - The id. of the referenced 'Deployment Execution'.

pipelineId - The id. of the pipeline containing the step to set the status for.

stepId - The id. of the step to set the status for.

key - The given property key.

Returns:

'Step Data'.

getBinaryStepDataForRemove

List<String> getBinaryStepDataForRemove(String executionId)

Search for step data in state store which has binary associated. It will collect id's for delete ONLY the binary step data from the binary storage.

Parameters:

executionId - The execution id where this step data is associated with

deleteStepDataFromBS

void deleteStepDataFromBS(String location)

Search for step data in state store which has binary associated. It will delete ONLY the binary step data from the binary storage.

Parameters:

location - The location of binary in storage