Skip to main content

TaskFilter

Struct TaskFilter 

Source
pub struct TaskFilter { /* private fields */ }
Expand description

The filter half of a RunSelector (V1TaskFilter). Every condition set here has to hold.

A filter that narrows nothing is refused. With no statuses, no workflow ids and no metadata, the filter matches every run of the tenant in its time window; RunsApi::cancel and RunsApi::replay return Error::InvalidArgument instead of sending it. since and until alone do not count as narrowing. This is the SDK’s rule, not the engine’s — the same one hatchet-client’s TasksFilter applies.

use std::time::{Duration, SystemTime};
use hatchet_rest::{TaskFilter, TaskStatus};

let filter = TaskFilter::new()
    .since(SystemTime::now() - Duration::from_secs(3600))
    .statuses([TaskStatus::Failed])
    .additional_metadata([("customer", "acme")]);

Implementations§

Source§

impl TaskFilter

Source

pub fn new() -> Self

A filter with no conditions yet. The API requires since; without since the filter is sent with 1970-01-01.

Source

pub fn since(self, since: SystemTime) -> Self

Runs created at or after since.

Source

pub fn until(self, until: SystemTime) -> Self

Runs created before until.

Source

pub fn statuses(self, statuses: impl IntoIterator<Item = TaskStatus>) -> Self

Only these statuses.

Source

pub fn workflow_ids( self, ids: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Only these workflows (by id).

Source

pub fn additional_metadata<K: AsRef<str>, V: AsRef<str>>( self, pairs: impl IntoIterator<Item = (K, V)>, ) -> Self

Only runs carrying these metadata pairs, sent as "key:value".

Trait Implementations§

Source§

impl Clone for TaskFilter

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 TaskFilter

Source§

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

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

impl Default for TaskFilter

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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