Struct QueryObjectsInput

#[non_exhaustive]
pub struct QueryObjectsInput {
    pub pipeline_id: Option<String>,
    pub query: Option<Query>,
    pub sphere: Option<String>,
    pub marker: Option<String>,
    pub limit: Option<i32>,
}

Contains the parameters for QueryObjects.

Fields (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.

pipeline_id: Option<String>

The ID of the pipeline.

query: Option<Query>

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

sphere: Option<String>

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

marker: Option<String>

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

limit: Option<i32>

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Implementations

impl QueryObjectsInput

pub fn pipeline_id(&self) -> Option<&str>

The ID of the pipeline.

pub fn query(&self) -> Option<&Query>

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

pub fn sphere(&self) -> Option<&str>

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

pub fn marker(&self) -> Option<&str>

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

pub fn limit(&self) -> Option<i32>

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

impl QueryObjectsInput

pub fn builder() -> QueryObjectsInputBuilder

Creates a new builder-style object to manufacture QueryObjectsInput.

Trait Implementations

impl Clone for QueryObjectsInput

fn clone(&self) -> QueryObjectsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryObjectsInput

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

Formats the value using the given formatter.

impl PartialEq for QueryObjectsInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for QueryObjectsInput