flywheel-sdk 21.2.0__py3-none-any.whl

flywheel/models/job.py

@@ -0,0 +1,841 @@
+# coding: utf-8
+
+"""
+    Flywheel
+
+    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
+
+    OpenAPI spec version: 0.0.1
+    
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+## NOTE: This file is auto generated by the swagger code generator program.
+## Do not edit the file manually.
+
+import pprint
+import re  # noqa: F401
+import six
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from flywheel.models.gear_info import GearInfo  # noqa: F401,E501
+    from flywheel.models.job_config import JobConfig  # noqa: F401,E501
+    from flywheel.models.job_destination import JobDestination  # noqa: F401,E501
+    from flywheel.models.job_inputs_object import JobInputsObject  # noqa: F401,E501
+    from flywheel.models.job_origin import JobOrigin  # noqa: F401,E501
+    from flywheel.models.job_profile import JobProfile  # noqa: F401,E501
+    from flywheel.models.job_request import JobRequest  # noqa: F401,E501
+    from flywheel.models.job_transition_times import JobTransitionTimes  # noqa: F401,E501
+
+from .mixins import JobMixin
+class Job(JobMixin):
+
+    swagger_types = {
+        'id': 'str',
+        'origin': 'JobOrigin',
+        'gear_id': 'str',
+        'gear_info': 'GearInfo',
+        'previous_job_id': 'str',
+        'inputs': 'JobInputsObject',
+        'destination': 'JobDestination',
+        'compute_provider_id': 'str',
+        'group': 'str',
+        'project': 'str',
+        'tags': 'list[str]',
+        'priority': 'str',
+        'state': 'str',
+        'failure_reason': 'str',
+        'attempt': 'int',
+        'created': 'datetime',
+        'modified': 'datetime',
+        'retried': 'datetime',
+        'config': 'JobConfig',
+        'transitions': 'JobTransitionTimes',
+        'request': 'JobRequest',
+        'saved_files': 'list[str]',
+        'profile': 'JobProfile',
+        'related_container_ids': 'list[str]',
+        'label': 'str'
+    }
+
+    attribute_map = {
+        'id': 'id',
+        'origin': 'origin',
+        'gear_id': 'gear_id',
+        'gear_info': 'gear_info',
+        'previous_job_id': 'previous_job_id',
+        'inputs': 'inputs',
+        'destination': 'destination',
+        'compute_provider_id': 'compute_provider_id',
+        'group': 'group',
+        'project': 'project',
+        'tags': 'tags',
+        'priority': 'priority',
+        'state': 'state',
+        'failure_reason': 'failure_reason',
+        'attempt': 'attempt',
+        'created': 'created',
+        'modified': 'modified',
+        'retried': 'retried',
+        'config': 'config',
+        'transitions': 'transitions',
+        'request': 'request',
+        'saved_files': 'saved_files',
+        'profile': 'profile',
+        'related_container_ids': 'related_container_ids',
+        'label': 'label'
+    }
+
+    rattribute_map = {
+        'id': 'id',
+        'origin': 'origin',
+        'gear_id': 'gear_id',
+        'gear_info': 'gear_info',
+        'previous_job_id': 'previous_job_id',
+        'inputs': 'inputs',
+        'destination': 'destination',
+        'compute_provider_id': 'compute_provider_id',
+        'group': 'group',
+        'project': 'project',
+        'tags': 'tags',
+        'priority': 'priority',
+        'state': 'state',
+        'failure_reason': 'failure_reason',
+        'attempt': 'attempt',
+        'created': 'created',
+        'modified': 'modified',
+        'retried': 'retried',
+        'config': 'config',
+        'transitions': 'transitions',
+        'request': 'request',
+        'saved_files': 'saved_files',
+        'profile': 'profile',
+        'related_container_ids': 'related_container_ids',
+        'label': 'label'
+    }
+
+    def __init__(self, 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):  # noqa: E501
+        """Job - a model defined in Swagger"""
+        super(Job, self).__init__()
+
+        self._id = None
+        self._origin = None
+        self._gear_id = None
+        self._gear_info = None
+        self._previous_job_id = None
+        self._inputs = None
+        self._destination = None
+        self._compute_provider_id = None
+        self._group = None
+        self._project = None
+        self._tags = None
+        self._priority = None
+        self._state = None
+        self._failure_reason = None
+        self._attempt = None
+        self._created = None
+        self._modified = None
+        self._retried = None
+        self._config = None
+        self._transitions = None
+        self._request = None
+        self._saved_files = None
+        self._profile = None
+        self._related_container_ids = None
+        self._label = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        if id is not None:
+            self.id = id
+        if origin is not None:
+            self.origin = origin
+        if gear_id is not None:
+            self.gear_id = gear_id
+        if gear_info is not None:
+            self.gear_info = gear_info
+        if previous_job_id is not None:
+            self.previous_job_id = previous_job_id
+        if inputs is not None:
+            self.inputs = inputs
+        if destination is not None:
+            self.destination = destination
+        if compute_provider_id is not None:
+            self.compute_provider_id = compute_provider_id
+        if group is not None:
+            self.group = group
+        if project is not None:
+            self.project = project
+        if tags is not None:
+            self.tags = tags
+        if priority is not None:
+            self.priority = priority
+        if state is not None:
+            self.state = state
+        if failure_reason is not None:
+            self.failure_reason = failure_reason
+        if attempt is not None:
+            self.attempt = attempt
+        if created is not None:
+            self.created = created
+        if modified is not None:
+            self.modified = modified
+        if retried is not None:
+            self.retried = retried
+        if config is not None:
+            self.config = config
+        if transitions is not None:
+            self.transitions = transitions
+        if request is not None:
+            self.request = request
+        if saved_files is not None:
+            self.saved_files = saved_files
+        if profile is not None:
+            self.profile = profile
+        if related_container_ids is not None:
+            self.related_container_ids = related_container_ids
+        if label is not None:
+            self.label = label
+
+    @property
+    def id(self):
+        """Gets the id of this Job.
+
+        Unique database ID
+
+        :return: The id of this Job.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this Job.
+
+        Unique database ID
+
+        :param id: The id of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._id = id
+
+    @property
+    def origin(self):
+        """Gets the origin of this Job.
+
+
+        :return: The origin of this Job.
+        :rtype: JobOrigin
+        """
+        return self._origin
+
+    @origin.setter
+    def origin(self, origin):
+        """Sets the origin of this Job.
+
+
+        :param origin: The origin of this Job.  # noqa: E501
+        :type: JobOrigin
+        """
+
+        self._origin = origin
+
+    @property
+    def gear_id(self):
+        """Gets the gear_id of this Job.
+
+
+        :return: The gear_id of this Job.
+        :rtype: str
+        """
+        return self._gear_id
+
+    @gear_id.setter
+    def gear_id(self, gear_id):
+        """Sets the gear_id of this Job.
+
+
+        :param gear_id: The gear_id of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._gear_id = gear_id
+
+    @property
+    def gear_info(self):
+        """Gets the gear_info of this Job.
+
+
+        :return: The gear_info of this Job.
+        :rtype: GearInfo
+        """
+        return self._gear_info
+
+    @gear_info.setter
+    def gear_info(self, gear_info):
+        """Sets the gear_info of this Job.
+
+
+        :param gear_info: The gear_info of this Job.  # noqa: E501
+        :type: GearInfo
+        """
+
+        self._gear_info = gear_info
+
+    @property
+    def previous_job_id(self):
+        """Gets the previous_job_id of this Job.
+
+
+        :return: The previous_job_id of this Job.
+        :rtype: str
+        """
+        return self._previous_job_id
+
+    @previous_job_id.setter
+    def previous_job_id(self, previous_job_id):
+        """Sets the previous_job_id of this Job.
+
+
+        :param previous_job_id: The previous_job_id of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._previous_job_id = previous_job_id
+
+    @property
+    def inputs(self):
+        """Gets the inputs of this Job.
+
+
+        :return: The inputs of this Job.
+        :rtype: JobInputsObject
+        """
+        return self._inputs
+
+    @inputs.setter
+    def inputs(self, inputs):
+        """Sets the inputs of this Job.
+
+
+        :param inputs: The inputs of this Job.  # noqa: E501
+        :type: JobInputsObject
+        """
+
+        self._inputs = inputs
+
+    @property
+    def destination(self):
+        """Gets the destination of this Job.
+
+
+        :return: The destination of this Job.
+        :rtype: JobDestination
+        """
+        return self._destination
+
+    @destination.setter
+    def destination(self, destination):
+        """Sets the destination of this Job.
+
+
+        :param destination: The destination of this Job.  # noqa: E501
+        :type: JobDestination
+        """
+
+        self._destination = destination
+
+    @property
+    def compute_provider_id(self):
+        """Gets the compute_provider_id of this Job.
+
+        Unique database ID
+
+        :return: The compute_provider_id of this Job.
+        :rtype: str
+        """
+        return self._compute_provider_id
+
+    @compute_provider_id.setter
+    def compute_provider_id(self, compute_provider_id):
+        """Sets the compute_provider_id of this Job.
+
+        Unique database ID
+
+        :param compute_provider_id: The compute_provider_id of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._compute_provider_id = compute_provider_id
+
+    @property
+    def group(self):
+        """Gets the group of this Job.
+
+
+        :return: The group of this Job.
+        :rtype: str
+        """
+        return self._group
+
+    @group.setter
+    def group(self, group):
+        """Sets the group of this Job.
+
+
+        :param group: The group of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._group = group
+
+    @property
+    def project(self):
+        """Gets the project of this Job.
+
+        Unique database ID
+
+        :return: The project of this Job.
+        :rtype: str
+        """
+        return self._project
+
+    @project.setter
+    def project(self, project):
+        """Sets the project of this Job.
+
+        Unique database ID
+
+        :param project: The project of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._project = project
+
+    @property
+    def tags(self):
+        """Gets the tags of this Job.
+
+
+        :return: The tags of this Job.
+        :rtype: list[str]
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, tags):
+        """Sets the tags of this Job.
+
+
+        :param tags: The tags of this Job.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._tags = tags
+
+    @property
+    def priority(self):
+        """Gets the priority of this Job.
+
+
+        :return: The priority of this Job.
+        :rtype: str
+        """
+        return self._priority
+
+    @priority.setter
+    def priority(self, priority):
+        """Sets the priority of this Job.
+
+
+        :param priority: The priority of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._priority = priority
+
+    @property
+    def state(self):
+        """Gets the state of this Job.
+
+
+        :return: The state of this Job.
+        :rtype: str
+        """
+        return self._state
+
+    @state.setter
+    def state(self, state):
+        """Sets the state of this Job.
+
+
+        :param state: The state of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._state = state
+
+    @property
+    def failure_reason(self):
+        """Gets the failure_reason of this Job.
+
+        An optional suspected reason for job failure
+
+        :return: The failure_reason of this Job.
+        :rtype: str
+        """
+        return self._failure_reason
+
+    @failure_reason.setter
+    def failure_reason(self, failure_reason):
+        """Sets the failure_reason of this Job.
+
+        An optional suspected reason for job failure
+
+        :param failure_reason: The failure_reason of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._failure_reason = failure_reason
+
+    @property
+    def attempt(self):
+        """Gets the attempt of this Job.
+
+
+        :return: The attempt of this Job.
+        :rtype: int
+        """
+        return self._attempt
+
+    @attempt.setter
+    def attempt(self, attempt):
+        """Sets the attempt of this Job.
+
+
+        :param attempt: The attempt of this Job.  # noqa: E501
+        :type: int
+        """
+
+        self._attempt = attempt
+
+    @property
+    def created(self):
+        """Gets the created of this Job.
+
+        Creation time (automatically set)
+
+        :return: The created of this Job.
+        :rtype: datetime
+        """
+        return self._created
+
+    @created.setter
+    def created(self, created):
+        """Sets the created of this Job.
+
+        Creation time (automatically set)
+
+        :param created: The created of this Job.  # noqa: E501
+        :type: datetime
+        """
+
+        self._created = created
+
+    @property
+    def modified(self):
+        """Gets the modified of this Job.
+
+        Last modification time (automatically updated)
+
+        :return: The modified of this Job.
+        :rtype: datetime
+        """
+        return self._modified
+
+    @modified.setter
+    def modified(self, modified):
+        """Sets the modified of this Job.
+
+        Last modification time (automatically updated)
+
+        :param modified: The modified of this Job.  # noqa: E501
+        :type: datetime
+        """
+
+        self._modified = modified
+
+    @property
+    def retried(self):
+        """Gets the retried of this Job.
+
+        Retried time (automatically set)
+
+        :return: The retried of this Job.
+        :rtype: datetime
+        """
+        return self._retried
+
+    @retried.setter
+    def retried(self, retried):
+        """Sets the retried of this Job.
+
+        Retried time (automatically set)
+
+        :param retried: The retried of this Job.  # noqa: E501
+        :type: datetime
+        """
+
+        self._retried = retried
+
+    @property
+    def config(self):
+        """Gets the config of this Job.
+
+
+        :return: The config of this Job.
+        :rtype: JobConfig
+        """
+        return self._config
+
+    @config.setter
+    def config(self, config):
+        """Sets the config of this Job.
+
+
+        :param config: The config of this Job.  # noqa: E501
+        :type: JobConfig
+        """
+
+        self._config = config
+
+    @property
+    def transitions(self):
+        """Gets the transitions of this Job.
+
+
+        :return: The transitions of this Job.
+        :rtype: JobTransitionTimes
+        """
+        return self._transitions
+
+    @transitions.setter
+    def transitions(self, transitions):
+        """Sets the transitions of this Job.
+
+
+        :param transitions: The transitions of this Job.  # noqa: E501
+        :type: JobTransitionTimes
+        """
+
+        self._transitions = transitions
+
+    @property
+    def request(self):
+        """Gets the request of this Job.
+
+
+        :return: The request of this Job.
+        :rtype: JobRequest
+        """
+        return self._request
+
+    @request.setter
+    def request(self, request):
+        """Sets the request of this Job.
+
+
+        :param request: The request of this Job.  # noqa: E501
+        :type: JobRequest
+        """
+
+        self._request = request
+
+    @property
+    def saved_files(self):
+        """Gets the saved_files of this Job.
+
+
+        :return: The saved_files of this Job.
+        :rtype: list[str]
+        """
+        return self._saved_files
+
+    @saved_files.setter
+    def saved_files(self, saved_files):
+        """Sets the saved_files of this Job.
+
+
+        :param saved_files: The saved_files of this Job.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._saved_files = saved_files
+
+    @property
+    def profile(self):
+        """Gets the profile of this Job.
+
+
+        :return: The profile of this Job.
+        :rtype: JobProfile
+        """
+        return self._profile
+
+    @profile.setter
+    def profile(self, profile):
+        """Sets the profile of this Job.
+
+
+        :param profile: The profile of this Job.  # noqa: E501
+        :type: JobProfile
+        """
+
+        self._profile = profile
+
+    @property
+    def related_container_ids(self):
+        """Gets the related_container_ids of this Job.
+
+        The set of all related container ids
+
+        :return: The related_container_ids of this Job.
+        :rtype: list[str]
+        """
+        return self._related_container_ids
+
+    @related_container_ids.setter
+    def related_container_ids(self, related_container_ids):
+        """Sets the related_container_ids of this Job.
+
+        The set of all related container ids
+
+        :param related_container_ids: The related_container_ids of this Job.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._related_container_ids = related_container_ids
+
+    @property
+    def label(self):
+        """Gets the label of this Job.
+
+        Application-specific label
+
+        :return: The label of this Job.
+        :rtype: str
+        """
+        return self._label
+
+    @label.setter
+    def label(self, label):
+        """Sets the label of this Job.
+
+        Application-specific label
+
+        :param label: The label of this Job.  # noqa: E501
+        :type: str
+        """
+
+        self._label = label
+
+
+    @staticmethod
+    def positional_to_model(value):
+        """Converts a positional argument to a model value"""
+        return value
+
+    def return_value(self):
+        """Unwraps return value from model"""
+        return self
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, Job):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other
+
+    # Container emulation
+    def __getitem__(self, key):
+        """Returns the value of key"""
+        key = self._map_key(key)
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        """Sets the value of key"""
+        key = self._map_key(key)
+        setattr(self, key, value)
+
+    def __contains__(self, key):
+        """Checks if the given value is a key in this object"""
+        key = self._map_key(key, raise_on_error=False)
+        return key is not None
+
+    def keys(self):
+        """Returns the list of json properties in the object"""
+        return self.__class__.rattribute_map.keys()
+
+    def values(self):
+        """Returns the list of values in the object"""
+        for key in self.__class__.attribute_map.keys():
+            yield getattr(self, key)
+
+    def items(self):
+        """Returns the list of json property to value mapping"""
+        for key, prop in self.__class__.rattribute_map.items():
+            yield key, getattr(self, prop)
+
+    def get(self, key, default=None):
+        """Get the value of the provided json property, or default"""
+        key = self._map_key(key, raise_on_error=False)
+        if key:
+            return getattr(self, key, default)
+        return default
+
+    def _map_key(self, key, raise_on_error=True):
+        result = self.__class__.rattribute_map.get(key)
+        if result is None:
+            if raise_on_error:
+                raise AttributeError('Invalid attribute name: {}'.format(key))
+            return None
+        return '_' + result