Skip to content

Pipelines

ubiops pipelines

Command: ubiops pipelines

Alias: ubiops ppl


ubiops pipelines list

Command: ubiops pipelines list

Description:

List pipelines in project.

The option can be used to filter on specific labels.

Arguments: -

Options:

  • -lb/--labels
    Labels defined as key/value pairs
    This option can be provided multiple times in a single command

  • -fmt/--format
    The output format


ubiops pipelines get

Command: ubiops pipelines get

Description:

Get the pipeline settings, like, input_type and input_fields.

If you specify the option, this location will be used to store the pipeline structure in a yaml file. You can either specify the as file or directory. If the specified is a directory, the settings will be stored in pipeline.yaml.

Arguments:

  • [required] pipeline_name

Options:

  • -o/--output_path
    Path to file or directory to store pipeline yaml file

  • -q/--quiet
    Suppress informational messages

  • -fmt/--format
    The output format


ubiops pipelines create

Command: ubiops pipelines create

Description:

Create a new pipeline.

Define the pipeline parameters using a yaml file. For example:

pipeline_name: my-pipeline-name
pipeline_description: Pipeline created via command line.
pipeline_labels:
  my-key-1: my-label-1
  my-key-2: my-label-2
input_type: structured
input_fields:
  - name: my-pipeline-param1
    data_type: int
output_type: structured
output_fields:
  - name: my-pipeline-output1
    data_type: int

Possible input/output types: [structured, plain]. Possible data_types: [blob, int, string, double, bool, array_string, array_int, array_double].

Arguments:

  • pipeline_name

Options:

  • [required] -f/--yaml_file
    Path to a yaml file that contains at least the following fields: [input_type]

  • -fmt/--format
    The output format


ubiops pipelines update

Command: ubiops pipelines update

Description:

Update a pipeline.

If you only want to update the name of the pipeline or the default pipeline version, use the options <new_name> and <default_version>. If you want to update the pipeline input/output type and fields, please use a yaml file to define the new pipeline.

Please note that it's only possible to update the input of a pipeline for pipelines that have no pipeline versions with a connected pipeline start, that it's only possible to update the output of a pipeline for pipelines that have no pipeline versions with a connected pipeline end

Arguments:

  • [required] pipeline_name

Options:

  • -n/--new_name
    The new pipeline name

  • -f/--yaml_file
    Path to a yaml file that contains at least the following fields: [input_type]

  • -default/--default_version
    The name of the version that should become the default

  • -q/--quiet
    Suppress informational messages


ubiops pipelines delete

Command: ubiops pipelines delete

Description:

Delete a pipeline.

Arguments:

  • [required] pipeline_name

Options:

  • -y/--assume_yes
    Assume yes instead of asking for confirmation

  • -q/--quiet
    Suppress informational messages


ubiops pipelines complete

Command: ubiops pipelines complete

Description:

Create/Update a pipeline, version, and structure.

Use the option to update an existing pipeline or version. Without , a new pipeline will be created if it doesn't exist, and a new pipeline version will be created.

Define the pipeline parameters using a yaml file. For example:

pipeline_name: my-pipeline-name
pipeline_description: Pipeline created via command line.
pipeline_labels:
  my-key-1: my-label-1
  my-key-2: my-label-2
input_type: structured
input_fields:
  - name: my-pipeline-param1
    data_type: int
output_type: structured
output_fields:
  - name: my-pipeline-output1
    data_type: int
version_name: my-version-name
version_name: my-pipeline-version
version_description: Version created via command line.
version_labels:
  my-key-1: my-label-1
  my-key-2: my-label-2
request_retention_mode: none
request_retention_time: 604800
objects:
  - name: object1
    reference_name: my-deployment-name
    reference_version: my-deployment-version
attachments:
  - destination_name: object1
    sources:
      - source_name: pipeline_start
        mapping:
          - source_field_name: my-pipeline-param1
            destination_field_name: my-deployment-param1

Possible input/output types: [structured, plain]. Possible data_types: [blob, int, string, double, bool, array_string, array_int, array_double].

All object references must exist. Connect the objects in the pipeline using attachments. Please, connect the start of the pipeline version to your first object. You can do this by creating an attachment with a source with 'source_name: pipeline_start' and the name of your first object as destination 'destination_name: ...'. Connect the object output fields to destination_name 'pipeline_end', to retrieve the output as pipeline request result.

Arguments:

  • pipeline_name

Options:

  • -v/--version_name
    The version name

  • [required] -f/--yaml_file
    Path to a yaml file that contains at least the following fields: [input_type]

  • --overwrite
    Whether you want to overwrite if exists

  • -q/--quiet
    Suppress informational messages




ubiops pipelines requests

Command: ubiops pipelines requests


ubiops pipelines requests create

Command: ubiops pipelines requests create

Description:

Create a pipeline request. Pipeline requests are only stored for pipeline versions with request_retention_mode 'full' or 'metadata'.

