Skip to main content

PatchRule

Struct PatchRule 

Source
pub struct PatchRule<'a>(/* private fields */);
Expand description

PATCH /api/detection_engine/rules

Implementations§

Source§

impl<'a> PatchRule<'a>

Source

pub fn into_request(self) -> Request<'a>

Converts this builder to a raw request, preserving its configured route, scope, parameters, body, headers and timeout. Replacing the raw body does not reapply this builder’s identity, concurrency or typed-field checks. Existing construction errors remain errors and cannot be repaired through the raw request.

Source

pub fn header(self, name: HeaderName, value: HeaderValue) -> Self

Sets a header on this request only. It replaces every value of the same name from the transport defaults or the body.

Source

pub fn request_timeout(self, timeout: Duration) -> Self

Overrides the transport timeout for this request.

Source

pub async fn send(self) -> Result<Response<DetectionRule>>

Sends the request and checks its HTTP status. The successful body remains unread; consume it through Response. Construction errors are returned before HTTP. Requests are never retried.

Source§

impl PatchRule<'_>

Source

pub fn name(self, name: &str) -> Self

Source

pub fn description(self, description: &str) -> Self

Source

pub fn enabled(self, enabled: bool) -> Self

Source

pub fn query(self, query: &str) -> Self

Source

pub fn severity(self, severity: Severity) -> Self

Source

pub fn risk_score(self, score: RiskScore) -> Self

Source

pub fn tags<I: IntoIterator<Item = S>, S: Into<String>>(self, tags: I) -> Self

Source

pub fn exceptions_list(self, lists: Vec<ListReference>) -> Self

Replaces every list association. An empty vector detaches all lists.

Source

pub fn schedule(self, schedule: RuleSchedule) -> Self

Changes how often the rule runs and how far back each run searches.

Source

pub fn field(self, name: &str, value: impl Serialize) -> Self

Sets any other patchable rule field. The selectors id and rule_id, and risk_score, severity, interval and from, which have typed setters, fail with Error::InvalidRequest; use unchecked_field to send them anyway. Errors are returned by send, before HTTP, even if later setters replace the offending field.

use security_client_rs::{Error, Kibana, http::Transport, security::RuleSelector};

let client = Kibana::new(Transport::single_node("http://127.0.0.1:9")?);
let patch = client.security().patch_rule(RuleSelector::RuleId("failed-logins"));
let error = patch.field("rule_id", "another-rule").send().await.unwrap_err();
assert!(matches!(error, Error::InvalidRequest(_))); // No request is sent.
Source

pub fn unchecked_field(self, name: &str, value: impl Serialize) -> Self

Sets any field without checks, including one that replaces the selector and changes which rule is patched.

Trait Implementations§

Source§

impl<'a> Clone for PatchRule<'a>

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<'a> Debug for PatchRule<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !Freeze for PatchRule<'a>

§

impl<'a> !RefUnwindSafe for PatchRule<'a>

§

impl<'a> !UnwindSafe for PatchRule<'a>

§

impl<'a> Send for PatchRule<'a>

§

impl<'a> Sync for PatchRule<'a>

§

impl<'a> Unpin for PatchRule<'a>

§

impl<'a> UnsafeUnpin for PatchRule<'a>

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> 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