Struct ServiceSettingsPayload 

#[non_exhaustive]
pub struct ServiceSettingsPayload {
    pub renewal_window_hours: u16,
    pub ca_bundle_hash: String,
    pub capabilities: BTreeSet<Capability>,
    pub report_page_limits: ReportPageLimits,
    pub shutdown_timeout: Option<Duration>,
    pub ping_interval: Duration,
    pub tenant_id: Option<Uuid>,
    pub trust_domain: String,
}

Payload for service runtime settings pushed by the controller.

Used for both agents and MQTT services. shutdown_timeout is present for agents and None for MQTT services.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

renewal_window_hours: u16

ca_bundle_hash: String

capabilities: BTreeSet<Capability>

Capabilities advertised by the controller.

The service computes the agreed set as the intersection of this set with its own capabilities, considering only typed (known) variants.

report_page_limits: ReportPageLimits

Per-page item-count limits for paginated service-to-controller reports.

Services must honor these limits when splitting large report_hosts, discovery_results, version_check_results, and batch_update_result payloads across pages.

shutdown_timeout: Option<Duration>

Maximum time to wait for in-flight operations during shutdown. Present for agents, absent for MQTT services.

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

ping_interval: Duration

How often the service should send ping messages. Controller-managed; derived from per-service DB override or service-type default.

tenant_id: Option<Uuid>

Tenant UUID that this service belongs to.

None for system services (MQTT, scheduler) which are not tenant-scoped. Present for tenant-scoped agents so they can include the tenant identity in external provisioning operations (e.g. PVE API credential naming).

trust_domain: String

SPIFFE trust domain for Service identity URIs.

Empty string when the Controller has no trust domain configured. Agent falls back to the dialed hostname for SPIFFE SAN generation.

Implementations

impl ServiceSettingsPayload

pub fn new(renewal_window_hours: u16, ping_interval: Duration) -> Self

Creates a new ServiceSettingsPayload with the required fields.

Optional fields default to: ca_bundle_hash = empty, capabilities = empty, report_page_limits = default, shutdown_timeout = None, tenant_id = None, trust_domain = empty.

pub fn with_ca_bundle_hash(self, ca_bundle_hash: String) -> Self

Sets the CA bundle hash.

pub fn with_capabilities( self, capabilities: impl IntoIterator<Item = Capability>, ) -> Self

Sets the controller capability set.

pub fn with_report_page_limits( self, report_page_limits: ReportPageLimits, ) -> Self

Sets the report page limits.

pub fn with_shutdown_timeout(self, shutdown_timeout: Duration) -> Self

Sets the graceful-shutdown timeout for agent services.

pub fn with_tenant_id(self, tenant_id: Uuid) -> Self

Sets the tenant UUID for tenant-scoped services.

pub fn with_trust_domain(self, trust_domain: String) -> Self

Sets the SPIFFE trust domain advertised to connecting services.

Trait Implementations

impl Clone for ServiceSettingsPayload

fn clone(&self) -> ServiceSettingsPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceSettingsPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceSettingsPayload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ServiceSettingsPayload

impl PartialEq for ServiceSettingsPayload

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ServiceSettingsPayload

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 ServiceSettingsPayload

impl WireValidate for ServiceSettingsPayload

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

Validate that all fields are within wire protocol size limits.