Skip to main content

FlowFileQueues

nifi_rust_client::v2_9_0::api::flowfilequeues

Struct FlowFileQueues 

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

Implementations§

Source§

impl<'a> FlowFileQueues<'a>

Source

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

Creates a request to drop the contents of the queue in this connection.

Calls POST /nifi-api/flowfile-queues/{id}/drop-requests.

§Parameters
  • id: The connection id.
§Returns
  • 202: The request has been accepted. A HTTP response header will contain the URI where the response can be polled.
§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 Source Data - /data/{component-type}/{uuid}.

Source

pub async fn remove_drop_request( &self, id: &str, drop_request_id: &str, ) -> Result<DropRequestDto, NifiError>

Cancels and/or removes a request to drop the contents of this connection.

Calls DELETE /nifi-api/flowfile-queues/{id}/drop-requests/{drop-request-id}.

§Parameters
  • id: The connection id.
  • drop_request_id: The drop request id.
§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 Source Data - /data/{component-type}/{uuid}.

Source

pub async fn get_drop_request( &self, id: &str, drop_request_id: &str, ) -> Result<DropRequestDto, NifiError>

Gets the current status of a drop request for the specified connection.

Calls GET /nifi-api/flowfile-queues/{id}/drop-requests/{drop-request-id}.

§Parameters
  • id: The connection id.
  • drop_request_id: The drop request id.
§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 Source Data - /data/{component-type}/{uuid}.

Source

pub async fn get_flow_file( &self, id: &str, flowfile_uuid: &str, cluster_node_id: Option<&str>, ) -> Result<FlowFileDto, NifiError>

Gets a FlowFile from a Connection.

Calls GET /nifi-api/flowfile-queues/{id}/flowfiles/{flowfile-uuid}.

§Parameters
  • id: The connection id.
  • flowfile_uuid: The flowfile uuid.
  • cluster_node_id: The id of the node where the content exists if clustered.
§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 Source Data - /data/{component-type}/{uuid}.

Source

pub async fn download_flow_file_content( &self, id: &str, flowfile_uuid: &str, client_id: Option<&str>, cluster_node_id: Option<&str>, range: Option<&str>, ) -> Result<Vec<u8>, NifiError>

Gets the content for a FlowFile in a Connection.

Calls GET /nifi-api/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content.

§Parameters
  • id: The connection id.
  • flowfile_uuid: The flowfile uuid.
  • client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • cluster_node_id: The id of the node where the content exists if clustered.
§Returns
  • 206: Partial Content with range of bytes requested
§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.
  • 416: Requested Range Not Satisfiable based on bytes requested
§Permissions

Requires Read Source Data - /data/{component-type}/{uuid}.

Source

pub async fn download_flow_file_content_stream( &self, id: &str, flowfile_uuid: &str, client_id: Option<&str>, cluster_node_id: Option<&str>, range: Option<&str>, ) -> Result<BytesStream, NifiError>

Streaming variant: yields body chunks as they arrive instead of buffering the whole response.

Gets the content for a FlowFile in a Connection.

Calls GET /nifi-api/flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content.

§Parameters
  • id: The connection id.
  • flowfile_uuid: The flowfile uuid.
  • client_id: If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • cluster_node_id: The id of the node where the content exists if clustered.
§Returns
  • 206: Partial Content with range of bytes requested
§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.
  • 416: Requested Range Not Satisfiable based on bytes requested
§Permissions

Requires Read Source Data - /data/{component-type}/{uuid}.

Source

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

Lists the contents of the queue in this connection.

Calls POST /nifi-api/flowfile-queues/{id}/listing-requests.

§Parameters
  • id: The connection id.
§Returns
  • 202: The request has been accepted. A HTTP response header will contain the URI where the response can be polled.
§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 Source Data - /data/{component-type}/{uuid}.

Source

pub async fn delete_listing_request( &self, id: &str, listing_request_id: &str, ) -> Result<ListingRequestDto, NifiError>

Cancels and/or removes a request to list the contents of this connection.

Calls DELETE /nifi-api/flowfile-queues/{id}/listing-requests/{listing-request-id}.

§Parameters
  • id: The connection id.
  • listing_request_id: The listing request id.
§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 Source Data - /data/{component-type}/{uuid}.

Source

pub async fn get_listing_request( &self, id: &str, listing_request_id: &str, ) -> Result<ListingRequestDto, NifiError>

Gets the current status of a listing request for the specified connection.

Calls GET /nifi-api/flowfile-queues/{id}/listing-requests/{listing-request-id}.

§Parameters
  • id: The connection id.
  • listing_request_id: The listing request id.
§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 Source Data - /data/{component-type}/{uuid}.

Auto Trait Implementations§

§

impl<'a> Freeze for FlowFileQueues<'a>

§

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

§

impl<'a> Send for FlowFileQueues<'a>

§

impl<'a> Sync for FlowFileQueues<'a>

§

impl<'a> Unpin for FlowFileQueues<'a>

§

impl<'a> UnsafeUnpin for FlowFileQueues<'a>

§

impl<'a> !UnwindSafe for FlowFileQueues<'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