Skip to content

Queue Response Dto

immichpy.client.generated.models.queue_response_dto.QueueResponseDto pydantic-model

Bases: BaseModel

QueueResponseDto

Show JSON schema: 
{
  "$defs": {
    "QueueName": {
      "description": "QueueName",
      "enum": [
        "thumbnailGeneration",
        "metadataExtraction",
        "videoConversion",
        "faceDetection",
        "facialRecognition",
        "smartSearch",
        "duplicateDetection",
        "backgroundTask",
        "storageTemplateMigration",
        "migration",
        "search",
        "sidecar",
        "library",
        "notifications",
        "backupDatabase",
        "ocr",
        "workflow",
        "editor"
      ],
      "title": "QueueName",
      "type": "string"
    },
    "QueueStatisticsDto": {
      "description": "QueueStatisticsDto",
      "properties": {
        "active": {
          "description": "Number of active jobs",
          "title": "Active",
          "type": "integer"
        },
        "completed": {
          "description": "Number of completed jobs",
          "title": "Completed",
          "type": "integer"
        },
        "delayed": {
          "description": "Number of delayed jobs",
          "title": "Delayed",
          "type": "integer"
        },
        "failed": {
          "description": "Number of failed jobs",
          "title": "Failed",
          "type": "integer"
        },
        "paused": {
          "description": "Number of paused jobs",
          "title": "Paused",
          "type": "integer"
        },
        "waiting": {
          "description": "Number of waiting jobs",
          "title": "Waiting",
          "type": "integer"
        }
      },
      "required": [
        "active",
        "completed",
        "delayed",
        "failed",
        "paused",
        "waiting"
      ],
      "title": "QueueStatisticsDto",
      "type": "object"
    }
  },
  "description": "QueueResponseDto",
  "properties": {
    "isPaused": {
      "description": "Whether the queue is paused",
      "title": "Ispaused",
      "type": "boolean"
    },
    "name": {
      "$ref": "#/$defs/QueueName",
      "description": "Queue name"
    },
    "statistics": {
      "$ref": "#/$defs/QueueStatisticsDto"
    }
  },
  "required": [
    "isPaused",
    "name",
    "statistics"
  ],
  "title": "QueueResponseDto",
  "type": "object"
}

Config:

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

Fields:

is_paused pydantic-field 

is_paused: StrictBool

Whether the queue is paused

name pydantic-field 

name: QueueName

Queue name

from_dict classmethod 

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

Create an instance of QueueResponseDto from a dict

Source code in immichpy/client/generated/models/queue_response_dto.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of QueueResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "isPaused": obj.get("isPaused"),
            "name": obj.get("name"),
            "statistics": QueueStatisticsDto.from_dict(obj["statistics"])
            if obj.get("statistics") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of QueueResponseDto from a JSON string

Source code in immichpy/client/generated/models/queue_response_dto.py 
54
55
56
57
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of QueueResponseDto 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/queue_response_dto.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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 statistics
    if self.statistics:
        _dict["statistics"] = self.statistics.to_dict()
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/queue_response_dto.py 
49
50
51
52
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/queue_response_dto.py 
45
46
47
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))