Skip to main content

RuleDeployment

Struct RuleDeployment 

Source
#[non_exhaustive]
pub struct RuleDeployment { pub name: String, pub enabled: bool, pub alerting: bool, pub archived: bool, pub archive_time: Option<Timestamp>, pub run_frequency: RunFrequency, pub execution_state: ExecutionState, pub producer_rules: Vec<String>, pub consumer_rules: Vec<String>, pub last_alert_status_change_time: Option<Timestamp>, /* private fields */ }
Expand description

The RuleDeployment resource represents the deployment state of a Rule.

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.
§name: String

Required. The resource name of the rule deployment. Note that RuleDeployment is a child of the overall Rule, not any individual revision, so the resource ID segment for the Rule resource must not reference a specific revision. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment

§enabled: bool

Whether the rule is currently deployed continuously against incoming data.

§alerting: bool

Whether detections resulting from this deployment should be considered alerts.

§archived: bool

The archive state of the rule deployment. Cannot be set to true unless enabled is set to false. If set to true, alerting will automatically be set to false. If currently set to true, enabled, alerting, and run_frequency cannot be updated.

§archive_time: Option<Timestamp>

Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment’s current archive state is not set to true, the field will be empty.

§run_frequency: RunFrequency

The run frequency of the rule deployment.

§execution_state: ExecutionState

Output only. The execution state of the rule deployment.

§producer_rules: Vec<String>

Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

§consumer_rules: Vec<String>

Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule’s ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

§last_alert_status_change_time: Option<Timestamp>

Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state. E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false.

Implementations§

Source§

impl RuleDeployment

Source

pub fn new() -> Self

Creates a new default instance.

Source

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

§Example
let x = RuleDeployment::new().set_name(format!("projects/{project_id}/locations/{location_id}/instances/{instance_id}/rules/{rule_id}/deployment"));
Source

pub fn set_enabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of enabled.

§Example
let x = RuleDeployment::new().set_enabled(true);
Source

pub fn set_alerting<T: Into<bool>>(self, v: T) -> Self

Sets the value of alerting.

§Example
let x = RuleDeployment::new().set_alerting(true);
Source

pub fn set_archived<T: Into<bool>>(self, v: T) -> Self

Sets the value of archived.

§Example
let x = RuleDeployment::new().set_archived(true);
Source

pub fn set_archive_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of archive_time.

§Example
use wkt::Timestamp;
let x = RuleDeployment::new().set_archive_time(Timestamp::default()/* use setters */);
Source

pub fn set_or_clear_archive_time<T>(self, v: Option<T>) -> Self
where T: Into<Timestamp>,

Sets or clears the value of archive_time.

§Example
use wkt::Timestamp;
let x = RuleDeployment::new().set_or_clear_archive_time(Some(Timestamp::default()/* use setters */));
let x = RuleDeployment::new().set_or_clear_archive_time(None::<Timestamp>);
Source

pub fn set_run_frequency<T: Into<RunFrequency>>(self, v: T) -> Self

Sets the value of run_frequency.

§Example
use google_cloud_chronicle_v1::model::RunFrequency;
let x0 = RuleDeployment::new().set_run_frequency(RunFrequency::Live);
let x1 = RuleDeployment::new().set_run_frequency(RunFrequency::Hourly);
let x2 = RuleDeployment::new().set_run_frequency(RunFrequency::Daily);
Source

pub fn set_execution_state<T: Into<ExecutionState>>(self, v: T) -> Self

Sets the value of execution_state.

§Example
use google_cloud_chronicle_v1::model::rule_deployment::ExecutionState;
let x0 = RuleDeployment::new().set_execution_state(ExecutionState::Default);
let x1 = RuleDeployment::new().set_execution_state(ExecutionState::Limited);
let x2 = RuleDeployment::new().set_execution_state(ExecutionState::Paused);
Source

pub fn set_producer_rules<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of producer_rules.

§Example
let x = RuleDeployment::new().set_producer_rules(["a", "b", "c"]);
Source

pub fn set_consumer_rules<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of consumer_rules.

§Example
let x = RuleDeployment::new().set_consumer_rules(["a", "b", "c"]);
Source

pub fn set_last_alert_status_change_time<T>(self, v: T) -> Self
where T: Into<Timestamp>,

Sets the value of last_alert_status_change_time.

§Example
use wkt::Timestamp;
let x = RuleDeployment::new().set_last_alert_status_change_time(Timestamp::default()/* use setters */);
Source

pub fn set_or_clear_last_alert_status_change_time<T>(self, v: Option<T>) -> Self
where T: Into<Timestamp>,

Sets or clears the value of last_alert_status_change_time.

§Example
use wkt::Timestamp;
let x = RuleDeployment::new().set_or_clear_last_alert_status_change_time(Some(Timestamp::default()/* use setters */));
let x = RuleDeployment::new().set_or_clear_last_alert_status_change_time(None::<Timestamp>);

Trait Implementations§

Source§

impl Clone for RuleDeployment

Source§

fn clone(&self) -> RuleDeployment

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 RuleDeployment

Source§

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

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

impl Default for RuleDeployment

Source§

fn default() -> RuleDeployment

Returns the “default value” for a type. Read more
Source§

impl Message for RuleDeployment

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for RuleDeployment

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RuleDeployment

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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