json.schema.api.services.ingestionPipelines.createIngestionPipeline.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.1

{
  "$id": "https://open-metadata.org/schema/api/services/ingestionPipelines/createIngestionPipeline.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateIngestionPipelineRequest",
  "description": "Ingestion Pipeline Config is used to set up an Airflow DAG.",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.services.ingestionPipelines.CreateIngestionPipeline",
  "javaInterfaces": ["org.openmetadata.schema.CreateEntity"],
  "properties": {
    "name": {
      "description": "Name that identifies this pipeline instance uniquely.",
      "$ref": "../../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this ingestion pipeline.",
      "type": "string"
    },
    "description": {
      "description": "Description of the pipeline.",
      "$ref": "../../../type/basic.json#/definitions/markdown"
    },
    "pipelineType": {
      "$ref": "../../../entity/services/ingestionPipelines/ingestionPipeline.json#/definitions/pipelineType"
    },
    "sourceConfig": {
      "$ref": "../../../metadataIngestion/workflow.json#/definitions/sourceConfig"
    },
    "airflowConfig": {
      "$ref": "../../../entity/services/ingestionPipelines/ingestionPipeline.json#/definitions/airflowConfig"
    },
    "loggerLevel": {
      "description": "Set the logging level for the workflow.",
      "$ref": "../../../metadataIngestion/workflow.json#/definitions/logLevels"
    },
    "service": {
      "description": "Link to the service for which ingestion pipeline is ingesting the metadata.",
      "$ref": "../../../type/entityReference.json"
    },
    "owners": {
      "description": "Owner of this Ingestion Pipeline.",
      "$ref": "../../../type/entityReferenceList.json",
      "default": null
    },
    "domain" : {
      "description": "Fully qualified name of the domain the Table belongs to.",
      "type": "string"
    }
  },
  "required": [
    "name",
    "service",
    "pipelineType",
    "sourceConfig",
    "airflowConfig"
  ],
  "additionalProperties": false
}