Skip to content

Asset Stack Response Dto

immichpy.client.generated.models.asset_stack_response_dto.AssetStackResponseDto pydantic-model

Bases: BaseModel

AssetStackResponseDto

Show JSON schema: 
{
  "description": "AssetStackResponseDto",
  "properties": {
    "assetCount": {
      "description": "Number of assets in stack",
      "maximum": 9007199254740991,
      "minimum": 0,
      "title": "Assetcount",
      "type": "integer"
    },
    "id": {
      "description": "Stack ID",
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "primaryAssetId": {
      "description": "Primary asset ID",
      "format": "uuid",
      "title": "Primaryassetid",
      "type": "string"
    }
  },
  "required": [
    "assetCount",
    "id",
    "primaryAssetId"
  ],
  "title": "AssetStackResponseDto",
  "type": "object"
}

Config:

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

Fields:

Validators:

asset_count pydantic-field 

asset_count: Annotated[int, Field(le=9007199254740991, strict=True, ge=0)]

Number of assets in stack

id pydantic-field 

id: UUID

Stack ID

primary_asset_id pydantic-field 

primary_asset_id: UUID

Primary asset ID

from_dict classmethod 

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

Create an instance of AssetStackResponseDto from a dict

Source code in immichpy/client/generated/models/asset_stack_response_dto.py 
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of AssetStackResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "assetCount": obj.get("assetCount"),
            "id": obj.get("id"),
            "primaryAssetId": obj.get("primaryAssetId"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AssetStackResponseDto from a JSON string

Source code in immichpy/client/generated/models/asset_stack_response_dto.py 
81
82
83
84
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AssetStackResponseDto from a JSON string"""
    return cls.from_dict(json.loads(json_str))

id_validate_regular_expression pydantic-validator 

id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/asset_stack_response_dto.py 
42
43
44
45
46
47
48
49
50
51
52
@field_validator("id", mode="before")
def id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    return value

primary_asset_id_validate_regular_expression pydantic-validator 

primary_asset_id_validate_regular_expression(value)

Validates the regular expression

Source code in immichpy/client/generated/models/asset_stack_response_dto.py 
54
55
56
57
58
59
60
61
62
63
64
@field_validator("primary_asset_id", mode="before")
def primary_asset_id_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if isinstance(value, str) and not re.match(
        r"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
        value,
    ):
        raise ValueError(
            r"must validate the regular expression /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$/"
        )
    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/asset_stack_response_dto.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
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/asset_stack_response_dto.py 
77
78
79
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/asset_stack_response_dto.py 
73
74
75
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))