Skip to main content

Counters

nifi_rust_client::dynamic::api::counters

Struct Counters

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

Implementations§

impl<'a> Counters<'a>

pub async fn get_counters( &self, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<CountersDto, NifiError>

Gets the current counters for this NiFi

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/counters.

§Parameters

nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id: The id of the node where to get the status.

§Errors

400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401: Client could not be authenticated.
403: Client is not authorized to make this request.
409: The request was valid but NiFi was not in the appropriate state to process it.

§Permissions

Requires Read - /counters.

pub async fn update_all_counters(&self) -> Result<CountersDto, NifiError>

Updates all counters. This will reset all counter values to 0

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls PUT /nifi-api/counters.

§Errors

400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401: Client could not be authenticated.
403: Client is not authorized to make this request.
409: The request was valid but NiFi was not in the appropriate state to process it.

§Permissions

Requires Write - /counters.

pub async fn update_counter(&self, id: &str) -> Result<CounterDto, NifiError>

Updates the specified counter. This will reset the counter value to 0

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls PUT /nifi-api/counters/{id}.

§Parameters

id: The id of the counter.

§Errors

400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401: Client could not be authenticated.
403: Client is not authorized to make this request.
404: The specified resource could not be found.
409: The request was valid but NiFi was not in the appropriate state to process it.

§Permissions

Requires Write - /counters.

Auto Trait Implementations§

impl<'a> Freeze for Counters<'a>

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

impl<'a> Send for Counters<'a>

impl<'a> Sync for Counters<'a>

impl<'a> Unpin for Counters<'a>

impl<'a> UnsafeUnpin for Counters<'a>

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more