Skip to main content

DataTransfer

nifi_rust_client::dynamic::api::datatransfer

Struct DataTransfer 

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

Implementations§

Source§

impl<'a> DataTransfer<'a>

Source

pub async fn transfer_flow_files( &self, port_id: &str, transaction_id: &str, ) -> Result<Vec<u8>, NifiError>

Transfer FlowFiles from the output port

Calls GET /nifi-api/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files.

§Parameters
  • port_id: The output port id.
  • transaction_id: The transaction id.
§Returns
  • 200: There is no flow file to return.
§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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/output-ports/{uuid}.

Source

pub async fn transfer_flow_files_stream( &self, port_id: &str, transaction_id: &str, ) -> Result<BytesStream, NifiError>

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

Transfer FlowFiles from the output port

Calls GET /nifi-api/data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files.

§Parameters
  • port_id: The output port id.
  • transaction_id: The transaction id.
§Returns
  • 200: There is no flow file to return.
§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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/output-ports/{uuid}.

Source

pub async fn receive_flow_files( &self, port_id: &str, transaction_id: &str, data: Vec<u8>, ) -> Result<String, NifiError>

Transfer FlowFiles to the input port

Calls POST /nifi-api/data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files.

§Parameters
  • port_id: The input port id.
  • transaction_id: The transaction 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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/input-ports/{uuid}.

Source

pub async fn create_port_transaction( &self, port_type: &str, port_id: &str, ) -> Result<TransactionResultEntity, NifiError>

Create a transaction to the specified output port or input port

Calls POST /nifi-api/data-transfer/{portType}/{portId}/transactions.

§Parameters
  • port_type: The port type.
  • port_id: The input or output port 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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/{component-type}/{uuid}.

Source

pub async fn extend_input_port_transaction_t_t_l( &self, port_id: &str, transaction_id: &str, ) -> Result<TransactionResultEntity, NifiError>

Extend transaction TTL

Calls PUT /nifi-api/data-transfer/input-ports/{portId}/transactions/{transactionId}.

§Parameters
  • port_id: The input port id.
  • transaction_id: The transaction 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 - /data-transfer/input-ports/{uuid}.

Source

pub async fn extend_output_port_transaction_t_t_l( &self, port_id: &str, transaction_id: &str, ) -> Result<TransactionResultEntity, NifiError>

Extend transaction TTL

Calls PUT /nifi-api/data-transfer/output-ports/{portId}/transactions/{transactionId}.

§Parameters
  • port_id: The output port id.
  • transaction_id: The transaction 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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/output-ports/{uuid}.

Source

pub async fn commit_input_port_transaction( &self, port_id: &str, transaction_id: &str, response_code: i32, data: Vec<u8>, ) -> Result<TransactionResultEntity, NifiError>

Commit or cancel the specified transaction

Calls DELETE /nifi-api/data-transfer/input-ports/{portId}/transactions/{transactionId}.

§Parameters
  • port_id: The input port id.
  • transaction_id: The transaction id.
  • response_code: The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
§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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/input-ports/{uuid}.

Source

pub async fn commit_output_port_transaction( &self, port_id: &str, transaction_id: &str, response_code: i32, checksum: &str, data: Vec<u8>, ) -> Result<TransactionResultEntity, NifiError>

Commit or cancel the specified transaction

Calls DELETE /nifi-api/data-transfer/output-ports/{portId}/transactions/{transactionId}.

§Parameters
  • port_id: The output port id.
  • transaction_id: The transaction id.
  • response_code: The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
  • checksum: A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.
§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.
  • 503: NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful
§Permissions

Requires Write - /data-transfer/output-ports/{uuid}.

Auto Trait Implementations§

§

impl<'a> Freeze for DataTransfer<'a>

§

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

§

impl<'a> Send for DataTransfer<'a>

§

impl<'a> Sync for DataTransfer<'a>

§

impl<'a> Unpin for DataTransfer<'a>

§

impl<'a> UnsafeUnpin for DataTransfer<'a>

§

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