Skip to content

Queue Command Dto

immichpy.client.generated.models.queue_command_dto.QueueCommandDto pydantic-model

Bases: BaseModel

QueueCommandDto

Show JSON schema: 
{
  "$defs": {
    "QueueCommand": {
      "description": "Queue command to execute",
      "enum": [
        "start",
        "pause",
        "resume",
        "empty",
        "clear-failed"
      ],
      "title": "QueueCommand",
      "type": "string"
    }
  },
  "description": "QueueCommandDto",
  "properties": {
    "command": {
      "$ref": "#/$defs/QueueCommand"
    },
    "force": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Force the command execution (if applicable)",
      "title": "Force"
    }
  },
  "required": [
    "command"
  ],
  "title": "QueueCommandDto",
  "type": "object"
}

Config:

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

Fields:

command pydantic-field 

command: QueueCommand

Queue command to execute

force pydantic-field 

force: Optional[StrictBool] = None

Force the command execution (if applicable)

from_dict classmethod 

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

Create an instance of QueueCommandDto from a dict

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

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

    _obj = cls.model_validate(
        {"command": obj.get("command"), "force": obj.get("force")}
    )
    return _obj

from_json classmethod 

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

Create an instance of QueueCommandDto from a JSON string

Source code in immichpy/client/generated/models/queue_command_dto.py 
52
53
54
55
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of QueueCommandDto 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_command_dto.py 
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,
    )
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

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