org.apache.nifi.flowfile.attributes

Enum FragmentAttributes

java.lang.Object

java.lang.Enum<FragmentAttributes>

org.apache.nifi.flowfile.attributes.FragmentAttributes

All Implemented Interfaces:

Serializable, Comparable<FragmentAttributes>, FlowFileAttributeKey

public enum FragmentAttributes
extends Enum<FragmentAttributes>
implements FlowFileAttributeKey

This enum class contains flow file attribute keys commonly used among Split processors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FRAGMENT_COUNT The number of split FlowFiles generated from the parent FlowFile.
FRAGMENT_ID All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute.
FRAGMENT_INDEX A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile.
FRAGMENT_SIZE The number of bytes from the original FlowFile that were copied to this FlowFile, including header, if applicable, which is duplicated in each split FlowFile.
SEGMENT_ORIGINAL_FILENAME The filename of the parent FlowFile.

Field Summary

Fields

Modifier and Type	Field and Description
private String	key

Method Summary

Modifier and Type	Method and Description
static FlowFile	copyAttributesToOriginal(ProcessSession processSession, FlowFile originalFlowFile, String fragmentId, int fragmentCount)
String	key()
static FragmentAttributes	valueOf(String name) Returns the enum constant of this type with the specified name.
static FragmentAttributes[]	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

FRAGMENT_SIZE

public static final FragmentAttributes FRAGMENT_SIZE

The number of bytes from the original FlowFile that were copied to this FlowFile, including header, if applicable, which is duplicated in each split FlowFile.

FRAGMENT_ID

public static final FragmentAttributes FRAGMENT_ID

All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute.

FRAGMENT_INDEX

public static final FragmentAttributes FRAGMENT_INDEX

A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile.

FRAGMENT_COUNT

public static final FragmentAttributes FRAGMENT_COUNT

The number of split FlowFiles generated from the parent FlowFile.

SEGMENT_ORIGINAL_FILENAME

public static final FragmentAttributes SEGMENT_ORIGINAL_FILENAME

The filename of the parent FlowFile.

Field Detail

key

private final String key

Method Detail

values

public static FragmentAttributes[] 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 (FragmentAttributes c : FragmentAttributes.values())
    System.out.println(c);

Returns:

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

valueOf

public static FragmentAttributes 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

key

public String key()

Specified by:

key in interface FlowFileAttributeKey

copyAttributesToOriginal

public static FlowFile copyAttributesToOriginal(ProcessSession processSession,
                                                FlowFile originalFlowFile,
                                                String fragmentId,
                                                int fragmentCount)