Pipeline
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
A successful response.
An unexpected error response.
Given a list of node IDs, this function returns a map that associates each
node ID with a list of pipeline IDs it is connected to. If no results are
found, an empty map is returned. If the pipeline status field is empty in
the request, all pipeline statuses will be considered by default.
Similarly, if the pipeline type field is empty in the request, all pipeline
types will be considered by default. Please note that node IDs are required
for this function to work properly.
Fetch mapping of nodes to pipeline IDs.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
A successful response.
An unexpected error response.
Add a new pipeline with the given site_id, display_name and description.
This returns the pipeline object with fields like id, status, created_at,
updated_at.
Create a new pipeline.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
A successful response.
An unexpected error response.
Update the pipeline for the given id with the provided site_id,
display_name, description and status. If any change has happened on the
object in between, this call should fail. previous_update_time must be set
to the last available site's update time. This ensures that the object
hasn't updated in between.
Create a new pipeline.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
A successful response.
An unexpected error response.
Replace pipeline graph for the given pipeline_id with the given edges. A
new graph is created on every update request and linked to the pipeline
with it's the next_graph_version field. It returns the graph object. If no
version exists in the request, a new graph is created.
Upload or replace a pipeline graph.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
Disable analytics is a hack to prevent pipeline-graph creation API from
dereferencing SSA / PE nodes that are under construction. SSA and PE
nodes are created within a txn and RPC to create pipeline-subgraph and
deploy it is issued midway thru the txn. Because we attach analytics
subgraph in more complex topologies now such as on-the-sink-dummy (and not
just on the source node) the augmentation algorithm needs to know the
identity of nodes. With our current (broken) design with nodes and edges
of the graph being managed by different services, we either need to
abandon txn or use this hack so we prevent pipeline-service from trying
to augment the analytics subgraph being made for source-analytics.
Once we merge pipeline-manager and site-manager, we'll be ready to remove
this hack. We use disable and not enable here because this helps
contain the hack within pipeline and site-manager (which would eventually
merge and allow removal of this hack). Making it enable would require UI
to be aware of it and that would be worse.
A successful response.
An unexpected error response.
List all pipeline names across sites.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
A successful response.
An unexpected error response.
List all pipeline status types valid for given site(s). If no sites
provided, all possible statuses are returned.
List all possible pipeline status types.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
A successful response.
An unexpected error response.
Perform actions on pipeline (pause, resume, etc).
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
Graph version.
- NOP: No operation.
- DEPLOY: Deploy the pipeline.
- DELETE: Delete the pipeline.
- PAUSE: Pause the pipeline.
- BYPASS: Bypass the pipeline.
- CANCEL: Cancel the pending action.
NOPPossible values: A successful response.
An unexpected error response.
List all pipelines for the given sites. Can be filtered by pipeline_ids,
source_ids and statuses. This is a paginated API with values from [offset,
offset + page_size).
List all deployed pipelines.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
Optional. Pipelines will be filtered on site_ids, if present else no filtering on this.
Optional. Pipelines will be filtered on ids, if present else no filtering on this.
Optional. Sink ids of the pipelines, if present else no filtering on this.
Optional. Pipeline names of the pipelines, if present else no filtering on this.
A successful response.
An unexpected error response.
Download a serialized pipeline specification.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
ID here represents the ID of the pipeline in DB.
TODO: Default to latest pipeline if not specified
A successful response.
An unexpected error response.
Deprecated: Use PerformPipelineAction instead.
Deletes the pipeline with the specified ID.
JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'
ID of the pipeline to delete
Pipeline deleted successfully
Pipeline not found
Internal server error
Last updated
Was this helpful?