Skip to content

Search Order

immichpy.client.generated.models.search_order.SearchOrder pydantic-model

Bases: BaseModel

SearchOrder

Show JSON schema: 
{
  "$defs": {
    "AssetOrder": {
      "description": "Asset sort order",
      "enum": [
        "asc",
        "desc"
      ],
      "title": "AssetOrder",
      "type": "string"
    },
    "SearchOrderField": {
      "description": "SearchOrderField",
      "enum": [
        "fileCreatedAt",
        "localDateTime",
        "fileSizeInBytes",
        "rating"
      ],
      "title": "SearchOrderField",
      "type": "string"
    }
  },
  "description": "SearchOrder",
  "properties": {
    "direction": {
      "anyOf": [
        {
          "$ref": "#/$defs/AssetOrder"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "field": {
      "anyOf": [
        {
          "$ref": "#/$defs/SearchOrderField"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "title": "SearchOrder",
  "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 SearchOrder from a dict

Source code in immichpy/client/generated/models/search_order.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of SearchOrder from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {"direction": obj.get("direction"), "field": obj.get("field")}
    )
    return _obj

from_json classmethod 

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

Create an instance of SearchOrder from a JSON string

Source code in immichpy/client/generated/models/search_order.py 
52
53
54
55
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SearchOrder 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/search_order.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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/search_order.py 
48
49
50
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/search_order.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))