org.apache.nifi.provenance

Enum ProvenanceEventType

java.lang.Object

java.lang.Enum<ProvenanceEventType>

org.apache.nifi.provenance.ProvenanceEventType

All Implemented Interfaces:

Serializable, Comparable<ProvenanceEventType>

public enum ProvenanceEventType
extends Enum<ProvenanceEventType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDINFO Indicates a provenance event for adding additional information such as a new linkage to a new URI or UUID
ATTRIBUTES_MODIFIED ATTRIBUTES_MODIFIED is used to indicate that a FlowFile's attributes were modified in some way.
CLONE CLONE is used to indicate that a FlowFile is an exact duplicate of its parent FlowFile.
CONTENT_MODIFIED CONTENT_MODIFIED is used to indicate that a FlowFile's content was modified in some way.
CREATE A CREATE event is used when a FlowFile is generated from data that was not received from a remote system or external process
DOWNLOAD Indicates that the contents of a FlowFile were downloaded by a user or external entity.
DROP Indicates a provenance event for the conclusion of an object's life for some reason other than object expiration
EXPIRE Indicates a provenance event for the conclusion of an object's life due to the fact that the object could not be processed in a timely manner
FETCH Indicates that the contents of a FlowFile were overwritten using the contents of some external resource.
FORK FORK is used to indicate that one or more FlowFile was derived from a parent FlowFile.
JOIN JOIN is used to indicate that a single FlowFile is derived from joining together multiple parent FlowFiles.
RECEIVE Indicates a provenance event for receiving data from an external process.
REMOTE_INVOCATION Indicates a provenance event for sending remote invocation request to an external process.
REPLAY Indicates a provenance event for replaying a FlowFile.
ROUTE ROUTE is used to show that a FlowFile was routed to a specified Relationship and should provide information about why the FlowFile was routed to this relationship.
SEND Indicates a provenance event for sending data to an external process
UNKNOWN Indicates that the type of the provenance event is unknown because the user who is attempting to access the event is not authorize to know the type.

Method Summary

Modifier and Type	Method and Description
static ProvenanceEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProvenanceEventType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CREATE

public static final ProvenanceEventType CREATE

A CREATE event is used when a FlowFile is generated from data that was not received from a remote system or external process

RECEIVE

public static final ProvenanceEventType RECEIVE

Indicates a provenance event for receiving data from an external process. This Event Type is expected to be the first event for a FlowFile. As such, a Processor that receives data from an external source and uses that data to replace the content of an existing FlowFile should use the FETCH event type, rather than the RECEIVE event type.

FETCH

public static final ProvenanceEventType FETCH

Indicates that the contents of a FlowFile were overwritten using the contents of some external resource. This is similar to the RECEIVE event but varies in that RECEIVE events are intended to be used as the event that introduces the FlowFile into the system, whereas FETCH is used to indicate that the contents of an existing FlowFile were overwritten.

SEND

public static final ProvenanceEventType SEND

Indicates a provenance event for sending data to an external process

REMOTE_INVOCATION

public static final ProvenanceEventType REMOTE_INVOCATION

Indicates a provenance event for sending remote invocation request to an external process. This event type is used to represent other operations than transferring data (RECEIVE, FETCH or SEND), for example, deleting object from an external process or storage.

DOWNLOAD

public static final ProvenanceEventType DOWNLOAD

Indicates that the contents of a FlowFile were downloaded by a user or external entity.

DROP

public static final ProvenanceEventType DROP

Indicates a provenance event for the conclusion of an object's life for some reason other than object expiration

EXPIRE

public static final ProvenanceEventType EXPIRE

Indicates a provenance event for the conclusion of an object's life due to the fact that the object could not be processed in a timely manner

FORK

public static final ProvenanceEventType FORK

FORK is used to indicate that one or more FlowFile was derived from a parent FlowFile.

JOIN

public static final ProvenanceEventType JOIN

JOIN is used to indicate that a single FlowFile is derived from joining together multiple parent FlowFiles.

CLONE

public static final ProvenanceEventType CLONE

CLONE is used to indicate that a FlowFile is an exact duplicate of its parent FlowFile.

CONTENT_MODIFIED

public static final ProvenanceEventType CONTENT_MODIFIED

CONTENT_MODIFIED is used to indicate that a FlowFile's content was modified in some way. When using this Event Type, it is advisable to provide details about how the content is modified.

ATTRIBUTES_MODIFIED

public static final ProvenanceEventType ATTRIBUTES_MODIFIED

ATTRIBUTES_MODIFIED is used to indicate that a FlowFile's attributes were modified in some way. This event is not needed when another event is reported at the same time, as the other event will already contain all FlowFile attributes.

ROUTE

public static final ProvenanceEventType ROUTE

ROUTE is used to show that a FlowFile was routed to a specified Relationship and should provide information about why the FlowFile was routed to this relationship.

ADDINFO

public static final ProvenanceEventType ADDINFO

Indicates a provenance event for adding additional information such as a new linkage to a new URI or UUID

REPLAY

public static final ProvenanceEventType REPLAY

Indicates a provenance event for replaying a FlowFile. The UUID of the event will indicate the UUID of the original FlowFile that is being replayed. The event will contain exactly one Parent UUID that is also the UUID of the FlowFile that is being replayed and exactly one Child UUID that is the UUID of the a newly created FlowFile that will be re-queued for processing.

UNKNOWN

public static final ProvenanceEventType UNKNOWN

Indicates that the type of the provenance event is unknown because the user who is attempting to access the event is not authorize to know the type.

Method Detail

values

public static ProvenanceEventType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProvenanceEventType c : ProvenanceEventType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProvenanceEventType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null