DEdecodable
Pipeline Operations

Get pipeline information by id.

Requires permission matching: pipeline:read:default.<name>.

get/pipelines/{id}

Request

Query parameters

view'basic' | 'full'

The amount of data to return for the resource(s).

A value of basic returns the standard properties of the resource. It may also produce data that is considered "computationally cheap" to return. Specifying basic is the same as omitting this parameter.

The behavior of full is service-dependent, but generally includes more fields. This can mean additional status or version data, or even expanding references to contained resources. This should be used when the cost of an additional API roundtrip is greater than the overhead of the request.

integer

A version number of a resource

OR
'active' | 'latest' | 'all'

A version tag of a resource

Example:1

A version of a resource. It can be a version number or a version selector.

Response

A pipeline get response.

idstring required

An opaque ID, created by Decodable, that uniquely identifies a resource.

namestring required

The pipeline name.

descriptionstring

The pipeline description.

type'JAVA' | 'PYTHON' required

The type of the custom pipeline. Consumers should be able to gracefully handle new values in future API versions.

sqlstring

The pipeline SQL.

job_file_shastring

SHA512 hash of the job file. Must reference a file that was previously uploaded using the /files endpoints.

job_argumentsstring

Argument string input to the custom pipeline program.

entry_classstring

Name of the entry class to run for this custom Java-based pipeline (optional). If not present, the class to run must be specified in the file META-INF/MANIFEST.MF within the job's JAR file, using the Main-Class property key.

versioninteger required

A version number of a resource

is_latestboolean

describe if a versioned resource is the latest version

active_versioninteger nullable

The active version of the pipeline

latest_versioninteger

The latest version of the pipeline

last_activated_timestring date-time

The date and time this object was last activated.

target_state'RUNNING' | 'STOPPED'
actual_state'UNKNOWN' | 'STARTING' | 'RUNNING' | 'FAILED' | 'FINISHED' | 'STOPPED' | 'PAUSING' | 'PAUSED'
create_timestring date-time required

The date and time the resource was created.

update_timestring date-time

The date and time the resource was updated.

requested_tasksinteger

the number of tasks to be allocated to an object when it is activated

actual_tasksinteger

the number of tasks actively in use by an object

requested_task_sizestring nullable

the task size to be allocated to an object when it is activated

actual_task_sizestring nullable

the task size actively in use by an object

Example response

{
  "operator-chaining": "true"
}

Changes

No recorded changes to this operation across all 1 revision of this API.