DEdecodable
Pipeline Operations

Create a pipeline.

Requires permissions matching:

  • pipeline:write:default.<name>
  • stream:read-data:default.<stream-name> on input streams
  • stream:write-data:default.<stream-name> on output streams
post/pipelines

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
    A function with typed inputs. Its response is checked against the schema.

Request body

namestring

The pipeline name.

descriptionstring

The pipeline description.

sqlstring

The pipeline SQL.

Example request

{
  "sql": "INSERT INTO stream_out\nSELECT ...\nFROM stream_in\n",
  "autoscale_configuration": {
    "pause_conditions": {
      "max_record_read_rate": {
        "record_count": "100",
        "duration_seconds": "300"
      },
      "max_job_runtime": {
        "duration_seconds": "3600"
      }
    },
    "resume_conditions": {
      "schedule": {
        "cron_expression": "0 8 * * *"
      }
    }
  }
}

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

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.