Skip to main content

PackagePolicy

Struct PackagePolicy 

Source
#[non_exhaustive]
pub struct PackagePolicy { pub id: String, pub name: String, pub namespace: String, pub description: Option<String>, pub enabled: Option<bool>, pub revision: u64, pub package: PackageRef, pub policy_ids: Vec<String>, pub inputs: Value, pub vars: Option<Value>, pub version: Option<String>, pub extra: Map<String, Value>, }
Expand description

A package policy as Kibana returns it. Reads use Fleet’s full format; creation and simplified replacement responses use the simplified format.

Debug output omits inputs, variables and other fields, which can hold credentials.

Fields (Non-exhaustive)§

This struct is marked as 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.
§id: String§name: String§namespace: String§description: Option<String>§enabled: Option<bool>§revision: u64

Configuration revision, distinct from the opaque concurrency version.

§package: PackageRef§policy_ids: Vec<String>§inputs: Value

Full-format inputs are an array; simplified inputs are an object keyed by input name.

§vars: Option<Value>

Package-level variables.

§version: Option<String>

Opaque concurrency token, sent back by PackagePolicy::edit.

§extra: Map<String, Value>

Implementations§

Source§

impl PackagePolicy

Source

pub fn edit(&self) -> PackagePolicyEdit

A replacement for this policy in the full format. It keeps the current inputs, variables and assignments until changed, and is bound to the policy’s ID and concurrency token. If the response has simplified inputs, fetch the full policy with Fleet::get_package_policy before editing it. Sending an edit requires full inputs and a nonempty concurrency token; construction does not check them. Response-only compiled_input fields are removed from the inputs.

use security_client_rs::fleet::PackagePolicy;
use serde_json::{from_value, json, to_value};

let policy: PackagePolicy = from_value(json!({
    "id": "integration-a", "name": "system-1", "namespace": "default",
    "revision": 2, "version": "opaque-token", "policy_ids": ["policy-a"],
    "package": {"name": "system", "version": "2.24.0"},
    "inputs": [{"type": "logfile", "enabled": true, "streams": [],
                "compiled_input": {"type": "logfile"}}]
}))?;
let body = to_value(policy.edit().name("SOC system"))?;
assert_eq!(body["version"], "opaque-token");
assert_eq!(body["policy_ids"], json!(["policy-a"]));
assert_eq!(body["inputs"][0]["enabled"], true);
assert!(body["inputs"][0].get("compiled_input").is_none());
assert!(body.get("id").is_none()); // The edit binds the URL's ID instead.

Trait Implementations§

Source§

impl Clone for PackagePolicy

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PackagePolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PackagePolicy

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for PackagePolicy

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more