Skip to content

flywheel.models.job_detail

JobDetail

Bases: object

attempt property writable

Gets the attempt of this JobDetail.

Returns:

Type Description
int

The attempt of this JobDetail

batch property writable

Gets the batch of this JobDetail.

Returns:

Type Description
str

The batch of this JobDetail

compute_provider_id property writable

Gets the compute_provider_id of this JobDetail.

Returns:

Type Description
str

The compute_provider_id of this JobDetail

config property writable

Gets the config of this JobDetail.

Returns:

Type Description
dict(str, object)

The config of this JobDetail

created property writable

Gets the created of this JobDetail.

Returns:

Type Description
datetime

The created of this JobDetail

deleted_outputs property writable

Gets the deleted_outputs of this JobDetail.

Returns:

Type Description
list[DeletedFile]

The deleted_outputs of this JobDetail

destination property writable

Gets the destination of this JobDetail.

Returns:

Type Description
ContainerReference

The destination of this JobDetail

failed_output_accepted property writable

Gets the failed_output_accepted of this JobDetail.

Returns:

Type Description
bool

The failed_output_accepted of this JobDetail

failure_reason property writable

Gets the failure_reason of this JobDetail.

Returns:

Type Description
str

The failure_reason of this JobDetail

gear_id property writable

Gets the gear_id of this JobDetail.

Returns:

Type Description
str

The gear_id of this JobDetail

gear_info property writable

Gets the gear_info of this JobDetail.

Returns:

Type Description
GearInfo

The gear_info of this JobDetail

id property writable

Gets the id of this JobDetail.

Returns:

Type Description
str

The id of this JobDetail

inputs property writable

Gets the inputs of this JobDetail.

Returns:

Type Description
dict(str, JobDetailFileEntry)

The inputs of this JobDetail

label property writable

Gets the label of this JobDetail.

Returns:

Type Description
str

The label of this JobDetail

modified property writable

Gets the modified of this JobDetail.

Returns:

Type Description
datetime

The modified of this JobDetail

origin property writable

Gets the origin of this JobDetail.

Returns:

Type Description
Origin

The origin of this JobDetail

outputs property writable

Gets the outputs of this JobDetail.

Returns:

Type Description
list[JobDetailFileEntry]

The outputs of this JobDetail

parent_info property writable

Gets the parent_info of this JobDetail.

Returns:

Type Description
JobDetailParentInfo

The parent_info of this JobDetail

parents property writable

Gets the parents of this JobDetail.

Returns:

Type Description
union[AnalysisParents,ProjectParents,SubjectParents,SessionParents,AcquisitionParents,FileParents]

The parents of this JobDetail

previous_job_id property writable

Gets the previous_job_id of this JobDetail.

Returns:

Type Description
str

The previous_job_id of this JobDetail

priority property writable

Gets the priority of this JobDetail.

Returns:

Type Description
JobPriority

The priority of this JobDetail

produced_metadata property writable

Gets the produced_metadata of this JobDetail.

Returns:

Type Description
dict(str, object)

The produced_metadata of this JobDetail

profile property writable

Gets the profile of this JobDetail.

Returns:

Type Description
JobProfile

The profile of this JobDetail

related_container_ids property writable

Gets the related_container_ids of this JobDetail.

Returns:

Type Description
list[str]

The related_container_ids of this JobDetail

request property writable

Gets the request of this JobDetail.

Returns:

Type Description
JobRequest

The request of this JobDetail

retried property writable

Gets the retried of this JobDetail.

Returns:

Type Description
datetime

The retried of this JobDetail

state property writable

Gets the state of this JobDetail.

Returns:

Type Description
JobState

The state of this JobDetail

tags property writable

Gets the tags of this JobDetail.

Returns:

Type Description
list[str]

The tags of this JobDetail

transitions property writable

Gets the transitions of this JobDetail.

Returns:

Type Description
Transitions

The transitions of this JobDetail

__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__(gear_id=None, gear_info=None, destination=None, tags=None, priority=None, attempt=None, previous_job_id=None, created=None, modified=None, retried=None, state=None, request=None, id=None, config=None, origin=None, produced_metadata=None, batch=None, failed_output_accepted=None, profile=None, failure_reason=None, related_container_ids=None, label=None, compute_provider_id=None, parents=None, transitions=None, parent_info=None, inputs=None, outputs=None, deleted_outputs=None)

JobDetail - a model defined in Swagger

Parameters:

Name Type Description Default
gear_id (str, optional)

, defaults to None

None
gear_info (GearInfo, optional)

, defaults to None

None
destination (ContainerReference, optional)

, defaults to None

None
tags (list[str], optional)

, defaults to None

None
priority (JobPriority, optional)

, defaults to None

None
attempt (int, optional)

, defaults to None

None
previous_job_id (str, optional)

, defaults to None

None
created (datetime, optional)

, defaults to None

None
modified (datetime, optional)

, defaults to None

None
retried (datetime, optional)

, defaults to None

None
state (JobState, optional)

, defaults to None

None
request (JobRequest, optional)

, defaults to None

None
id (str, optional)

, defaults to None

None
config (dict(str, object), optional)

, defaults to None

None
origin (Origin, optional)

, defaults to None

None
produced_metadata (dict(str, object), optional)

, defaults to None

None
batch (str, optional)

, defaults to None

None
failed_output_accepted (bool, optional)

, defaults to None

None
profile (JobProfile, optional)

, defaults to None

None
failure_reason (str, optional)

, defaults to None

None
related_container_ids (list[str], optional)

, defaults to None

None
label (str, optional)

, defaults to None

None
compute_provider_id (str, optional)

, defaults to None

None
parents (union[AnalysisParents, ProjectParents, SubjectParents, SessionParents, AcquisitionParents, FileParents], optional)

, defaults to None

None
transitions (Transitions, optional)

, defaults to None

None
parent_info (JobDetailParentInfo, optional)

, defaults to None

None
inputs (dict(str, JobDetailFileEntry), optional)

, defaults to None

None
outputs (list[JobDetailFileEntry], optional)

, defaults to None

None
deleted_outputs (list[DeletedFile], optional)

, 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