Skip to content
Framework Docs

Get Pipeline Data Source Status

ManagedIngestionStatusResponse pipelines().dataSources().getStatus(DataSourceGetStatusParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status

Get the status of a data source for a pipeline.

ParametersExpand Collapse
DataSourceGetStatusParams params
String pipelineId
Optional<String> dataSourceId
ReturnsExpand Collapse
class ManagedIngestionStatusResponse:
Status status

Status of the ingestion.

One of the following:
NOT_STARTED("NOT_STARTED")
IN_PROGRESS("IN_PROGRESS")
SUCCESS("SUCCESS")
ERROR("ERROR")
PARTIAL_SUCCESS("PARTIAL_SUCCESS")
CANCELLED("CANCELLED")
Optional<LocalDateTime> deploymentDate

Date of the deployment.

formatdate-time
Optional<LocalDateTime> effectiveAt

When the status is effective

formatdate-time
Optional<List<Error>> error

List of errors that occurred during ingestion.

String jobId

ID of the job that failed.

formatuuid
String message

List of errors that occurred during ingestion.

Step step

Name of the job that failed.

One of the following:
MANAGED_INGESTION("MANAGED_INGESTION")
DATA_SOURCE("DATA_SOURCE")
FILE_UPDATER("FILE_UPDATER")
PARSE("PARSE")
TRANSFORM("TRANSFORM")
INGESTION("INGESTION")
METADATA_UPDATE("METADATA_UPDATE")
Optional<String> jobId

ID of the latest job.

formatuuid

Get Pipeline Data Source Status

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.pipelines.ManagedIngestionStatusResponse;
import com.llamacloud_prod.api.models.pipelines.datasources.DataSourceGetStatusParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        DataSourceGetStatusParams params = DataSourceGetStatusParams.builder()
            .pipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .dataSourceId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .build();
        ManagedIngestionStatusResponse managedIngestionStatusResponse = client.pipelines().dataSources().getStatus(params);
    }
}
{
  "status": "NOT_STARTED",
  "deployment_date": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error": [
    {
      "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "message": "message",
      "step": "MANAGED_INGESTION"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
Returns Examples
{
  "status": "NOT_STARTED",
  "deployment_date": "2019-12-27T18:11:19.117Z",
  "effective_at": "2019-12-27T18:11:19.117Z",
  "error": [
    {
      "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "message": "message",
      "step": "MANAGED_INGESTION"
    }
  ],
  "job_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}