Struct ExecuteUpdatePayload 

pub struct ExecuteUpdatePayload {
    pub host_machine_id: String,
    pub update_history_id: Uuid,
    pub software_item_id: Uuid,
    pub software_item_name: String,
    pub to_version: String,
    pub detect_version_plugin: Option<PluginAssignment>,
    pub execute_update_plugin: PluginAssignment,
    pub pre_update_hook_plugins: Vec<PluginAssignment>,
    pub post_update_hook_plugins: Vec<PluginAssignment>,
    pub release_info: Option<ReleaseInfo>,
    pub timeout: Duration,
    pub interactive: bool,
}

Controller -> Agent: Trigger an update.

Fields

host_machine_id: String

The machine_id of the host to run the update on.

For the regular agent (one service = one host), the agent validates that this matches its own machine_id as a defensive sanity check. For the SSH agent (one service = N remote hosts), the agent uses this field to look up the correct SSH credentials and route the operation to the right remote host.

update_history_id: Uuid

software_item_id: Uuid

software_item_name: String

to_version: String

detect_version_plugin: Option<PluginAssignment>

Plugin for the detect_version role (for before/after installed-version detection). Absent when no detect_version plugin is configured for this assignment.

execute_update_plugin: PluginAssignment

Plugin for the execute_update role.

pre_update_hook_plugins: Vec<PluginAssignment>

Pre-update hook plugins to execute before the update, ordered by priority.

post_update_hook_plugins: Vec<PluginAssignment>

Post-update hook plugins to execute after the update, ordered by priority.

release_info: Option<ReleaseInfo>

timeout: Duration

Timeout for the update execution.

Wire field name: timeout_seconds (kept for backward compatibility).

interactive: bool

When true, the agent allocates a PTY and keeps stdin open for forwarding.

Requires the agent to advertise the InteractiveUpdates capability. Defaults to false for backward compatibility with older agents.

Trait Implementations

impl Clone for ExecuteUpdatePayload

fn clone(&self) -> ExecuteUpdatePayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecuteUpdatePayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExecuteUpdatePayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExecuteUpdatePayload

impl PartialEq for ExecuteUpdatePayload

fn eq(&self, other: &ExecuteUpdatePayload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExecuteUpdatePayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExecuteUpdatePayload

impl WireValidate for ExecuteUpdatePayload

fn wire_validate(&self) -> Result<(), WireValidationError>

Validate that all fields are within wire protocol size limits.