Use the version option to make a request to a specific pipeline version: ubiops pipelines requests create <my-pipeline> -v <my-version> --data <input>

If not specified, a request is made to the default version: ubiops pipelines requests create <my-pipeline> --data <input>

Use --batch to make an asynchronous batch request: ubiops pipelines requests create <my-pipeline> --batch --data <input>

Multiple data inputs can be specified at ones and send as batch by using the '--data' options multiple times: ubiops pipelines requests create <my-pipeline> --batch --data <input-1> --data <input-2> --data <input-3>

For structured input, specify each data input as JSON formatted string. For example: ubiops pipelines requests create <my-pipeline> --data "{\"param1\": 1, \"param2\": \"two\"}"

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • --batch
    Whether you want to perform the request as batch request (async)

  • [required] --data
    The input data of the request
    This option can be provided multiple times in a single command

  • -fmt/--format
    The output format


ubiops pipelines requests get

Command: ubiops pipelines requests get

Description:

Get one or more pipeline requests. Pipeline requests are only stored for pipeline versions with request_retention_mode 'full' or 'metadata'.

Use the version option to get a request for a specific pipeline version. If not specified, the request is retrieved for the default version.

Multiple request ids can be specified at ones by using the '-id' options multiple times: ubiops pipelines requests get <my-pipeline> -v <my-version> -id <id-1> -id <id-2> -id <id-3>

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • [required] -id/--request_id
    The ID of the request
    This option can be provided multiple times in a single command

  • -fmt/--format
    The output format


ubiops pipelines requests list

Command: ubiops pipelines requests list

Description:

List pipeline requests. Pipeline requests are only stored for pipeline versions with request_retention_mode 'full' or 'metadata'.

Use the version option to list the requests for a specific pipeline version. If not specified, the requests are listed for the default version.

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • --offset

  • --limit
    Limit of the number of requests. The maximum value is 50.

  • -fmt/--format
    The output format


ubiops pipelines request

Command: ubiops pipelines request

Description:

[DEPRECATED] Create a pipeline request and retrieve the result.

Use the version option to make a request to a specific pipeline version: ubiops pipelines request <my-deployment> -v <my-version> --data <input>

If not specified, a request is made to the default version: ubiops pipelines request <my-deployment> --data <input>

For structured input, specify the data as JSON formatted string. For example: ubiops pipelines request <my-deployment> --data "{\"param1\": 1, \"param2\": \"two\"}"

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • [required] -d/--data
    The input data of the request

  • -pt/--pipeline_timeout
    Timeout for the entire pipeline request in seconds

  • -dt/--deployment_timeout
    Timeout for each deployment request in the pipeline in seconds

  • -fmt/--format
    The output format




ubiops pipelines batch_requests

Command: ubiops pipelines batch_requests


ubiops pipelines batch_requests create

Command: ubiops pipelines batch_requests create

Description:

[DEPRECATED] Create a pipeline batch request and retrieve request IDs to collect the results later. Pipeline requests are only stored for pipeline versions with request_retention_mode 'full' or 'metadata'.

Use the version option to make a batch request to a specific pipeline version: ubiops pipelines batch_requests create <my-pipeline> -v <my-version> --data <input>

If not specified, a batch request is made to the default version: ubiops pipelines batch_requests create <my-pipeline> --data <input>

Multiple data inputs can be specified at ones by using the '--data' options multiple times: ubiops pipelines batch_requests create <my-pipeline> --data <input-1> --data <input-2> --data <input-3>

For structured input, specify each data input as JSON formatted string. For example: ubiops pipelines batch_requests create <my-pipeline> --data "{\"param1\": 1, \"param2\": \"two\"}"

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • [required] --data
    The input data of the request
    This option can be provided multiple times in a single command

  • -fmt/--format
    The output format


ubiops pipelines batch_requests get

Command: ubiops pipelines batch_requests get

Description:

[DEPRECATED] Get the results of one or more pipeline batch requests. Pipeline requests are only stored for pipeline versions with request_retention_mode 'full' or 'metadata'.

Use the version option to get a batch request for a specific pipeline version. If not specified, the batch request is retrieved for the default version.

Multiple request ids can be specified at ones by using the '-id' options multiple times: ubiops pipelines batch_requests get <my-pipeline> -v <my-version> -id <id-1> -id <id-2> -id <id-3>

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • [required] -id/--request_id
    The ID of the request
    This option can be provided multiple times in a single command

  • -fmt/--format
    The output format


ubiops pipelines batch_requests list

Command: ubiops pipelines batch_requests list

Description:

[DEPRECATED] List pipeline batch requests. Pipeline requests are only stored for pipeline versions with request_retention_mode 'full' or 'metadata'.

Use the version option to list the batch requests for a specific pipeline version. If not specified, the batch requests are listed for the default version.

Arguments:

  • [required] pipeline_name

Options:

  • -v/--version_name
    The version name

  • --offset

  • --limit
    Limit of the number of requests. The maximum value is 50.

  • -fmt/--format
    The output format