Jobs

jobs

JobId

Bases: str

Unique ID of a job.

Job

Bases: BaseModel

Job.

job_id class-attribute instance-attribute

job_id = Field(
    description="Job ID.",
    validation_alias="jobId",
    serialization_alias="jobId",
)

status class-attribute instance-attribute

status = Field(description='Status of the job.')

job class-attribute instance-attribute

job = Field(description='Type of the job.')

queued class-attribute instance-attribute

queued = Field(
    description="Indicates whether the job is currently queued for execution."
)

attempts class-attribute instance-attribute

attempts = Field(
    description="Attempts of executing the job."
)

retry_limit class-attribute instance-attribute

retry_limit = Field(
    default=None,
    description="Maximum number of retries for the job.",
    validation_alias="retryLimit",
    serialization_alias="retryLimit",
)

retry_delay class-attribute instance-attribute

retry_delay = Field(
    description="Delay in seconds for retrying the job.",
    validation_alias="retryDelay",
    serialization_alias="retryDelay",
)

timeout class-attribute instance-attribute

timeout = Field(
    description="Timeout for an individual execution of the job (defaults to 30 minutes)."
)

created_at class-attribute instance-attribute

created_at = Field(
    description="Timestamp indicating when the job was created.",
    validation_alias="createdAt",
    serialization_alias="createdAt",
)

finished_at class-attribute instance-attribute

finished_at = Field(
    default=None,
    description="Timestamp indicating when the job has finished (if applicable).",
    validation_alias="finishedAt",
    serialization_alias="finishedAt",
)

QueryJobsAction

Bases: BaseModel

Query the jobs of the instance.

QueryJobsOutput

Bases: BaseModel

Output of querying the jobs of the instance.

jobs class-attribute instance-attribute

jobs = Field(description='List of jobs.')

JobStatus_Pending

Bases: RootModel[Literal['Pending']]

JobStatus_Completed

Bases: RootModel[Literal['Completed']]

JobStatus_Failed

Bases: RootModel[Literal['Failed']]

JobStatus_Expired

Bases: RootModel[Literal['Expired']]

JobStatus_Cancelled

Bases: RootModel[Literal['Cancelled']]

JobStatus

JobStatus = (
    JobStatus_Pending
    | JobStatus_Completed
    | JobStatus_Failed
    | JobStatus_Expired
    | JobStatus_Cancelled
)