Skip to content

Map Marker Response Dto

immichpy.client.generated.models.map_marker_response_dto.MapMarkerResponseDto pydantic-model

Bases: BaseModel

MapMarkerResponseDto

Show JSON schema: 
{
  "description": "MapMarkerResponseDto",
  "properties": {
    "city": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "City name",
      "title": "City"
    },
    "country": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Country name",
      "title": "Country"
    },
    "id": {
      "description": "Asset ID",
      "title": "Id",
      "type": "string"
    },
    "lat": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Latitude",
      "title": "Lat"
    },
    "lon": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "integer"
        }
      ],
      "description": "Longitude",
      "title": "Lon"
    },
    "state": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "State/Province name",
      "title": "State"
    }
  },
  "required": [
    "city",
    "country",
    "id",
    "lat",
    "lon",
    "state"
  ],
  "title": "MapMarkerResponseDto",
  "type": "object"
}

Config:

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

Fields:

city pydantic-field 

city: Optional[StrictStr]

City name

country pydantic-field 

country: Optional[StrictStr]

Country name

id pydantic-field 

id: StrictStr

Asset ID

lat pydantic-field 

lat: Union[StrictFloat, StrictInt]

Latitude

lon pydantic-field 

lon: Union[StrictFloat, StrictInt]

Longitude

state pydantic-field 

state: Optional[StrictStr]

State/Province name

from_dict classmethod 

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

Create an instance of MapMarkerResponseDto from a dict

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

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

    _obj = cls.model_validate(
        {
            "city": obj.get("city"),
            "country": obj.get("country"),
            "id": obj.get("id"),
            "lat": obj.get("lat"),
            "lon": obj.get("lon"),
            "state": obj.get("state"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of MapMarkerResponseDto from a JSON string

Source code in immichpy/client/generated/models/map_marker_response_dto.py 
53
54
55
56
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of MapMarkerResponseDto 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/map_marker_response_dto.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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,
    )
    # set to None if city (nullable) is None
    # and model_fields_set contains the field
    if self.city is None and "city" in self.model_fields_set:
        _dict["city"] = None

    # set to None if country (nullable) is None
    # and model_fields_set contains the field
    if self.country is None and "country" in self.model_fields_set:
        _dict["country"] = None

    # set to None if state (nullable) is None
    # and model_fields_set contains the field
    if self.state is None and "state" in self.model_fields_set:
        _dict["state"] = None

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/map_marker_response_dto.py 
48
49
50
51
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/map_marker_response_dto.py 
44
45
46
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))