Skip to content

job_options

the jobq cluster workflow management tool backend

Backend service for the appliedAI infrastructure product

The version of the OpenAPI document: 0.1.0 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

JobOptions

Bases: BaseModel

Options for customizing a Kubernetes job definition from a Python function.

Source code in client/src/openapi_client/models/job_options.py 
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class JobOptions(BaseModel):
    """
    Options for customizing a Kubernetes job definition from a Python function.
    """  # noqa: E501

    resources: ResourceOptions | None = None
    scheduling: SchedulingOptions
    labels: dict[str, StrictStr] | None = None
    __properties: ClassVar[list[str]] = ["resources", "scheduling", "labels"]

    model_config = ConfigDict(
        populate_by_name=True,
        validate_assignment=True,
        protected_namespaces=(),
    )

    def to_str(self) -> str:
        """Returns the string representation of the model using alias"""
        return pprint.pformat(self.model_dump(by_alias=True))

    def to_json(self) -> str:
        """Returns the JSON representation of the model using alias"""
        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
        return json.dumps(self.to_dict())

    @classmethod
    def from_json(cls, json_str: str) -> Self | None:
        """Create an instance of JobOptions from a JSON string"""
        return cls.from_dict(json.loads(json_str))

    def to_dict(self) -> dict[str, Any]:
        """Return the dictionary representation of the model using alias.

        This has the following differences from calling pydantic's
        `self.model_dump(by_alias=True)`:

        * `None` is only added to the output dict for nullable fields that
          were set at model initialization. Other fields with value `None`
          are ignored.
        """
        excluded_fields: set[str] = set()

        _dict = self.model_dump(
            by_alias=True,
            exclude=excluded_fields,
            exclude_none=True,
        )
        # override the default output from pydantic by calling `to_dict()` of resources
        if self.resources:
            _dict["resources"] = self.resources.to_dict()
        # override the default output from pydantic by calling `to_dict()` of scheduling
        if self.scheduling:
            _dict["scheduling"] = self.scheduling.to_dict()
        # set to None if resources (nullable) is None
        # and model_fields_set contains the field
        if self.resources is None and "resources" in self.model_fields_set:
            _dict["resources"] = None

        return _dict

    @classmethod
    def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
        """Create an instance of JobOptions from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)

        _obj = cls.model_validate({
            "resources": ResourceOptions.from_dict(obj["resources"])
            if obj.get("resources") is not None
            else None,
            "scheduling": SchedulingOptions.from_dict(obj["scheduling"])
            if obj.get("scheduling") is not None
            else None,
            "labels": obj.get("labels"),
        })
        return _obj

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in client/src/openapi_client/models/job_options.py 
42
43
44
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in client/src/openapi_client/models/job_options.py 
46
47
48
49
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
    return json.dumps(self.to_dict())

from_json classmethod 

from_json(json_str: str) -> Self | None

Create an instance of JobOptions from a JSON string

Source code in client/src/openapi_client/models/job_options.py 
51
52
53
54
@classmethod
def from_json(cls, json_str: str) -> Self | None:
    """Create an instance of JobOptions from a JSON string"""
    return cls.from_dict(json.loads(json_str))

to_dict 

to_dict() -> dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
Source code in client/src/openapi_client/models/job_options.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def to_dict(self) -> dict[str, Any]:
    """Return the dictionary representation of the model using alias.

    This has the following differences from calling pydantic's
    `self.model_dump(by_alias=True)`:

    * `None` is only added to the output dict for nullable fields that
      were set at model initialization. Other fields with value `None`
      are ignored.
    """
    excluded_fields: set[str] = set()

    _dict = self.model_dump(
        by_alias=True,
        exclude=excluded_fields,
        exclude_none=True,
    )
    # override the default output from pydantic by calling `to_dict()` of resources
    if self.resources:
        _dict["resources"] = self.resources.to_dict()
    # override the default output from pydantic by calling `to_dict()` of scheduling
    if self.scheduling:
        _dict["scheduling"] = self.scheduling.to_dict()
    # set to None if resources (nullable) is None
    # and model_fields_set contains the field
    if self.resources is None and "resources" in self.model_fields_set:
        _dict["resources"] = None

    return _dict

from_dict classmethod 

from_dict(obj: dict[str, Any] | None) -> Self | None

Create an instance of JobOptions from a dict

Source code in client/src/openapi_client/models/job_options.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
@classmethod
def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
    """Create an instance of JobOptions from a dict"""
    if obj is None:
        return None

    if not isinstance(obj, dict):
        return cls.model_validate(obj)

    _obj = cls.model_validate({
        "resources": ResourceOptions.from_dict(obj["resources"])
        if obj.get("resources") is not None
        else None,
        "scheduling": SchedulingOptions.from_dict(obj["scheduling"])
        if obj.get("scheduling") is not None
        else None,
        "labels": obj.get("labels"),
    })
    return _obj