Skip to content

workload_metadata

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.

WorkloadMetadata

Bases: BaseModel

WorkloadMetadata

Source code in client/src/openapi_client/models/workload_metadata.py 
 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
class WorkloadMetadata(BaseModel):
    """
    WorkloadMetadata
    """  # noqa: E501

    managed_resource_id: StrictStr
    execution_status: JobStatus
    spec: WorkloadSpec
    kueue_status: WorkloadStatus
    submission_timestamp: datetime
    last_admission_timestamp: datetime | None = None
    termination_timestamp: datetime | None = None
    was_evicted: StrictBool | None = False
    was_inadmissible: StrictBool | None = False
    has_failed_pods: StrictBool | None = False
    __properties: ClassVar[list[str]] = [
        "managed_resource_id",
        "execution_status",
        "spec",
        "kueue_status",
        "submission_timestamp",
        "last_admission_timestamp",
        "termination_timestamp",
        "was_evicted",
        "was_inadmissible",
        "has_failed_pods",
    ]

    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 WorkloadMetadata 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 spec
        if self.spec:
            _dict["spec"] = self.spec.to_dict()
        # override the default output from pydantic by calling `to_dict()` of kueue_status
        if self.kueue_status:
            _dict["kueue_status"] = self.kueue_status.to_dict()
        # set to None if last_admission_timestamp (nullable) is None
        # and model_fields_set contains the field
        if (
            self.last_admission_timestamp is None
            and "last_admission_timestamp" in self.model_fields_set
        ):
            _dict["last_admission_timestamp"] = None

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

        return _dict

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

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

        _obj = cls.model_validate({
            "managed_resource_id": obj.get("managed_resource_id"),
            "execution_status": obj.get("execution_status"),
            "spec": WorkloadSpec.from_dict(obj["spec"])
            if obj.get("spec") is not None
            else None,
            "kueue_status": WorkloadStatus.from_dict(obj["kueue_status"])
            if obj.get("kueue_status") is not None
            else None,
            "submission_timestamp": obj.get("submission_timestamp"),
            "last_admission_timestamp": obj.get("last_admission_timestamp"),
            "termination_timestamp": obj.get("termination_timestamp"),
            "was_evicted": obj.get("was_evicted")
            if obj.get("was_evicted") is not None
            else False,
            "was_inadmissible": obj.get("was_inadmissible")
            if obj.get("was_inadmissible") is not None
            else False,
            "has_failed_pods": obj.get("has_failed_pods")
            if obj.get("has_failed_pods") is not None
            else False,
        })
        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_metadata.py 
62
63
64
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_metadata.py 
66
67
68
69
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 WorkloadMetadata from a JSON string

Source code in client/src/openapi_client/models/workload_metadata.py 
71
72
73
74
@classmethod
def from_json(cls, json_str: str) -> Self | None:
    """Create an instance of WorkloadMetadata 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_metadata.py 
 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
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 spec
    if self.spec:
        _dict["spec"] = self.spec.to_dict()
    # override the default output from pydantic by calling `to_dict()` of kueue_status
    if self.kueue_status:
        _dict["kueue_status"] = self.kueue_status.to_dict()
    # set to None if last_admission_timestamp (nullable) is None
    # and model_fields_set contains the field
    if (
        self.last_admission_timestamp is None
        and "last_admission_timestamp" in self.model_fields_set
    ):
        _dict["last_admission_timestamp"] = None

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

    return _dict

from_dict classmethod 

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

Create an instance of WorkloadMetadata from a dict

Source code in client/src/openapi_client/models/workload_metadata.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
@classmethod
def from_dict(cls, obj: dict[str, Any] | None) -> Self | None:
    """Create an instance of WorkloadMetadata from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate({
        "managed_resource_id": obj.get("managed_resource_id"),
        "execution_status": obj.get("execution_status"),
        "spec": WorkloadSpec.from_dict(obj["spec"])
        if obj.get("spec") is not None
        else None,
        "kueue_status": WorkloadStatus.from_dict(obj["kueue_status"])
        if obj.get("kueue_status") is not None
        else None,
        "submission_timestamp": obj.get("submission_timestamp"),
        "last_admission_timestamp": obj.get("last_admission_timestamp"),
        "termination_timestamp": obj.get("termination_timestamp"),
        "was_evicted": obj.get("was_evicted")
        if obj.get("was_evicted") is not None
        else False,
        "was_inadmissible": obj.get("was_inadmissible")
        if obj.get("was_inadmissible") is not None
        else False,
        "has_failed_pods": obj.get("has_failed_pods")
        if obj.get("has_failed_pods") is not None
        else False,
    })
    return _obj