Struct fe2o3_amqp_management::operations::node::QueryRequest

pub struct QueryRequest<'a> {
    pub entity_type: Option<Cow<'a, str>>,
    pub offset: Option<u32>,
    pub count: Option<u32>,
    pub attribute_names: Vec<Cow<'a, str>>,
    pub type: Cow<'a, str>,
    pub locales: Option<Cow<'a, str>>,
}

Retrieve selected attributes of Manageable Entities that can be read at this Management Node.

Since the query operation could potentially return a large number of results, this operation supports pagination through which a request can specify a subset of the results to be returned.

A result set of size N can be considered to containing elements numbered from 0 to N-1. The elements of the result set returned in a particular request are controlled by specifying offset and count values. By setting an offset of M then only the elements numbered from M onwards will be returned. If M is greater than the number of elements in the result set then no elements will be returned. By additionally setting a count of C, only the elements numbered from M to Min(M+C-1, N-1) will be returned. Pagination is achieved via two application-properties, offset and count.

If pagination is used then it cannot be guaranteed that the result set remains consistent between requests for successive pages. That is, the set of entities matching the query may have changed between requests. However, stable order MUST be provided, that is, for any two queries for the same parameters (except those related to pagination) then the results MUST be provided in the same order. Thus, if there are no changes to the set of entities that match the query then consistency MUST be maintained between requests for successive pages.

Fields

entity_type: Option<Cow<'a, str>>

If set, restricts the set of Manageable Entities requested to those that extend (directly or indirectly) the given Manageable Entity Type.

offset: Option<u32>

If set, specifies the number of the first element of the result set to be returned. If not provided, a default of 0 MUST be assumed.

count: Option<u32>

If set, specifies the number of entries from the result set to return. If not provided, all results from ‘offset’ onwards MUST be returned.

attribute_names: Vec<Cow<'a, str>>

The body of the message MUST consist of an amqp-value section containing a map which MUST have the following entries, where all keys MUST be of type string:

A list of strings representing the names of the attributes of the Manageable Entities being requested. The list MUST NOT contain duplicate elements. If the list contains no elements then this indicates that all attributes are being requested.

type: Cow<'a, str>

Entity type

locales: Option<Cow<'a, str>>

locales

Implementations

impl<'a> QueryRequest<'a>

pub fn new( entity_type: impl Into<Option<Cow<'a, str>>>, offset: impl Into<Option<u32>>, count: impl Into<Option<u32>>, attribute_names: impl IntoIterator<Item = impl Into<Cow<'a, str>>>, type: impl Into<Cow<'a, str>>, locales: impl Into<Option<Cow<'a, str>>> ) -> Self

Create a new Query request

Trait Implementations

impl<'a> Clone for QueryRequest<'a>

fn clone(&self) -> QueryRequest<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for QueryRequest<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for QueryRequest<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for QueryRequest<'a>

fn cmp(&self, other: &QueryRequest<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for QueryRequest<'a>

fn eq(&self, other: &QueryRequest<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for QueryRequest<'a>

fn partial_cmp(&self, other: &QueryRequest<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Request for QueryRequest<'a>

const OPERATION: &'static str = QUERY

Management operation

type Response = QueryResponse

The response type for this request.

type Body = OrderedMap<String, Vec<String>>

The body type for this request.

fn manageable_entity_type(&mut self) -> Option<String>

Set the manageable entity type.

fn locales(&mut self) -> Option<String>

Set the locales for this request.

fn encode_application_properties(&mut self) -> Option<ApplicationProperties>

Encode the ApplicationProperties section of the message.

fn encode_body(self) -> Self::Body

Encode the body of the message.

fn encode_header(&mut self) -> Option<Header>

Encode the Header section of the message.

fn encode_delivery_annotations(&mut self) -> Option<DeliveryAnnotations>

Encode the DeliveryAnnotations section of the message.

fn encode_message_annotations(&mut self) -> Option<MessageAnnotations>

Encode the MessageAnnotations section of the message.

fn encode_properties(&mut self) -> Option<Properties>

Encode the Properties section of the message.

fn encode_footer(&mut self) -> Option<Footer>

Encode the Footer section of the message.

fn into_message(self) -> Message<Self::Body>

Encode this request into a message.

impl<'a> Eq for QueryRequest<'a>

impl<'a> StructuralPartialEq for QueryRequest<'a>