Pipeline Operations

Create a pipeline using a custom job file.

Requires permission matching: pipeline:write:default.<name>. Account must be eligible for custom jobs.

post/pipelines/custom

Request

Base URL
https://replace-with-account.api.decodable.co/v1alpha2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
  Token URLhttps://auth.decodable.co/oauth/token
  Scopeswrite:pipeline
TypeScript
https://skmtc.dev/decodable/apis/decodable-control-plane/docs/pipelines/custom/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring

The pipeline name.

descriptionstring

The pipeline description.

type'JAVA' | 'PYTHON'

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

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.

Response

A pipeline creation 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

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'

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.