src.api.catacloud.caclpipeline_ops

Classes

class src.api.catacloud.caclpipeline_ops.CaClPipelineOps(ses: CaClSession)

Class that supports operations on pipeline specifications in the Catacloud platform through its API (typically defined as JSON files).

Variables:: pagination_size (int) – The pagination size to be used when retrieving the list of available pipelines.

__init__(ses: CaClSession): Instantiate a Catacloud pipeline operations object.

ls()

List the available pipeline specifications in the Catacloud platform.

rm(pipeline_id)

Remove a pipeline’s JSON specification from the Catacloud platform.

Parameters:: pipeline_id (str) – The identifier of the pipeline specification to be removed from the Catacloud platform.
Returns:: Dictionary with the contents of the answer to the request.
Return type:: dict

pull(file_id, out_path)

Download a pipeline specification file given its file id from the Catacloud platform.

Parameters:

file_id (str) – The identifier of the pipeline specification file to download.
out_path (str) – The local path where the downloaded pipeline specification will be written.

Returns:

Nothing at all but the pipeline specification file is written to the specified local path.

Return type:

None

push(json_path, pipeline_description=None)

Upload a JSON specifying a pipeline to the Catacloud platform.

Parameters:

json_path (str) – Path to the JSON to upload.
pipeline_description (str or None) – The description (optional) for the pipeline.

Returns:

Nothing at all.