Skip to main content

FlowStatusApi

nifi_rust_client::v2_7_2::api::flow

Struct FlowStatusApi 

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

Implementations§

Source§

impl<'a> FlowStatusApi<'a>

Source

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

Gets status for a connection

Calls GET /nifi-api/flow/connections/{id}/status.

§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.
  • 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 Read - /flow.

Source

pub async fn get_connection_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets the status history for a connection

Calls GET /nifi-api/flow/connections/{id}/status/history.

§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 Read - /flow.

Source

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

Gets status for an input port

Calls GET /nifi-api/flow/input-ports/{id}/status.

§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.
  • 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 Read - /flow.

Source

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

Gets status for an output port

Calls GET /nifi-api/flow/output-ports/{id}/status.

§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.
  • 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 Read - /flow.

Source

pub async fn get_process_group_status( &self, recursive: Option<bool>, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ProcessGroupStatusEntity, NifiError>

Gets the status for a process group

The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.

Calls GET /nifi-api/flow/process-groups/{id}/status.

§Parameters
  • recursive: Whether all descendant groups and the status of their content will be included. Optional, defaults to false
  • 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.
  • 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 Read - /flow.

Source

pub async fn get_process_group_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets status history for a remote process group

Calls GET /nifi-api/flow/process-groups/{id}/status/history.

§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 Read - /flow.

Source

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

Gets status for a processor

Calls GET /nifi-api/flow/processors/{id}/status.

§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.
  • 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 Read - /flow.

Source

pub async fn get_processor_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets status history for a processor

Calls GET /nifi-api/flow/processors/{id}/status/history.

§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 Read - /flow.

Source

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

Gets status for a remote process group

Calls GET /nifi-api/flow/remote-process-groups/{id}/status.

§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.
  • 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 Read - /flow.

Source

pub async fn get_remote_process_group_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets the status history

Calls GET /nifi-api/flow/remote-process-groups/{id}/status/history.

§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 Read - /flow.

Trait Implementations§

Source§

impl FlowStatusApi for FlowStatusApi<'_>

Source§

async fn get_connection_status( &self, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ConnectionStatusEntity, NifiError>

Gets status for a connection
Source§

async fn get_connection_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets the status history for a connection
Source§

async fn get_input_port_status( &self, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<PortStatusEntity, NifiError>

Gets status for an input port
Source§

async fn get_output_port_status( &self, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<PortStatusEntity, NifiError>

Gets status for an output port
Source§

async fn get_process_group_status( &self, recursive: Option<bool>, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ProcessGroupStatusEntity, NifiError>

Gets the status for a process group
Source§

async fn get_process_group_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets status history for a remote process group
Source§

async fn get_processor_status( &self, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ProcessorStatusEntity, NifiError>

Gets status for a processor
Source§

async fn get_processor_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets status history for a processor
Source§

async fn get_remote_process_group_status( &self, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<RemoteProcessGroupStatusEntity, NifiError>

Gets status for a remote process group
Source§

async fn get_remote_process_group_status_history( &self, ) -> Result<StatusHistoryEntity, NifiError>

Gets the status history

Auto Trait Implementations§

§

impl<'a> Freeze for FlowStatusApi<'a>

§

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

§

impl<'a> Send for FlowStatusApi<'a>

§

impl<'a> Sync for FlowStatusApi<'a>

§

impl<'a> Unpin for FlowStatusApi<'a>

§

impl<'a> UnsafeUnpin for FlowStatusApi<'a>

§

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

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

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
Source§

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
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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