Interface JobPollPayload

Returned when the job is pending, running, failed, cancelled, cancel_pending, or timeout.

interface JobPollPayload {
    error_code?: string;
    jobId: string;
    message?: string;
    status: FireflyApiClient.JobPollPayloadStatus;
}

Index

Properties

error_code? jobId message? status

Properties

`Optional`error_code

error_code?: string

Error code present when status is failed, cancelled, cancel_pending, or timeout.

jobId

jobId: string

The job ID.

`Optional`message

message?: string

Human-readable string describing the error or status.

status

status: FireflyApiClient.JobPollPayloadStatus