Skip to content

String Pattern Filter

immichpy.client.generated.models.string_pattern_filter.StringPatternFilter pydantic-model

Bases: BaseModel

StringPatternFilter

Show JSON schema: 
{
  "description": "StringPatternFilter",
  "properties": {
    "endsWith": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Endswith"
    },
    "eq": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Eq"
    },
    "in": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "In"
    },
    "like": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Like"
    },
    "ne": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Ne"
    },
    "notIn": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Notin"
    },
    "notLike": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Notlike"
    },
    "startsWith": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Startswith"
    }
  },
  "title": "StringPatternFilter",
  "type": "object"
}

Config:

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

Fields:

  • ends_with (Optional[Annotated[str, Field(min_length=1, strict=True)]])
  • eq (Optional[StrictStr])
  • var_in (Optional[Annotated[List[StrictStr], Field(min_length=1)]])
  • like (Optional[Annotated[str, Field(min_length=1, strict=True)]])
  • ne (Optional[StrictStr])
  • not_in (Optional[Annotated[List[StrictStr], Field(min_length=1)]])
  • not_like (Optional[Annotated[str, Field(min_length=1, strict=True)]])
  • starts_with (Optional[Annotated[str, Field(min_length=1, strict=True)]])

from_dict classmethod 

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

Create an instance of StringPatternFilter from a dict

Source code in immichpy/client/generated/models/string_pattern_filter.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of StringPatternFilter from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "endsWith": obj.get("endsWith"),
            "eq": obj.get("eq"),
            "in": obj.get("in"),
            "like": obj.get("like"),
            "ne": obj.get("ne"),
            "notIn": obj.get("notIn"),
            "notLike": obj.get("notLike"),
            "startsWith": obj.get("startsWith"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of StringPatternFilter from a JSON string

Source code in immichpy/client/generated/models/string_pattern_filter.py 
76
77
78
79
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of StringPatternFilter 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/string_pattern_filter.py 
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
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 eq (nullable) is None
    # and model_fields_set contains the field
    if self.eq is None and "eq" in self.model_fields_set:
        _dict["eq"] = None

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

    return _dict

to_json 

to_json() -> str

Returns the JSON representation of the model using alias

Source code in immichpy/client/generated/models/string_pattern_filter.py 
72
73
74
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/string_pattern_filter.py 
68
69
70
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))