Skip to content

Admin Config Nightly Tasks Dto

immichpy.client.generated.models.admin_config_nightly_tasks_dto.AdminConfigNightlyTasksDto pydantic-model

Bases: BaseModel

AdminConfigNightlyTasksDto

Show JSON schema:
{
  "description": "AdminConfigNightlyTasksDto",
  "properties": {
    "clusterNewFaces": {
      "description": "Cluster new faces",
      "title": "Clusternewfaces",
      "type": "boolean"
    },
    "databaseCleanup": {
      "description": "Database cleanup",
      "title": "Databasecleanup",
      "type": "boolean"
    },
    "generateMemories": {
      "description": "Generate memories",
      "title": "Generatememories",
      "type": "boolean"
    },
    "missingThumbnails": {
      "description": "Missing thumbnails",
      "title": "Missingthumbnails",
      "type": "boolean"
    },
    "startTime": {
      "description": "Start time (HH:MM)",
      "title": "Starttime",
      "type": "string"
    },
    "syncQuotaUsage": {
      "description": "Sync quota usage",
      "title": "Syncquotausage",
      "type": "boolean"
    }
  },
  "required": [
    "clusterNewFaces",
    "databaseCleanup",
    "generateMemories",
    "missingThumbnails",
    "startTime",
    "syncQuotaUsage"
  ],
  "title": "AdminConfigNightlyTasksDto",
  "type": "object"
}

Config:

  • validate_by_name: True
  • validate_by_alias: True
  • validate_assignment: True
  • protected_namespaces: ()

Fields:

Validators:

cluster_new_faces pydantic-field

cluster_new_faces: StrictBool

Cluster new faces

database_cleanup pydantic-field

database_cleanup: StrictBool

Database cleanup

generate_memories pydantic-field

generate_memories: StrictBool

Generate memories

missing_thumbnails pydantic-field

missing_thumbnails: StrictBool

Missing thumbnails

start_time pydantic-field

start_time: Annotated[str, Field(strict=True)]

Start time (HH:MM)

sync_quota_usage pydantic-field

sync_quota_usage: StrictBool

Sync quota usage

from_dict classmethod

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

Create an instance of AdminConfigNightlyTasksDto from a dict

Source code in immichpy/client/generated/models/admin_config_nightly_tasks_dto.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of AdminConfigNightlyTasksDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "clusterNewFaces": obj.get("clusterNewFaces"),
            "databaseCleanup": obj.get("databaseCleanup"),
            "generateMemories": obj.get("generateMemories"),
            "missingThumbnails": obj.get("missingThumbnails"),
            "startTime": obj.get("startTime"),
            "syncQuotaUsage": obj.get("syncQuotaUsage"),
        }
    )
    return _obj

from_json classmethod

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

Create an instance of AdminConfigNightlyTasksDto from a JSON string

Source code in immichpy/client/generated/models/admin_config_nightly_tasks_dto.py
85
86
87
88
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AdminConfigNightlyTasksDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

start_time_validate_regular_expression pydantic-validator

start_time_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/admin_config_nightly_tasks_dto.py
59
60
61
62
63
64
65
66
67
68
@field_validator("start_time", mode="before")
def start_time_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^(?:[01]\d|2[0-3]):[0-5]\d$", value
    ):
        raise ValueError(
            r"must validate the regular expression /^(?:[01]\d|2[0-3]):[0-5]\d$/"
        )
    return value

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/admin_config_nightly_tasks_dto.py
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
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/admin_config_nightly_tasks_dto.py
81
82
83
def to_json(self) -> str:
    """Returns the JSON representation of the model using alias"""
    return json.dumps(to_jsonable_python(self.to_dict()))

to_str

to_str() -> str

Returns the string representation of the model using alias

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