Struct icinga2_api::api::query::monitoring_objects::host::ListHostsBuilder

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

Builder for ListHosts.

Implementations

impl<'a> ListHostsBuilder<'a>

pub fn joins<VALUE: Into<IcingaJoins<'a, IcingaHostJoinTypes>>>(
    &mut self,
    value: VALUE
) -> &mut Self

the joins (related objects) to return along with each result

pub fn meta<VALUE: Into<Vec<IcingaMetadataType>>>(
    &mut self,
    value: VALUE
) -> &mut Self

the metadata to return along with each result

pub fn filter<VALUE: Into<IcingaFilter>>(&mut self, value: VALUE) -> &mut Self

filter the results

pub fn build(&self) -> Result<ListHosts<'a>, Error>

Builds a new ListHosts.

Errors

If a required field has not been initialized.

impl<'a> ListHostsBuilder<'a>

pub fn validate(&self) -> Result<(), Error>

makes sure the filter object type is the correct one for the type of return values this endpoint returns

Errors

this returns an error if the filter field object type does not match the return type of the API call

Trait Implementations

impl<'a> Clone for ListHostsBuilder<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ListHostsBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ListHostsBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.