Interface Job

interface Job {
    _id: string;
    attempt: number;
    batch?: any;
    compute_provider_id: string;
    config: {
        [key: string]: any;
    };
    created: string;
    destination: {
        id: string;
        type: string;
    };
    failure_reason?: string;
    gear_id: string;
    gear_info: {
        capabilities?: string[];
        category: string;
        description?: string;
        id: string;
        name: string;
        version: string;
    };
    id?: string;
    inputs: JobInput[];
    label: string;
    modified: string;
    origin: {
        id: string;
        type: OriginType;
    };
    outputs: File[];
    parent_info?: {
        [container: string]: {
            _id: string;
            label: string;
        } | null;
    };
    parents: {
        [container: string]: string | null;
    };
    previous_job_id?: string;
    priority?: JobPriority;
    produced_metadata: {
        [key: string]: any;
    };
    profile: {
        elapsed_time_ms: number;
        executor?: {
            cpu_cores: number;
            disk_bytes: number;
            gpu: boolean;
            host: string;
            instance_type: string;
            memory_bytes: number;
            name: string;
            swap_bytes: number;
        };
        preparation_time_ms: number;
        total_input_files: number;
        total_input_size_bytes: number;
        total_output_files: number;
        total_output_size_bytes: number;
        total_time_ms: number;
        upload_time_ms: number;
        versions: {
            [component: string]: string;
        };
    };
    related_container_ids: string[];
    request: {
        inputs: {
            location: string;
            type: string;
            uri: string;
            vu: string;
        }[];
        outputs: {
            location: string;
            type: string;
            uri: string;
            vu: string;
        }[];
        target: {
            command: string[];
            dir: string;
            env: {
                [name: string]: string;
            };
            gid: string;
            uid: string;
        };
    };
    retried: string;
    role_id?: string;
    rule_id?: string;
    saved_files: string[];
    state: JobState;
    tags: string[];
    transitions: {
        cancelled?: string;
        complete?: string;
        failed?: string;
        running?: string;
    };
}

Properties

_id attempt batch? compute_provider_id config created destination failure_reason? gear_id gear_info id? inputs label modified origin outputs parent_info? parents previous_job_id? priority? produced_metadata profile related_container_ids request retried role_id? rule_id? saved_files state tags transitions

Properties

_id

_id: string

attempt

attempt: number

Optional batch

batch?: any

compute_provider_id

compute_provider_id: string

config

config: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

created

created: string

destination

destination: {
    id: string;
    type: string;
}

Type declaration

  • id: string
  • type: string

Optional failure_reason

failure_reason?: string

gear_id

gear_id: string

gear_info

gear_info: {
    capabilities?: string[];
    category: string;
    description?: string;
    id: string;
    name: string;
    version: string;
}

Type declaration

  • Optional capabilities?: string[]
  • category: string
  • Optional description?: string
  • id: string
  • name: string
  • version: string

Optional id

id?: string

inputs

inputs: JobInput[]

label

label: string

modified

modified: string

origin

origin: {
    id: string;
    type: OriginType;
}

Type declaration

outputs

outputs: File[]

Optional parent_info

parent_info?: {
    [container: string]: {
        _id: string;
        label: string;
    } | null;
}

Type declaration

  • [container: string]: {
        _id: string;
        label: string;
    } | null

parents

parents: {
    [container: string]: string | null;
}

Type declaration

  • [container: string]: string | null

Optional previous_job_id

previous_job_id?: string

Optional priority

priority?: JobPriority

produced_metadata

produced_metadata: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

profile

profile: {
    elapsed_time_ms: number;
    executor?: {
        cpu_cores: number;
        disk_bytes: number;
        gpu: boolean;
        host: string;
        instance_type: string;
        memory_bytes: number;
        name: string;
        swap_bytes: number;
    };
    preparation_time_ms: number;
    total_input_files: number;
    total_input_size_bytes: number;
    total_output_files: number;
    total_output_size_bytes: number;
    total_time_ms: number;
    upload_time_ms: number;
    versions: {
        [component: string]: string;
    };
}

Type declaration

  • elapsed_time_ms: number
  • Optional executor?: {
        cpu_cores: number;
        disk_bytes: number;
        gpu: boolean;
        host: string;
        instance_type: string;
        memory_bytes: number;
        name: string;
        swap_bytes: number;
    }
    • cpu_cores: number
    • disk_bytes: number
    • gpu: boolean
    • host: string
    • instance_type: string
    • memory_bytes: number
    • name: string
    • swap_bytes: number
  • preparation_time_ms: number
  • total_input_files: number
  • total_input_size_bytes: number
  • total_output_files: number
  • total_output_size_bytes: number
  • total_time_ms: number
  • upload_time_ms: number
  • versions: {
        [component: string]: string;
    }
    • [component: string]: string

related_container_ids

related_container_ids: string[]

request

request: {
    inputs: {
        location: string;
        type: string;
        uri: string;
        vu: string;
    }[];
    outputs: {
        location: string;
        type: string;
        uri: string;
        vu: string;
    }[];
    target: {
        command: string[];
        dir: string;
        env: {
            [name: string]: string;
        };
        gid: string;
        uid: string;
    };
}

Type declaration

  • inputs: {
        location: string;
        type: string;
        uri: string;
        vu: string;
    }[]
  • outputs: {
        location: string;
        type: string;
        uri: string;
        vu: string;
    }[]
  • target: {
        command: string[];
        dir: string;
        env: {
            [name: string]: string;
        };
        gid: string;
        uid: string;
    }
    • command: string[]
    • dir: string
    • env: {
          [name: string]: string;
      }
      • [name: string]: string
    • gid: string
    • uid: string

retried

retried: string

Optional role_id

role_id?: string

Optional rule_id

rule_id?: string

saved_files

saved_files: string[]

state

state: JobState

tags

tags: string[]

transitions

transitions: {
    cancelled?: string;
    complete?: string;
    failed?: string;
    running?: string;
}

Type declaration

  • Optional cancelled?: string
  • Optional complete?: string
  • Optional failed?: string
  • Optional running?: string

Settings

Member Visibility

Theme

On This Page

_idattemptbatchcompute_provider_idconfigcreateddestinationfailure_reasongear_idgear_infoidinputslabelmodifiedoriginoutputsparent_infoparentsprevious_job_idpriorityproduced_metadataprofilerelated_container_idsrequestretriedrole_idrule_idsaved_filesstatetagstransitions