Get pipeline plan (next)

How the current version syncs, from the source's latest catalog: each stream's delivery level and what sets it. The plan has no changes.

GET

/v1/workspaces/{workspace}/pipelines/{pipeline}/plan

How the current version syncs, from the source's latest catalog: each stream's delivery level and what sets it. The plan has no changes.

Path Parameters

workspace*string

The workspace id.

pipeline*string

The pipeline id.

Response Body

application/json

response

plan?

PipelinePlan is how a pipeline version would sync, as far as the control plane can tell from the source's latest catalog and the destination's capabilities.

Example Request

curl -X GET 'http://localhost:8080/v1/workspaces/string/pipelines/string/plan'

Example Request

curl -X GET 'http://localhost:8080/v1/workspaces/string/pipelines/string/plan'

Example ResponseSchema

{
  "plan": {
    "pipeline": "string",
    "version": "string",
    "changes": [
      {
        "field": "string",
        "before": "string",
        "after": "string"
      }
    ],
    "streams": [
      {
        "name": "string",
        "level": "DELIVERY_LEVEL_UNSPECIFIED",
        "dedupe": true,
        "reason": "string",
        "collapse": true,
        "write": "WRITE_MODE_UNSPECIFIED",
        "typeChanges": true,
        "paused": true,
        "table": "string"
      }
    ],
    "problems": [
      "string"
    ],
    "notes": [
      "string"
    ],
    "warnings": [
      {
        "stream": "string",
        "message": "string"
      }
    ],
    "job": {
      "size": {
        "preset": "string",
        "cpuMillis": "string",
        "memoryBytes": "string"
      },
      "reason": "JOB_SIZE_REASON_UNSPECIFIED",
      "pool": "string"
    },
    "overrides": [
      {
        "field": "string",
        "value": "string",
        "specValue": "string",
        "reason": "string",
        "incident": "string",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

{  "plan": {    "pipeline": "string",    "version": "string",    "changes": [      {        "field": "string",        "before": "string",        "after": "string"      }    ],    "streams": [      {        "name": "string",        "level": "DELIVERY_LEVEL_UNSPECIFIED",        "dedupe": true,        "reason": "string",        "collapse": true,        "write": "WRITE_MODE_UNSPECIFIED",        "typeChanges": true,        "paused": true,        "table": "string"      }    ],    "problems": [      "string"    ],    "notes": [      "string"    ],    "warnings": [      {        "stream": "string",        "message": "string"      }    ],    "job": {      "size": {        "preset": "string",        "cpuMillis": "string",        "memoryBytes": "string"      },      "reason": "JOB_SIZE_REASON_UNSPECIFIED",      "pool": "string"    },    "overrides": [      {        "field": "string",        "value": "string",        "specValue": "string",        "reason": "string",        "incident": "string",        "updateTime": "2019-08-24T14:15:22Z"      }    ]  }}

Get pipeline plan

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Path Parameters

Response Body