Struct CollectHint 

pub struct CollectHint {
    pub name: String,
    pub description: Option<String>,
    pub max_size: Option<String>,
    pub files_field: String,
}

Manifest sub-section (#219): marks a job as a file collector and carries how the collected bundle presents in the SPA. Parallel to InventoryHint / CheckHint — the block’s presence is the opt-in. The script prints a single JSON object on stdout whose files_field key holds an array of file paths to bundle (env vars are expanded); the agent zips them and uploads to OBJECT_COLLECTIONS. See Manifest::collect.

Fields

name: String

Operator/end-user-facing title for the collection, shown as the bundle’s heading on the SPA Collect page (and the Client App row when paired with client:). Required; validated non-empty.

description: Option<String>

Optional one-line description of what the bundle contains.

max_size: Option<String>

Human-readable cap on the bundle’s total input size ("50MB", "500KB", "1GiB"). The agent refuses to build a bundle whose listed files exceed this. None ⇒ DEFAULT_COLLECT_MAX_SIZE. Parsed by parse_size_bytes; Manifest::validate rejects an unparseable value at create time.

Note: this bounds the uncompressed bytes the agent reads off disk, not the resulting zip. Text logs compress well, so the download is usually much smaller; many tiny files add a little per-entry zip overhead. Read it as “how much the agent reads + packs”, not “the exact download size”.

files_field: String

Top-level stdout JSON key holding the array of file paths to bundle. Defaults to "files".

Implementations

impl CollectHint

pub fn max_size_bytes(&self) -> u64

The effective size cap in bytes — the parsed max_size or DEFAULT_COLLECT_MAX_SIZE when unset. Assumes max_size (if present) already passed Manifest::validate; falls back to the default on a parse error rather than panicking on the fire path.

Trait Implementations

impl Clone for CollectHint

fn clone(&self) -> CollectHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectHint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectHint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CollectHint

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for CollectHint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.