Skip to content

Admin Config Library Dto

immichpy.client.generated.models.admin_config_library_dto.AdminConfigLibraryDto pydantic-model

Bases: BaseModel

AdminConfigLibraryDto

Show JSON schema: 
{
  "$defs": {
    "AdminConfigLibraryScanDto": {
      "description": "AdminConfigLibraryScanDto",
      "properties": {
        "cronExpression": {
          "description": "Cron expression",
          "title": "Cronexpression",
          "type": "string"
        },
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "cronExpression",
        "enabled"
      ],
      "title": "AdminConfigLibraryScanDto",
      "type": "object"
    },
    "AdminConfigLibraryWatchDto": {
      "description": "AdminConfigLibraryWatchDto",
      "properties": {
        "enabled": {
          "description": "Enabled",
          "title": "Enabled",
          "type": "boolean"
        }
      },
      "required": [
        "enabled"
      ],
      "title": "AdminConfigLibraryWatchDto",
      "type": "object"
    }
  },
  "description": "AdminConfigLibraryDto",
  "properties": {
    "scan": {
      "$ref": "#/$defs/AdminConfigLibraryScanDto"
    },
    "watch": {
      "$ref": "#/$defs/AdminConfigLibraryWatchDto"
    }
  },
  "required": [
    "scan",
    "watch"
  ],
  "title": "AdminConfigLibraryDto",
  "type": "object"
}

Config:

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

Fields:

from_dict classmethod 

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

Create an instance of AdminConfigLibraryDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "scan": AdminConfigLibraryScanDto.from_dict(obj["scan"])
            if obj.get("scan") is not None
            else None,
            "watch": AdminConfigLibraryWatchDto.from_dict(obj["watch"])
            if obj.get("watch") is not None
            else None,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AdminConfigLibraryDto from a JSON string

Source code in immichpy/client/generated/models/admin_config_library_dto.py 
56
57
58
59
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AdminConfigLibraryDto 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/admin_config_library_dto.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
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 scan
    if self.scan:
        _dict["scan"] = self.scan.to_dict()
    # override the default output from pydantic by calling `to_dict()` of watch
    if self.watch:
        _dict["watch"] = self.watch.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/admin_config_library_dto.py 
52
53
54
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_library_dto.py 
48
49
50
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))