mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-13 20:18:24 +00:00
32 lines
1.9 KiB
Markdown
32 lines
1.9 KiB
Markdown
|
---
|
||
|
|
title: createPipeline
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/api/data/createpipeline
|
||
|
|
---
|
||
|
|
|
||
|
|
# CreatePipelineRequest
|
||
|
|
|
||
|
|
*Create Pipeline entity request*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`name`**: Name that identifies this pipeline instance uniquely. Refer to *../../entity/data/pipeline.json#/definitions/entityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name that identifies this Pipeline. It could be title or label from the source services.
|
||
|
|
- **`description`**: Description of the pipeline instance. What it has and how to use it. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`sourceUrl`**: Pipeline URL suffix to visit/manage. This URL points to respective pipeline service UI. Refer to *../../type/basic.json#/definitions/sourceUrl*.
|
||
|
|
- **`concurrency`** *(integer)*: Concurrency of the Pipeline.
|
||
|
|
- **`pipelineLocation`** *(string)*: Pipeline Code Location.
|
||
|
|
- **`startDate`**: Start date of the workflow. Refer to *../../type/basic.json#/definitions/dateTime*.
|
||
|
|
- **`tasks`** *(array)*: All the tasks that are part of pipeline. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../entity/data/pipeline.json#/definitions/task*.
|
||
|
|
- **`tags`** *(array)*: Tags for this Pipeline. Default: `None`.
|
||
|
|
- **Items**: Refer to *../../type/tagLabel.json*.
|
||
|
|
- **`owner`**: Owner of this pipeline. Refer to *../../type/entityReference.json*.
|
||
|
|
- **`service`**: Link to the pipeline service fqn where this pipeline is hosted in. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`extension`**: Entity extension data with custom attributes added to the entity. Refer to *../../type/basic.json#/definitions/entityExtension*.
|
||
|
|
- **`scheduleInterval`** *(string)*: Scheduler Interval for the pipeline in cron format. Default: `None`.
|
||
|
|
- **`domain`** *(string)*: Fully qualified name of the domain the Pipeline belongs to.
|
||
|
|
- **`lifeCycle`**: Life Cycle of the entity. Refer to *../../type/lifeCycle.json*.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2023-10-27 13:55:46.343512.
|