Skip to content

Asset Bulk Upload Check Result

immichpy.client.generated.models.asset_bulk_upload_check_result.AssetBulkUploadCheckResult pydantic-model

Bases: BaseModel

AssetBulkUploadCheckResult

Show JSON schema: 
{
  "description": "AssetBulkUploadCheckResult",
  "properties": {
    "action": {
      "description": "Upload action",
      "title": "Action",
      "type": "string"
    },
    "assetId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Existing asset ID if duplicate",
      "title": "Assetid"
    },
    "id": {
      "description": "Asset ID",
      "title": "Id",
      "type": "string"
    },
    "isTrashed": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether existing asset is trashed",
      "title": "Istrashed"
    },
    "reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Rejection reason if rejected",
      "title": "Reason"
    }
  },
  "required": [
    "action",
    "id"
  ],
  "title": "AssetBulkUploadCheckResult",
  "type": "object"
}

Config:

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

Fields:

Validators:

action pydantic-field 

action: StrictStr

Upload action

asset_id pydantic-field 

asset_id: Optional[StrictStr] = None

Existing asset ID if duplicate

id pydantic-field 

id: StrictStr

Asset ID

is_trashed pydantic-field 

is_trashed: Optional[StrictBool] = None

Whether existing asset is trashed

reason pydantic-field 

reason: Optional[StrictStr] = None

Rejection reason if rejected

action_validate_enum pydantic-validator 

action_validate_enum(value)

Validates the enum

Source code in immichpy/client/generated/models/asset_bulk_upload_check_result.py 
56
57
58
59
60
61
@field_validator("action")
def action_validate_enum(cls, value):
    """Validates the enum"""
    if value not in set(["accept", "reject"]):
        raise ValueError("must be one of enum values ('accept', 'reject')")
    return value

from_dict classmethod 

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

Create an instance of AssetBulkUploadCheckResult from a dict

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

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

    _obj = cls.model_validate(
        {
            "action": obj.get("action"),
            "assetId": obj.get("assetId"),
            "id": obj.get("id"),
            "isTrashed": obj.get("isTrashed"),
            "reason": obj.get("reason"),
        }
    )
    return _obj

from_json classmethod 

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

Create an instance of AssetBulkUploadCheckResult from a JSON string

Source code in immichpy/client/generated/models/asset_bulk_upload_check_result.py 
90
91
92
93
@classmethod
def from_json(cls, json_str: str) -> Optional[Self]:
    """Create an instance of AssetBulkUploadCheckResult from a JSON string"""
    return cls.from_dict(json.loads(json_str))

reason_validate_enum pydantic-validator 

reason_validate_enum(value)

Validates the enum

Source code in immichpy/client/generated/models/asset_bulk_upload_check_result.py 
63
64
65
66
67
68
69
70
71
72
73
@field_validator("reason")
def reason_validate_enum(cls, value):
    """Validates the enum"""
    if value is None:
        return value

    if value not in set(["duplicate", "unsupported-format"]):
        raise ValueError(
            "must be one of enum values ('duplicate', 'unsupported-format')"
        )
    return value

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_bulk_upload_check_result.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
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_bulk_upload_check_result.py 
85
86
87
88
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_bulk_upload_check_result.py 
81
82
83
def to_str(self) -> str:
    """Returns the string representation of the model using alias"""
    return pprint.pformat(self.model_dump(by_alias=True))