Plugin Action Response Dto
immichpy.client.generated.models.plugin_action_response_dto.PluginActionResponseDto
pydantic-model
Bases: BaseModel
PluginActionResponseDto
Show JSON schema:
{
"$defs": {
"PluginContextType": {
"description": "Context type",
"enum": [
"asset",
"album",
"person"
],
"title": "PluginContextType",
"type": "string"
}
},
"description": "PluginActionResponseDto",
"properties": {
"description": {
"description": "Action description",
"title": "Description",
"type": "string"
},
"id": {
"description": "Action ID",
"title": "Id",
"type": "string"
},
"methodName": {
"description": "Method name",
"title": "Methodname",
"type": "string"
},
"pluginId": {
"description": "Plugin ID",
"title": "Pluginid",
"type": "string"
},
"schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"description": "Action schema",
"title": "Schema"
},
"supportedContexts": {
"description": "Supported contexts",
"items": {
"$ref": "#/$defs/PluginContextType"
},
"title": "Supportedcontexts",
"type": "array"
},
"title": {
"description": "Action title",
"title": "Title",
"type": "string"
}
},
"required": [
"description",
"id",
"methodName",
"pluginId",
"schema",
"supportedContexts",
"title"
],
"title": "PluginActionResponseDto",
"type": "object"
}
Config:
populate_by_name:Truevalidate_assignment:Trueprotected_namespaces:()
Fields:
-
description(StrictStr) -
id(StrictStr) -
method_name(StrictStr) -
plugin_id(StrictStr) -
var_schema(Optional[Dict[str, Any]]) -
supported_contexts(List[PluginContextType]) -
title(StrictStr)
description
pydantic-field
description: StrictStr
Action description
id
pydantic-field
id: StrictStr
Action ID
method_name
pydantic-field
method_name: StrictStr
Method name
plugin_id
pydantic-field
plugin_id: StrictStr
Plugin ID
supported_contexts
pydantic-field
supported_contexts: List[PluginContextType]
Supported contexts
title
pydantic-field
title: StrictStr
Action title
var_schema
pydantic-field
var_schema: Optional[Dict[str, Any]]
Action schema
from_dict
classmethod
from_dict(obj: Optional[Dict[str, Any]]) -> Optional[Self]
Create an instance of PluginActionResponseDto from a dict
Source code in immichpy/client/generated/models/plugin_action_response_dto.py
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | |
from_json
classmethod
from_json(json_str: str) -> Optional[Self]
Create an instance of PluginActionResponseDto from a JSON string
Source code in immichpy/client/generated/models/plugin_action_response_dto.py
67 68 69 70 | |
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):
Noneis only added to the output dict for nullable fields that were set at model initialization. Other fields with valueNoneare ignored.
Source code in immichpy/client/generated/models/plugin_action_response_dto.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | |
to_json
to_json() -> str
Returns the JSON representation of the model using alias
Source code in immichpy/client/generated/models/plugin_action_response_dto.py
62 63 64 65 | |
to_str
to_str() -> str
Returns the string representation of the model using alias
Source code in immichpy/client/generated/models/plugin_action_response_dto.py
58 59 60 | |