Struct AgentSyncRequest 

pub struct AgentSyncRequest {

    pub application: Option<ObservedApplicationReport>,
    pub capabilities: Vec<OperatorCapabilityReport>,
    pub current_state: Option<Value>,
    pub deployment_id: String,
    pub dynamic_containers: Option<Vec<DynamicContainerReport>>,
    pub execution_claim: Option<ExecutionClaim>,
    pub installed_setup: Option<InstalledSetup>,
    pub max_supported_deployment_protocol_version: Option<i32>,
    pub observed_inventory_batches: Vec<ObservedInventoryBatch>,
    pub operations_config: Option<OperationsConfig>,
    pub operations_report: Option<OperationsReport>,
    pub operator_image: Option<OperatorImageReport>,
    pub operator_version: Option<String>,
    pub resource_heartbeats: Vec<ResourceHeartbeat>,
    pub session: Option<String>,
    pub supports_execution_claims: Option<bool>,
    pub supports_tunnels: Option<bool>,
}

Body of POST /v1/sync.

JSON schema

{
 "description": "Body of `POST /v1/sync`.",
 "allOf": [
   {
     "type": "object",
     "required": [
       "deploymentId"
     ],
     "properties": {
       "capabilities": {
         "type": "array",
         "items": {
           "$ref": "#/components/schemas/OperatorCapabilityReport"
         }
       },
       "currentState": {
         "description": "Current deployment state as reported by the agent.\nWhen present, the manager updates the deployment record to reflect\nthe agent's progress (status, stack_state, etc.)."
       },
       "deploymentId": {
         "type": "string"
       },
       "executionClaim": {
         "oneOf": [
           {
             "type": "null"
           },
           {
             "allOf": [
               {
                 "$ref": "#/components/schemas/ExecutionClaim"
               }
             ]
           }
         ]
       },
       "observedInventoryBatches": {
         "type": "array",
         "items": {
           "$ref": "#/components/schemas/ObservedInventoryBatch"
         }
       },
       "operationsReport": {
         "description": "The Operator's self-reported operations-plugin catalog and loaded\nbundle hash. Opaque to OSS beyond forwarding it to `reconcile()`.",
         "oneOf": [
           {
             "type": "null"
           },
           {
             "allOf": [
               {
                 "$ref": "#/components/schemas/OperationsReport"
               }
             ]
           }
         ]
       },
       "operatorVersion": {
         "type": [
           "string",
           "null"
         ]
       },
       "resourceHeartbeats": {
         "description": "Managed resource status samples emitted by pull-mode deployment steps.",
         "type": "array",
         "items": {
           "$ref": "#/components/schemas/ResourceHeartbeat"
         }
       },
       "session": {
         "type": "string"
       },
       "supportsExecutionClaims": {
         "type": "boolean"
       },
       "supportsTunnels": {
         "description": "Absent for Operators that predate container tunnels.",
         "type": "boolean"
       }
     }
   },
   {
     "type": "object",
     "properties": {
       "application": {
         "description": "Application release the Operator observed in its environment.\nOpaque to OSS beyond forwarding it to `reconcile_request()`.",
         "oneOf": [
           {
             "type": "null"
           },
           {
             "allOf": [
               {
                 "$ref": "#/components/schemas/ObservedApplicationReport"
               }
             ]
           }
         ]
       },
       "dynamicContainers": {
         "description": "Absent for older Operators. This report has no secret values.",
         "type": [
           "array",
           "null"
         ],
         "items": {
           "$ref": "#/components/schemas/DynamicContainerReport"
         }
       },
       "installedSetup": {
         "description": "The setup the installed chart carries. An observation the manager may\nact on under its own rules; never a grant.",
         "oneOf": [
           {
             "type": "null"
           },
           {
             "allOf": [
               {
                 "$ref": "#/components/schemas/InstalledSetup"
               }
             ]
           }
         ]
       },
       "maxSupportedDeploymentProtocolVersion": {
         "description": "Missing on actors that only understand protocol1.",
         "type": [
           "integer",
           "null"
         ],
         "format": "int32",
         "minimum": 0.0
       },
       "operationsConfig": {
         "description": "Operations an Operator installed without a release declares, without\nsetting values. Opaque to OSS beyond forwarding it.",
         "oneOf": [
           {
             "type": "null"
           },
           {
             "allOf": [
               {
                 "$ref": "#/components/schemas/OperationsConfig"
               }
             ]
           }
         ]
       },
       "operatorImage": {
         "description": "Exact immutable Operator image identity reported by the running process.",
         "oneOf": [
           {
             "type": "null"
           },
           {
             "allOf": [
               {
                 "$ref": "#/components/schemas/OperatorImageReport"
               }
             ]
           }
         ]
       }
     }
   }
 ]
}

Fields

application: Option<ObservedApplicationReport>

Application release the Operator observed in its environment. Opaque to OSS beyond forwarding it to reconcile_request().

capabilities: Vec<OperatorCapabilityReport>

current_state: Option<Value>

Current deployment state as reported by the agent. When present, the manager updates the deployment record to reflect the agent’s progress (status, stack_state, etc.).

deployment_id: String

dynamic_containers: Option<Vec<DynamicContainerReport>>

Absent for older Operators. This report has no secret values.

execution_claim: Option<ExecutionClaim>

installed_setup: Option<InstalledSetup>

The setup the installed chart carries. An observation the manager may act on under its own rules; never a grant.

max_supported_deployment_protocol_version: Option<i32>

Missing on actors that only understand protocol1.

observed_inventory_batches: Vec<ObservedInventoryBatch>

operations_config: Option<OperationsConfig>

Operations an Operator installed without a release declares, without setting values. Opaque to OSS beyond forwarding it.

operations_report: Option<OperationsReport>

The Operator’s self-reported operations-plugin catalog and loaded bundle hash. Opaque to OSS beyond forwarding it to reconcile().

operator_image: Option<OperatorImageReport>

Exact immutable Operator image identity reported by the running process.

operator_version: Option<String>

resource_heartbeats: Vec<ResourceHeartbeat>

Managed resource status samples emitted by pull-mode deployment steps.

session: Option<String>

supports_execution_claims: Option<bool>

supports_tunnels: Option<bool>

Absent for Operators that predate container tunnels.

Implementations

impl AgentSyncRequest

pub fn builder() -> AgentSyncRequest

Trait Implementations

impl Clone for AgentSyncRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentSyncRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentSyncRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AgentSyncRequest> for AgentSyncRequest

fn from(value: &AgentSyncRequest) -> Self

Converts to this type from the input type.

impl From<AgentSyncRequest> for AgentSyncRequest

fn from(value: AgentSyncRequest) -> Self

Converts to this type from the input type.

impl Serialize for AgentSyncRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<AgentSyncRequest> for AgentSyncRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: AgentSyncRequest) -> Result<Self, ConversionError>

Performs the conversion.