Skip to main content

hanzo_client/models/
control_command_view.rs

1/*
2 * Hanzo Cloud API
3 *
4 * The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
5 *
6 * The version of the OpenAPI document: v1
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct ControlCommandView {
16    /// Command is what was asked, from a closed four: pause, resume, stop, message. It is an INTENT — the poller decides what to do about it, and the session's status changes only when the poller reports back that it did.
17    #[serde(rename = "command", skip_serializing_if = "Option::is_none")]
18    pub command: Option<String>,
19    /// Message is the text that came with the command: what to say into the run for `message`, and the cancellation reason for `stop`. Up to 16 KiB. Empty on a bare pause or resume.
20    #[serde(rename = "message", skip_serializing_if = "Option::is_none")]
21    pub message: Option<String>,
22    #[serde(rename = "payload", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
23    pub payload: Option<Option<serde_json::Value>>,
24    /// Seq is this command's position in the session's log — the same monotonic number every other turn is ordered by, so a command sits in the transcript where it was issued. Send the highest one you applied back as `after` and it is never redelivered.
25    #[serde(rename = "seq", skip_serializing_if = "Option::is_none")]
26    pub seq: Option<i32>,
27}
28
29impl ControlCommandView {
30    pub fn new() -> ControlCommandView {
31        ControlCommandView {
32            command: None,
33            message: None,
34            payload: None,
35            seq: None,
36        }
37    }
38}
39