본문으로 건너뛰기

PipelineResponse

Data returned for Pipeline. Required fields are id, name, category, type, steps, item.

idId (string)필수

Server-assigned unique identifier

nameName (string)필수

Resource name

alias object

URL-safe short handle

하나 이상(anyOf)
string
categoryCategory (string)필수

Resource type tag

typeType (string)필수

Pipeline execution mode: 'batch' or 'event'

Possible values: [batch, event]

collection_id object

Parent collection ID

하나 이상(anyOf)
string
folder_id object

Identifier of the containing folder.

하나 이상(anyOf)
string
tags object

Classification labels

하나 이상(anyOf)
  • Array [
  • string
  • ]
  • description object

    Resource description

    하나 이상(anyOf)
    string
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    기본값: []
    created_at object

    Creation timestamp (Unix ms)

    하나 이상(anyOf)
    integer
    updated_at object

    Last update timestamp (Unix ms)

    하나 이상(anyOf)
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
  • idId (string)필수

    "user." | "group." | "public.all"

    typeType (string)필수

    Possible values: [user, group, public]

    display_nameDisplay Name (string)필수
    avatar_url object
    하나 이상(anyOf)
    string
    avatar_config object
    하나 이상(anyOf)
    object
    email object
    하나 이상(anyOf)
    string<email>
  • ]
  • my_share_scope object

    How the current caller received access to the resource.

    하나 이상(anyOf)
    string

    Possible values: [owner, grant, admin]

    steps object[]필수

    Execution steps

  • Array [
  • nameName (string)필수

    Step name

    alias object
    하나 이상(anyOf)
    string
    description object

    Step-owned description, independent of the referenced Code's description so steps sharing one Code can be labeled distinctly.

    하나 이상(anyOf)
    string
    script object

    Code resource ID to execute (code step)

    하나 이상(anyOf)
    string
    transform object

    Native transform spec (transform step)

    하나 이상(anyOf)
    op필수

    Possible values: [aggregate, join, rename_cast, select_filter, union]

    versionVersion (integer)
    상수 값: 1
    기본값: 1
    config object필수

    Config for the aggregate op: group-by + allowlisted aggregate functions. An empty group_by aggregates the whole input to a single row. input is a port key.

    inputInput (string)필수

    Input port key

    group_bystring[]

    Grouping columns (empty = whole-input aggregate)

    aggregations object[]필수

    Aggregations (non-empty)

  • Array [
  • functionFunction (string)필수

    Allowlisted aggregate function

    Possible values: [sum, count, avg, min, max]

    column object

    Aggregated column (omit only for count)

    하나 이상(anyOf)
    string
    aliasAlias (string)필수

    Output column name

  • ]
  • inputs object

    Input dataset mapping

    하나 이상(anyOf)
    object
    outputs object

    Output dataset mapping

    하나 이상(anyOf)
    object
    dependencies object

    List of dependent step names

    하나 이상(anyOf)
  • Array [
  • string
  • ]
  • options object
    하나 이상(anyOf)
    object
    secrets object

    Secret values to inject into contexts['secrets']

    하나 이상(anyOf)
  • Array [
  • nameName (string)필수

    contexts['secrets'] key the step reads

    refRef (string)필수

    Secret reference, e.g. secret://secret./token

  • ]
  • ]
  • options object
    하나 이상(anyOf)
    object
    metadata object
    하나 이상(anyOf)
    object
    itemItem (string)필수사용 중단
    PipelineResponse
    {
    "id": "string",
    "name": "string",
    "alias": "string",
    "category": "string",
    "type": "batch",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "string"
    ],
    "description": "string",
    "markings": [
    "string"
    ],
    "created_at": 0,
    "updated_at": 0,
    "owners": [
    {
    "id": "string",
    "type": "user",
    "display_name": "string",
    "avatar_url": "string",
    "avatar_config": {},
    "email": "user@example.com"
    }
    ],
    "my_share_scope": "owner",
    "steps": [
    {
    "name": "string",
    "alias": "string",
    "description": "string",
    "script": "string",
    "transform": {
    "version": 1,
    "op": "select_filter",
    "config": {
    "input": "string",
    "columns": [
    {
    "name": "string",
    "alias": "string"
    }
    ],
    "where": {
    "kind": "and",
    "conditions": [
    {
    "kind": "condition",
    "column": "string",
    "operator": "eq"
    },
    null
    ]
    }
    }
    },
    "inputs": {},
    "outputs": {},
    "dependencies": [
    "string"
    ],
    "options": {},
    "secrets": [
    {
    "name": "string",
    "ref": "string"
    }
    ]
    }
    ],
    "options": {},
    "metadata": {}
    }