Skip to content

Sync Stream Dto

immichpy.client.generated.models.sync_stream_dto.SyncStreamDto pydantic-model

Bases: BaseModel

SyncStreamDto

Show JSON schema: 
{
  "$defs": {
    "SyncRequestType": {
      "description": "Sync request types",
      "enum": [
        "AlbumsV1",
        "AlbumUsersV1",
        "AlbumToAssetsV1",
        "AlbumAssetsV1",
        "AlbumAssetExifsV1",
        "AssetsV1",
        "AssetExifsV1",
        "AssetEditsV1",
        "AssetMetadataV1",
        "AuthUsersV1",
        "MemoriesV1",
        "MemoryToAssetsV1",
        "PartnersV1",
        "PartnerAssetsV1",
        "PartnerAssetExifsV1",
        "PartnerStacksV1",
        "StacksV1",
        "UsersV1",
        "PeopleV1",
        "AssetFacesV1",
        "AssetFacesV2",
        "UserMetadataV1"
      ],
      "title": "SyncRequestType",
      "type": "string"
    }
  },
  "description": "SyncStreamDto",
  "properties": {
    "reset": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Reset sync state",
      "title": "Reset"
    },
    "types": {
      "description": "Sync request types",
      "items": {
        "$ref": "#/$defs/SyncRequestType"
      },
      "title": "Types",
      "type": "array"
    }
  },
  "required": [
    "types"
  ],
  "title": "SyncStreamDto",
  "type": "object"
}

Config:

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

Fields:

reset pydantic-field 

reset: Optional[StrictBool] = None

Reset sync state

types pydantic-field 

types: List[SyncRequestType]

Sync request types

from_dict classmethod 

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

Create an instance of SyncStreamDto from a dict

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

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

    _obj = cls.model_validate(
        {"reset": obj.get("reset"), "types": obj.get("types")}
    )
    return _obj

from_json classmethod 

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

Create an instance of SyncStreamDto from a JSON string

Source code in immichpy/client/generated/models/sync_stream_dto.py 
50
51
52
53
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of SyncStreamDto 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/sync_stream_dto.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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/sync_stream_dto.py 
45
46
47
48
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/sync_stream_dto.py 
41
42
43
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))