Skip to content

JobListEntry

Source code in docs_src/capo_snowball/types/job_list_entry.py
class JobListEntry(TypedDict, closed=True):
    job_id: NotRequired["capo_snowball.types.string.String"]
    """<p>The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</p>"""
    job_state: NotRequired["capo_snowball.types.job_state.JobState"]
    """<p>The current state of this job.</p>"""
    is_master: "capo_snowball.types.boolean.Boolean"
    """<p>A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.</p>"""
    job_type: NotRequired["capo_snowball.types.job_type.JobType"]
    """<p>The type of job.</p>"""
    snowball_type: NotRequired["capo_snowball.types.snowball_type.SnowballType"]
    """<p>The type of device used with this job.</p>"""
    creation_date: NotRequired["capo_snowball.types.timestamp.Timestamp"]
    """<p>The creation date for this job.</p>"""
    description: NotRequired["capo_snowball.types.string.String"]
    """<p>The optional description of this specific job, for example <code>Important Photos 2016-08-11</code>.</p>"""

creation_date instance-attribute

creation_date: NotRequired[Timestamp]

The creation date for this job.

description instance-attribute

description: NotRequired[String]

The optional description of this specific job, for example Important Photos 2016-08-11.

is_master instance-attribute

is_master: Boolean

A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.

job_id instance-attribute

job_id: NotRequired[String]

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

job_state instance-attribute

job_state: NotRequired[JobState]

The current state of this job.

job_type instance-attribute

job_type: NotRequired[JobType]

The type of job.

snowball_type instance-attribute

snowball_type: NotRequired[SnowballType]

The type of device used with this job.