Skip to content

flywheel.models.job

Job

Bases: JobMixin

attempt property writable

Gets the attempt of this Job.

Returns:

Type Description
int

The attempt of this Job

compute_provider_id property writable

Gets the compute_provider_id of this Job.

Unique database ID

Returns:

Type Description
str

The compute_provider_id of this Job

config property writable

Gets the config of this Job.

Returns:

Type Description
JobConfig

The config of this Job

created property writable

Gets the created of this Job.

Creation time (automatically set)

Returns:

Type Description
datetime

The created of this Job

destination property writable

Gets the destination of this Job.

Returns:

Type Description
JobDestination

The destination of this Job

failure_reason property writable

Gets the failure_reason of this Job.

An optional suspected reason for job failure

Returns:

Type Description
str

The failure_reason of this Job

gear_id property writable

Gets the gear_id of this Job.

Returns:

Type Description
str

The gear_id of this Job

gear_info property writable

Gets the gear_info of this Job.

Returns:

Type Description
GearInfo

The gear_info of this Job

group property writable

Gets the group of this Job.

Returns:

Type Description
str

The group of this Job

id property writable

Gets the id of this Job.

Unique database ID

Returns:

Type Description
str

The id of this Job

inputs property writable

Gets the inputs of this Job.

Returns:

Type Description
JobInputsObject

The inputs of this Job

label property writable

Gets the label of this Job.

Application-specific label

Returns:

Type Description
str

The label of this Job

modified property writable

Gets the modified of this Job.

Last modification time (automatically updated)

Returns:

Type Description
datetime

The modified of this Job

origin property writable

Gets the origin of this Job.

Returns:

Type Description
JobOrigin

The origin of this Job

previous_job_id property writable

Gets the previous_job_id of this Job.

Returns:

Type Description
str

The previous_job_id of this Job

priority property writable

Gets the priority of this Job.

Returns:

Type Description
str

The priority of this Job

profile property writable

Gets the profile of this Job.

Returns:

Type Description
JobProfile

The profile of this Job

project property writable

Gets the project of this Job.

Unique database ID

Returns:

Type Description
str

The project of this Job

related_container_ids property writable

Gets the related_container_ids of this Job.

The set of all related container ids

Returns:

Type Description
list[str]

The related_container_ids of this Job

request property writable

Gets the request of this Job.

Returns:

Type Description
JobRequest

The request of this Job

retried property writable

Gets the retried of this Job.

Retried time (automatically set)

Returns:

Type Description
datetime

The retried of this Job

saved_files property writable

Gets the saved_files of this Job.

Returns:

Type Description
list[str]

The saved_files of this Job

state property writable

Gets the state of this Job.

Returns:

Type Description
str

The state of this Job

tags property writable

Gets the tags of this Job.

Returns:

Type Description
list[str]

The tags of this Job

transitions property writable

Gets the transitions of this Job.

Returns:

Type Description
JobTransitionTimes

The transitions of this Job

__contains__(key)

Checks if the given value is a key in this object

__eq__(other)

Returns true if both objects are equal

__getitem__(key)

Returns the value of key

__init__(id=None, origin=None, gear_id=None, gear_info=None, previous_job_id=None, inputs=None, destination=None, compute_provider_id=None, group=None, project=None, tags=None, priority=None, state=None, failure_reason=None, attempt=None, created=None, modified=None, retried=None, config=None, transitions=None, request=None, saved_files=None, profile=None, related_container_ids=None, label=None)

Job - a model defined in Swagger

Parameters:

Name Type Description Default
id (str, optional)

Unique database ID, defaults to None

None
origin (JobOrigin, optional)

, defaults to None

None
gear_id (str, optional)

, defaults to None

None
gear_info (GearInfo, optional)

, defaults to None

None
previous_job_id (str, optional)

, defaults to None

None
inputs (JobInputsObject, optional)

, defaults to None

None
destination (JobDestination, optional)

, defaults to None

None
compute_provider_id (str, optional)

Unique database ID, defaults to None

None
group (str, optional)

, defaults to None

None
project (str, optional)

Unique database ID, defaults to None

None
tags (list[str], optional)

, defaults to None

None
priority (str, optional)

, defaults to None

None
state (str, optional)

, defaults to None

None
failure_reason (str, optional)

An optional suspected reason for job failure, defaults to None

None
attempt (int, optional)

, defaults to None

None
created (datetime, optional)

Creation time (automatically set), defaults to None

None
modified (datetime, optional)

Last modification time (automatically updated), defaults to None

None
retried (datetime, optional)

Retried time (automatically set), defaults to None

None
config (JobConfig, optional)

, defaults to None

None
transitions (JobTransitionTimes, optional)

, defaults to None

None
request (JobRequest, optional)

, defaults to None

None
saved_files (list[str], optional)

, defaults to None

None
profile (JobProfile, optional)

, defaults to None

None
related_container_ids (list[str], optional)

The set of all related container ids, defaults to None

None
label (str, optional)

Application-specific label, defaults to None

None

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

__setitem__(key, value)

Sets the value of key

get(key, default=None)

Get the value of the provided json property, or default

items()

Returns the list of json property to value mapping

keys()

Returns the list of json properties in the object

positional_to_model(value) staticmethod

Converts a positional argument to a model value

return_value()

Unwraps return value from model

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object