adobe-firefly-sdk
    Preparing search index...

    Type Alias JobPollPayload

    JobPollPayload

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

    type JobPollPayload = {
        error_code?: string;
        jobId: string;
        message?: string;
        status:
            | "pending"
            | "running"
            | "failed"
            | "cancelled"
            | "cancel_pending"
            | "timeout";
    }
    Index

    Properties

    error_code? jobId message? status

    Properties

    error_code?: string

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

    jobId: string

    The job ID.

    message?: string

    Human-readable string describing the error or status.

    status:
        | "pending"
        | "running"
        | "failed"
        | "cancelled"
        | "cancel_pending"
        | "timeout"

    Current non-succeeded job status.

    Settings

    Member Visibility

    On This Page

    Properties