Skip to content

Queue Job Response Dto

immichpy.client.generated.models.queue_job_response_dto.QueueJobResponseDto pydantic-model

Bases: BaseModel

QueueJobResponseDto

Show JSON schema: 
{
  "$defs": {
    "JobName": {
      "description": "Job name",
      "enum": [
        "AssetDelete",
        "AssetDeleteCheck",
        "AssetDetectFacesQueueAll",
        "AssetDetectFaces",
        "AssetDetectDuplicatesQueueAll",
        "AssetDetectDuplicates",
        "AssetEditThumbnailGeneration",
        "AssetEncodeVideoQueueAll",
        "AssetEncodeVideo",
        "AssetEmptyTrash",
        "AssetExtractMetadataQueueAll",
        "AssetExtractMetadata",
        "AssetFileMigration",
        "AssetGenerateThumbnailsQueueAll",
        "AssetGenerateThumbnails",
        "AuditLogCleanup",
        "AuditTableCleanup",
        "DatabaseBackup",
        "FacialRecognitionQueueAll",
        "FacialRecognition",
        "FileDelete",
        "FileMigrationQueueAll",
        "LibraryDeleteCheck",
        "LibraryDelete",
        "LibraryRemoveAsset",
        "LibraryScanAssetsQueueAll",
        "LibrarySyncAssets",
        "LibrarySyncFilesQueueAll",
        "LibrarySyncFiles",
        "LibraryScanQueueAll",
        "MemoryCleanup",
        "MemoryGenerate",
        "NotificationsCleanup",
        "NotifyUserSignup",
        "NotifyAlbumInvite",
        "NotifyAlbumUpdate",
        "UserDelete",
        "UserDeleteCheck",
        "UserSyncUsage",
        "PersonCleanup",
        "PersonFileMigration",
        "PersonGenerateThumbnail",
        "SessionCleanup",
        "SendMail",
        "SidecarQueueAll",
        "SidecarCheck",
        "SidecarWrite",
        "SmartSearchQueueAll",
        "SmartSearch",
        "StorageTemplateMigration",
        "StorageTemplateMigrationSingle",
        "TagCleanup",
        "VersionCheck",
        "OcrQueueAll",
        "Ocr",
        "WorkflowRun"
      ],
      "title": "JobName",
      "type": "string"
    }
  },
  "description": "QueueJobResponseDto",
  "properties": {
    "data": {
      "additionalProperties": true,
      "description": "Job data payload",
      "title": "Data",
      "type": "object"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Job ID",
      "title": "Id"
    },
    "name": {
      "$ref": "#/$defs/JobName"
    },
    "timestamp": {
      "description": "Job creation timestamp",
      "title": "Timestamp",
      "type": "integer"
    }
  },
  "required": [
    "data",
    "name",
    "timestamp"
  ],
  "title": "QueueJobResponseDto",
  "type": "object"
}

Config:

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

Fields:

data pydantic-field 

data: Dict[str, Any]

Job data payload

id pydantic-field 

id: Optional[StrictStr] = None

Job ID

name pydantic-field 

name: JobName

Job name

timestamp pydantic-field 

timestamp: StrictInt

Job creation timestamp

from_dict classmethod 

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

Create an instance of QueueJobResponseDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "data": obj.get("data"),
            "id": obj.get("id"),
            "name": obj.get("name"),
            "timestamp": obj.get("timestamp"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of QueueJobResponseDto from a JSON string

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