Skip to content

Asset Copy Dto

immichpy.client.generated.models.asset_copy_dto.AssetCopyDto pydantic-model

Bases: BaseModel

AssetCopyDto

Show JSON schema: 
{
  "description": "AssetCopyDto",
  "properties": {
    "albums": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": true,
      "description": "Copy album associations",
      "title": "Albums"
    },
    "favorite": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": true,
      "description": "Copy favorite status",
      "title": "Favorite"
    },
    "sharedLinks": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": true,
      "description": "Copy shared links",
      "title": "Sharedlinks"
    },
    "sidecar": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": true,
      "description": "Copy sidecar file",
      "title": "Sidecar"
    },
    "sourceId": {
      "description": "Source asset ID",
      "format": "uuid",
      "title": "Sourceid",
      "type": "string"
    },
    "stack": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": true,
      "description": "Copy stack association",
      "title": "Stack"
    },
    "targetId": {
      "description": "Target asset ID",
      "format": "uuid",
      "title": "Targetid",
      "type": "string"
    }
  },
  "required": [
    "sourceId",
    "targetId"
  ],
  "title": "AssetCopyDto",
  "type": "object"
}

Config:

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

Fields:

albums pydantic-field 

albums: Optional[StrictBool] = True

Copy album associations

favorite pydantic-field 

favorite: Optional[StrictBool] = True

Copy favorite status

shared_links: Optional[StrictBool] = True

Copy shared links

sidecar pydantic-field 

sidecar: Optional[StrictBool] = True

Copy sidecar file

source_id pydantic-field 

source_id: UUID

Source asset ID

stack pydantic-field 

stack: Optional[StrictBool] = True

Copy stack association

target_id pydantic-field 

target_id: UUID

Target asset ID

from_dict classmethod 

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

Create an instance of AssetCopyDto from a dict

Source code in immichpy/client/generated/models/asset_copy_dto.py 
 95
 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
@classmethod
def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
    """Create an instance of AssetCopyDto from a dict"""
    if obj is None:
        return None

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

    _obj = cls.model_validate(
        {
            "albums": obj.get("albums") if obj.get("albums") is not None else True,
            "favorite": obj.get("favorite")
            if obj.get("favorite") is not None
            else True,
            "sharedLinks": obj.get("sharedLinks")
            if obj.get("sharedLinks") is not None
            else True,
            "sidecar": obj.get("sidecar")
            if obj.get("sidecar") is not None
            else True,
            "sourceId": obj.get("sourceId"),
            "stack": obj.get("stack") if obj.get("stack") is not None else True,
            "targetId": obj.get("targetId"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AssetCopyDto from a JSON string

Source code in immichpy/client/generated/models/asset_copy_dto.py 
71
72
73
74
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AssetCopyDto 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/asset_copy_dto.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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/asset_copy_dto.py 
66
67
68
69
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/asset_copy_dto.py 
62
63
64
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))