Skip to main content

TasksFilter

Struct TasksFilter 

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

Which runs a cancel_matching or replay_matching call acts on.

Every condition set here has to hold. An empty condition is not a condition: a filter with no statuses matches runs in any state, and a filter with no since matches runs of any age.

A filter with no narrowing criterion at all — no statuses, no workflow ids, no metadata — is refused with Error::InvalidArgument before any call is made. since and until alone do not count as narrowing: left on their own they still let the filter match every run of the whole tenant that started in the window, which for an old since (or none at all) is effectively everything. Requiring at least one of statuses, workflow_ids or additional_metadata is this SDK’s own rule, not the engine’s — the plain shape is dangerous enough (see the warning on RunsClient::cancel_matching) that a call which cannot possibly narrow anything is refused rather than sent.

use std::time::{Duration, SystemTime};
use hatchet_client::{RunStatus, TasksFilter};

let last_hour = SystemTime::now() - Duration::from_secs(3600);
let filter = TasksFilter::new()
    .since(last_hour)
    .statuses([RunStatus::Queued])
    .additional_metadata([("customer", "acme")]);

Implementations§

Source§

impl TasksFilter

Source

pub fn new() -> Self

An empty filter: add at least one of statuses, workflow_ids or additional_metadata before using it — see the type’s docs.

Source

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

Also: runs that started at or after at. Omitted, runs of any age match.

Source

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

Also: runs that started at or before at.

Source

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

Also: runs in one of these states. Setting it twice replaces it.

Source

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

Also: runs of these workflows. These are workflow definition ids (what PutWorkflow answers with), not run ids.

Source

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

Also: runs triggered with all of these metadata pairs — the ones a RunOpts::metadata call set. Setting the same key twice keeps the last value.

Trait Implementations§

Source§

impl Clone for TasksFilter

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 TasksFilter

Source§

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

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

impl Default for TasksFilter

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> 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<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