Skip to content

scheduling_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.

SchedulingOptions

Bases: BaseModel

Options configuring a jobq.Job's priority in the cluster, and the Kueue cluster queue name the job should be submitted to.

Source code in client/src/openapi_client/models/scheduling_options.py 
23
24
25
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
class SchedulingOptions(BaseModel):
    """
    Options configuring a ``jobq.Job``'s priority in the cluster, and the Kueue cluster queue name the job should be submitted to.
    """  # noqa: E501

    priority_class: StrictStr | None = None
    queue_name: StrictStr
    __properties: ClassVar[list[str]] = ["priority_class", "queue_name"]

    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 SchedulingOptions 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,
        )
        # set to None if priority_class (nullable) is None
        # and model_fields_set contains the field
        if self.priority_class is None and "priority_class" in self.model_fields_set:
            _dict["priority_class"] = None

        return _dict

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

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

        _obj = cls.model_validate({
            "priority_class": obj.get("priority_class"),
            "queue_name": obj.get("queue_name"),
        })
        return _obj

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in client/src/openapi_client/models/scheduling_options.py 
38
39
40
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/scheduling_options.py 
42
43
44
45
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 SchedulingOptions from a JSON string

Source code in client/src/openapi_client/models/scheduling_options.py 
47
48
49
50
@classmethod
def from_json(cls, json_str: str) -> Self | None:
    """Create an instance of SchedulingOptions 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/scheduling_options.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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,
    )
    # set to None if priority_class (nullable) is None
    # and model_fields_set contains the field
    if self.priority_class is None and "priority_class" in self.model_fields_set:
        _dict["priority_class"] = None

    return _dict

from_dict classmethod 

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

Create an instance of SchedulingOptions from a dict

Source code in client/src/openapi_client/models/scheduling_options.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
@classmethod
def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
    """Create an instance of SchedulingOptions from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate({
        "priority_class": obj.get("priority_class"),
        "queue_name": obj.get("queue_name"),
    })
    return _obj