Skip to content

Server Stats Response Dto

immichpy.client.generated.models.server_stats_response_dto.ServerStatsResponseDto pydantic-model

Bases: BaseModel

ServerStatsResponseDto

Show JSON schema: 
{
  "$defs": {
    "UsageByUserDto": {
      "description": "UsageByUserDto",
      "properties": {
        "photos": {
          "description": "Number of photos",
          "title": "Photos",
          "type": "integer"
        },
        "quotaSizeInBytes": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "description": "User quota size in bytes (null if unlimited)",
          "title": "Quotasizeinbytes"
        },
        "usage": {
          "description": "Total storage usage in bytes",
          "title": "Usage",
          "type": "integer"
        },
        "usagePhotos": {
          "description": "Storage usage for photos in bytes",
          "title": "Usagephotos",
          "type": "integer"
        },
        "usageVideos": {
          "description": "Storage usage for videos in bytes",
          "title": "Usagevideos",
          "type": "integer"
        },
        "userId": {
          "description": "User ID",
          "title": "Userid",
          "type": "string"
        },
        "userName": {
          "description": "User name",
          "title": "Username",
          "type": "string"
        },
        "videos": {
          "description": "Number of videos",
          "title": "Videos",
          "type": "integer"
        }
      },
      "required": [
        "photos",
        "quotaSizeInBytes",
        "usage",
        "usagePhotos",
        "usageVideos",
        "userId",
        "userName",
        "videos"
      ],
      "title": "UsageByUserDto",
      "type": "object"
    }
  },
  "description": "ServerStatsResponseDto",
  "properties": {
    "photos": {
      "description": "Total number of photos",
      "title": "Photos",
      "type": "integer"
    },
    "usage": {
      "description": "Total storage usage in bytes",
      "title": "Usage",
      "type": "integer"
    },
    "usageByUser": {
      "items": {
        "$ref": "#/$defs/UsageByUserDto"
      },
      "title": "Usagebyuser",
      "type": "array"
    },
    "usagePhotos": {
      "description": "Storage usage for photos in bytes",
      "title": "Usagephotos",
      "type": "integer"
    },
    "usageVideos": {
      "description": "Storage usage for videos in bytes",
      "title": "Usagevideos",
      "type": "integer"
    },
    "videos": {
      "description": "Total number of videos",
      "title": "Videos",
      "type": "integer"
    }
  },
  "required": [
    "photos",
    "usage",
    "usageByUser",
    "usagePhotos",
    "usageVideos",
    "videos"
  ],
  "title": "ServerStatsResponseDto",
  "type": "object"
}

Config:

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

Fields:

photos pydantic-field 

photos: StrictInt

Total number of photos

usage pydantic-field 

usage: StrictInt

Total storage usage in bytes

usage_photos pydantic-field 

usage_photos: StrictInt

Storage usage for photos in bytes

usage_videos pydantic-field 

usage_videos: StrictInt

Storage usage for videos in bytes

videos pydantic-field 

videos: StrictInt

Total number of videos

from_dict classmethod 

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

Create an instance of ServerStatsResponseDto from a dict

Source code in immichpy/client/generated/models/server_stats_response_dto.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of ServerStatsResponseDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "photos": obj.get("photos") if obj.get("photos") is not None else 0,
            "usage": obj.get("usage") if obj.get("usage") is not None else 0,
            "usageByUser": [
                UsageByUserDto.from_dict(_item) for _item in obj["usageByUser"]
            ]
            if obj.get("usageByUser") is not None
            else None,
            "usagePhotos": obj.get("usagePhotos")
            if obj.get("usagePhotos") is not None
            else 0,
            "usageVideos": obj.get("usageVideos")
            if obj.get("usageVideos") is not None
            else 0,
            "videos": obj.get("videos") if obj.get("videos") is not None else 0,
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of ServerStatsResponseDto from a JSON string

Source code in immichpy/client/generated/models/server_stats_response_dto.py 
65
66
67
68
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of ServerStatsResponseDto 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/server_stats_response_dto.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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 each item in usage_by_user (list)
    _items = []
    if self.usage_by_user:
        for _item_usage_by_user in self.usage_by_user:
            if _item_usage_by_user:
                _items.append(_item_usage_by_user.to_dict())
        _dict["usageByUser"] = _items
    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/server_stats_response_dto.py 
60
61
62
63
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/server_stats_response_dto.py 
56
57
58
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))