bayesline.api.ChangeOwnerItemResult

bayesline.api.ChangeOwnerItemResult#

model ChangeOwnerItemResult#

The result of a single change-owner operation.

Fields#
Field	Type	Required	Default
`id`	`int` \| `None`	Yes
`message`	`str`	No	`''`
`moved`	`list`[`str`]	No	factory
`name`	`str` \| `None`	Yes
`name_or_id`	`str` \| `int`	Yes
`new_owner`	`str` \| `None`	No	`None`
`previous_owner`	`str` \| `None`	No	`None`
`short_message`	`str`	No	`''`
`status`	`ItemStatus`	Yes
`updated_referrers`	`list`[`str`]	No	factory

field id: int | None [Required]#: The identifier of the item if available. Will always be available if the operation was successful.

field message: str [Optional]#: The human readable message of the item’s operation result.

field moved: list[str] [Optional]#: Qualified names (under the new owner) of every settings object moved for this item: the item itself plus, when references are included, its moved references.

field name: str | None [Required]#: The name of the item if available. Will always be available if the operation was successful.

field name_or_id: str | int [Required]#: The name or identifier of the item as it was provided to the operation.

field new_owner: str | None [Optional]#: The owner the settings object belongs to after the move.

field previous_owner: str | None [Optional]#: The owner the settings object belonged to before the move.

field short_message: str [Optional]#: A short message of the item’s operation result which can be used for summary messages. E.g. if a user could not be found, the short message should be the input of the user that could not be found.

field status: ItemStatus [Required]#: The status of the item operation.

field updated_referrers: list[str] [Optional]#: Qualified names of settings objects whose stored references were rewritten to the moved settings’ new qualified names.