Skip to content

Create Library Dto

immichpy.client.generated.models.create_library_dto.CreateLibraryDto pydantic-model

Bases: BaseModel

CreateLibraryDto

Show JSON schema: 
{
  "description": "CreateLibraryDto",
  "properties": {
    "exclusionPatterns": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "maxItems": 128,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Exclusion patterns (max 128)",
      "title": "Exclusionpatterns"
    },
    "importPaths": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "maxItems": 128,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Import paths (max 128)",
      "title": "Importpaths"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Library name",
      "title": "Name"
    },
    "ownerId": {
      "description": "Owner user ID",
      "format": "uuid",
      "title": "Ownerid",
      "type": "string"
    }
  },
  "required": [
    "ownerId"
  ],
  "title": "CreateLibraryDto",
  "type": "object"
}

Config:

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

Fields:

exclusion_patterns pydantic-field 

exclusion_patterns: Optional[Annotated[List[StrictStr], Field(max_length=128)]] = None

Exclusion patterns (max 128)

import_paths pydantic-field 

import_paths: Optional[Annotated[List[StrictStr], Field(max_length=128)]] = None

Import paths (max 128)

name pydantic-field 

name: Optional[StrictStr] = None

Library name

owner_id pydantic-field 

owner_id: UUID

Owner user ID

from_dict classmethod 

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

Create an instance of CreateLibraryDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "exclusionPatterns": obj.get("exclusionPatterns"),
            "importPaths": obj.get("importPaths"),
            "name": obj.get("name"),
            "ownerId": obj.get("ownerId"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of CreateLibraryDto from a JSON string

Source code in immichpy/client/generated/models/create_library_dto.py 
66
67
68
69
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of CreateLibraryDto 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/create_library_dto.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
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/create_library_dto.py 
61
62
63
64
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/create_library_dto.py 
57
58
59
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))