stop_ingestion_job¶
Operation¶
async
¶
stop_ingestion_job(input: StopIngestionJobInput, plugins: list[Plugin] | None = None) -> StopIngestionJobOutput
Stops a currently running data ingestion job. You can send a
StartIngestionJob request again to ingest the rest of your data when
you are ready.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StopIngestionJobInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
StopIngestionJobOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for StopIngestionJobInput structure.
Attributes¶
class-attribute
instance-attribute
¶
data_source_id: str | None = None
The unique identifier of the data source for the data ingestion job you want to stop.
class-attribute
instance-attribute
¶
ingestion_job_id: str | None = None
The unique identifier of the data ingestion job you want to stop.
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base for the data ingestion job you want to stop.
Output¶
dataclass
¶
Dataclass for StopIngestionJobOutput structure.
Attributes¶
instance-attribute
¶
ingestion_job: IngestionJob
Contains information about the stopped data ingestion job.