mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-31 10:39:30 +00:00
3.7 KiB
3.7 KiB
| title | slug |
|---|---|
| Ingestion Pipeline Mixin | /sdk/python/api-reference/ingestion-pipeline-mixin |
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
:param ingestion_pipeline_fqn: Ingestion Pipeline FQN :param 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 Namefields(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
:param ingestion_pipeline_fqn: Ingestion Pipeline FQN :param 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 fqnstart_ts(int): start_tsend_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