Struct mlmd::requests::GetEventsRequest

source · [−]

pub struct GetEventsRequest<'a> { /* private fields */ }

Expand description

Request builder for MetadataStore::get_events.

Implementations

source

impl<'a> GetEventsRequest<'a>

source

pub fn execution(self, id: ExecutionId) -> Self

Specifies the execution related to the target event.

If you need to specify multiple executions, please use executions instead.

source

pub fn executions(self, ids: impl Iterator<Item = ExecutionId>) -> Self

Specifies the executions related to the target events.

source

pub fn artifact(self, id: ArtifactId) -> Self

Specifies the artifact related to the target event.

If you need to specify multiple artifacts, please use artifacts instead.

source

pub fn artifacts(self, ids: impl Iterator<Item = ArtifactId>) -> Self

Specifies the artifacts related to the target events.

source

pub fn limit(self, n: usize) -> Self

Specifies the maximum number of the returned events.

source

pub fn offset(self, n: usize) -> Self

Specifies how many leading events are skipped from the result.

Note that if GetEventsRequest::limit is not specified, this option has no effect.

source

pub fn order_by(self, field: EventOrderByField, asc: bool) -> Self

Specifies how to order the result.

source

pub async fn execute(self) -> Result<Vec<Event>, GetError>

Gets specified events.

If multiple conditions are specified, those which satisfy all the conditions are returned.

source

pub async fn count(self) -> Result<usize, GetError>

Returns the number of events that satisfy the specified conditions.

This is equivalent to calling self.execute().await?.len() but more efficient.

Trait Implementations

source

impl<'a> Debug for GetEventsRequest<'a>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

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

impl<'a> Send for GetEventsRequest<'a>

impl<'a> !Sync for GetEventsRequest<'a>

impl<'a> Unpin for GetEventsRequest<'a>

impl<'a> !UnwindSafe for GetEventsRequest<'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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct mlmd::requests::GetEventsRequest

Implementations

impl<'a> GetEventsRequest<'a>

pub fn execution(self, id: ExecutionId) -> Self

pub fn executions(self, ids: impl Iterator<Item = ExecutionId>) -> Self

pub fn artifact(self, id: ArtifactId) -> Self

pub fn artifacts(self, ids: impl Iterator<Item = ArtifactId>) -> Self

pub fn limit(self, n: usize) -> Self

pub fn offset(self, n: usize) -> Self

pub fn order_by(self, field: EventOrderByField, asc: bool) -> Self

pub async fn execute(self) -> Result<Vec<Event>, GetError>

pub async fn count(self) -> Result<usize, GetError>

Trait Implementations

impl<'a> Debug for GetEventsRequest<'a>

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

Auto Trait Implementations

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

impl<'a> Send for GetEventsRequest<'a>

impl<'a> !Sync for GetEventsRequest<'a>

impl<'a> Unpin for GetEventsRequest<'a>

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

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

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

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

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,