Struct mlmd::requests::GetArtifactsRequest

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

Request builder for MetadataStore::get_artifacts.

Implementations

impl<'a> GetArtifactsRequest<'a>

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

Specifies the type of the target artifacts.

pub fn type_and_name(self, type_name: &str, artifact_name: &str) -> Self

Specifies the type and name of the target artifact.

pub fn type_and_name_pattern(
    self,
    type_name: &str,
    artifact_name_pattern: &str
) -> Self

Specifies the type and name pattern of the target artifacts.

artifact_name_pattern can contain wildcard characters for the SQL LIKE statement.

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

Specifies the ID of the target artifact.

If you need to specify multiple IDs, please use ids instead.

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

Specifies the ID set of the target artifacts.

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

Specifies the URI of the target artifacts.

pub fn context(self, context_id: ContextId) -> Self

Specifies the context to which the target artifacts belong.

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

Specifies how to order the result.

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

Specifies the maximum number of the returned artifacts.

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

Specifies how many leading artifacts are skipped from the result.

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

pub fn create_time(self, range: impl RangeBounds<Duration>) -> Self

Specifies creation time range.

pub fn update_time(self, range: impl RangeBounds<Duration>) -> Self

Specifies update time range.

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

Gets specified artifacts.

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

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

Returns the number of artifacts that satisfy the specified conditions.

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

Trait Implementations

impl<'a> Debug for GetArtifactsRequest<'a>

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

Formats the value using the given formatter.