Skip to content

workload_spec

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.

WorkloadSpec

Bases: BaseModel

WorkloadSpec

Source code in client/src/openapi_client/models/workload_spec.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
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
class WorkloadSpec(BaseModel):
    """
    WorkloadSpec
    """  # noqa: E501

    pod_sets: list[Any] = Field(alias="podSets")
    queue_name: StrictStr = Field(alias="queueName")
    active: StrictBool
    priority_class_name: StrictStr | None = Field(
        default=None, alias="priorityClassName"
    )
    priority: StrictInt | None = None
    priority_class_source: StrictStr | None = Field(
        default=None, alias="priorityClassSource"
    )
    __properties: ClassVar[list[str]] = [
        "podSets",
        "queueName",
        "active",
        "priorityClassName",
        "priority",
        "priorityClassSource",
    ]

    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 WorkloadSpec 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_name (nullable) is None
        # and model_fields_set contains the field
        if (
            self.priority_class_name is None
            and "priority_class_name" in self.model_fields_set
        ):
            _dict["priorityClassName"] = None

        # set to None if priority (nullable) is None
        # and model_fields_set contains the field
        if self.priority is None and "priority" in self.model_fields_set:
            _dict["priority"] = None

        # set to None if priority_class_source (nullable) is None
        # and model_fields_set contains the field
        if (
            self.priority_class_source is None
            and "priority_class_source" in self.model_fields_set
        ):
            _dict["priorityClassSource"] = None

        return _dict

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

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

        _obj = cls.model_validate({
            "podSets": obj.get("podSets"),
            "queueName": obj.get("queueName"),
            "active": obj.get("active"),
            "priorityClassName": obj.get("priorityClassName"),
            "priority": obj.get("priority"),
            "priorityClassSource": obj.get("priorityClassSource"),
        })
        return _obj

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in client/src/openapi_client/models/workload_spec.py 
53
54
55
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/workload_spec.py 
57
58
59
60
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 WorkloadSpec from a JSON string

Source code in client/src/openapi_client/models/workload_spec.py 
62
63
64
65
@classmethod
def from_json(cls, json_str: str) -> Self | None:
    """Create an instance of WorkloadSpec 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/workload_spec.py 
 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
105
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_name (nullable) is None
    # and model_fields_set contains the field
    if (
        self.priority_class_name is None
        and "priority_class_name" in self.model_fields_set
    ):
        _dict["priorityClassName"] = None

    # set to None if priority (nullable) is None
    # and model_fields_set contains the field
    if self.priority is None and "priority" in self.model_fields_set:
        _dict["priority"] = None

    # set to None if priority_class_source (nullable) is None
    # and model_fields_set contains the field
    if (
        self.priority_class_source is None
        and "priority_class_source" in self.model_fields_set
    ):
        _dict["priorityClassSource"] = None

    return _dict

from_dict classmethod 

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

Create an instance of WorkloadSpec from a dict

Source code in client/src/openapi_client/models/workload_spec.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
@classmethod
def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
    """Create an instance of WorkloadSpec from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate({
        "podSets": obj.get("podSets"),
        "queueName": obj.get("queueName"),
        "active": obj.get("active"),
        "priorityClassName": obj.get("priorityClassName"),
        "priority": obj.get("priority"),
        "priorityClassSource": obj.get("priorityClassSource"),
    })
    return _obj