OpenMetadata/docs/openmetadata-apis/schemas/entities/pipelineservice.md

Pipeline Service

This schema defines the Pipeline Service entity, such as Airflow and Prefect.

$id: https://open-metadata.org/schema/entity/services/messagingservice.json

Type: object

This schema does not accept additional properties.

Properties

• id required
  • Unique identifier of this pipeline service instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this pipeline service.
  • Type: string
  • The value must match this pattern: ^[^.]*$
  • Length: between 1 and 128
• serviceType
  • Type of pipeline service such as Airflow or Prefect...
  • $ref: #/definitions/pipelineServiceType
• description
  • Description of a pipeline service instance.
  • Type: string
• displayName
  • Display Name that identifies this pipeline service. It could be title or label from the source services.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• pipelineUrl required
  • Pipeline Service Management/UI URL.
  • Type: string
  • String format must be a "uri"
• ingestionSchedule
  • Schedule for running metadata ingestion jobs.
  • $ref: ../../type/schedule.json
• owner
  • Owner of this pipeline service.
  • $ref: ../../type/entityReference.json
• href
  • Link to the resource corresponding to this pipeline service.
  • $ref: ../../type/basic.json#/definitions/href
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

Type definitions in this schema

pipelineServiceType

• Type of pipeline service - Airflow or Prefect.
• Type: string
• The value is restricted to the following:
  1. "Airflow"
  2. "Prefect"
  3. "Glue"
  4. "Generic"

This document was updated on: Monday, March 7, 2022