Skip to content

Maintenance Status Response Dto

immichpy.client.generated.models.maintenance_status_response_dto.MaintenanceStatusResponseDto pydantic-model

Bases: BaseModel

MaintenanceStatusResponseDto

Show JSON schema: 
{
  "$defs": {
    "MaintenanceAction": {
      "description": "Maintenance action",
      "enum": [
        "start",
        "end",
        "select_database_restore",
        "restore_database"
      ],
      "title": "MaintenanceAction",
      "type": "string"
    }
  },
  "description": "MaintenanceStatusResponseDto",
  "properties": {
    "action": {
      "$ref": "#/$defs/MaintenanceAction"
    },
    "active": {
      "title": "Active",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "progress": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Progress"
    },
    "task": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Task"
    }
  },
  "required": [
    "action",
    "active"
  ],
  "title": "MaintenanceStatusResponseDto",
  "type": "object"
}

Config:

  • populate_by_name: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

action pydantic-field 

action: MaintenanceAction

Maintenance action

from_dict classmethod 

from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]

Create an instance of MaintenanceStatusResponseDto from a dict

Source code in immichpy/client/generated/models/maintenance_status_response_dto.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of MaintenanceStatusResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "action": obj.get("action"),
            "active": obj.get("active"),
            "error": obj.get("error"),
            "progress": obj.get("progress"),
            "task": obj.get("task"),
        }
    )
    return _obj

from_json classmethod 

from_json(json_str: str) -> Optional[Self]

Create an instance of MaintenanceStatusResponseDto from a JSON string

Source code in immichpy/client/generated/models/maintenance_status_response_dto.py 
67
68
69
70
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of MaintenanceStatusResponseDto 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 immichpy/client/generated/models/maintenance_status_response_dto.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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,
    )
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/maintenance_status_response_dto.py 
62
63
64
65
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())

to_str 

to_str() -> str

Returns the string representation of the model using alias

Source code in immichpy/client/generated/models/maintenance_status_response_dto.py 
58
59
60
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))