Skip to main content

module ingestion_pipeline_mixin

Mixin class containing ingestion pipeline specific methods To be used by OpenMetadata class

class OMetaIngestionPipelineMixin

OpenMetadata API methods related to ingestion pipeline. To be inherited by OpenMetadata

method create_or_update_pipeline_status

create_or_update_pipeline_status(
    ingestion_pipeline_fqn: str,
    pipeline_status: PipelineStatus
) → None
PUT create or update pipeline status Args: ingestion_pipeline_fqn: Ingestion Pipeline FQN pipeline_status: Pipeline Status data to add

method get_ingestion_pipeline_by_name

get_ingestion_pipeline_by_name(
    fields: Optional[List[str]] = None,
    params: Optional[Dict[str, str]] = None
) → Optional[IngestionPipeline]
Get ingestion pipeline statues based on name Args:
  • name (str): Ingestion Pipeline Name
  • fields (List[str]): List of all the fields

method get_pipeline_status

get_pipeline_status(
    ingestion_pipeline_fqn: str,
    pipeline_status_run_id: str
) → Optional[PipelineStatus]
GET pipeline status Args: ingestion_pipeline_fqn: Ingestion Pipeline FQN pipeline_status_run_id: Pipeline Status run id

method get_pipeline_status_between_ts

get_pipeline_status_between_ts(
    ingestion_pipeline_fqn: str,
    start_ts: int,
    end_ts: int
) → Optional[List[PipelineStatus]]
Get pipeline status between timestamp Args:
  • ingestion_pipeline_fqn (str): pipeline fqn
  • start_ts (int): start_ts
  • end_ts (int): end_ts

method run_pipeline

run_pipeline(ingestion_pipeline_id: str) → IngestionPipeline
Run ingestion pipeline workflow Args:
  • ingestion_pipeline_id (str): ingestion pipeline uuid