org.apache.nifi.remote

Interface TransactionCompletion

All Known Implementing Classes:

ClientTransactionCompletion

public interface TransactionCompletion

A TransactionCompletion provides information about a Transaction that has completed successfully.

Method Summary

Modifier and Type	Method and Description
long	getBytesTransferred()
int	getDataPacketsTransferred()
long	getDuration(java.util.concurrent.TimeUnit timeUnit)
boolean	isBackoff() When a sending to a NiFi instance, the server may accept the content sent to it but indicate that its queues are full and that the client should backoff sending data for a bit.

Method Detail

isBackoff

boolean isBackoff()

When a sending to a NiFi instance, the server may accept the content sent to it but indicate that its queues are full and that the client should backoff sending data for a bit.

Returns:

true if the server did in fact request that, false otherwise

getDataPacketsTransferred

int getDataPacketsTransferred()

Returns:

the number of Data Packets that were sent to or received from the remote NiFi instance in the Transaction

getBytesTransferred

long getBytesTransferred()

Returns:

the number of bytes of DataPacket content that were sent to or received from the remote NiFI instance in the Transaction. Note that this is different than the number of bytes actually transferred between the client and server, as it does not take into account the attributes or protocol-specific information that is exchanged but rather takes into account only the data in the InputStream of the DataPacket

getDuration

long getDuration(java.util.concurrent.TimeUnit timeUnit)

Parameters:

timeUnit - unit of time for which to report the duration

Returns:

the amount of time that the Transaction took, from the time that the Transaction was created to the time that the Transaction was completed