org.apache.nifi.processors.standard

Class RemoveRecordField

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AbstractRecordProcessor

org.apache.nifi.processors.standard.RemoveRecordField

All Implemented Interfaces:

ConfigurableComponent, Processor

@SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"update","record","generic","schema","json","csv","avro","freeform","text","remove","delete"})
 @CapabilityDescription(value="Modifies the contents of a FlowFile that contains Record-oriented data (i.e. data that can be read via a RecordReader and written by a RecordWriter) by removing selected fields. This Processor requires that at least one user-defined Property be added. The name of the property is ignored by the processor, but could be a meaningful identifier for the user. The value of the property should indicate a RecordPath that determines the field to be removed. The processor executes the removal in the order in which these properties are added to the processor. Set the \"Record Writer\" to \"Inherit Record Schema\" in order to use the updated Record Schema modified when removing Fields.")
 @WritesAttributes(value=@WritesAttribute(attribute="record.error.message",description="This attribute provides on failure the error message encountered by the Reader or Writer."))
 @DynamicProperty(name="(Ignored)",
                 value="A RecordPath to the field to be removed.",
                 description="Allows users to specify fields to remove that match the RecordPath.",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES)
 @SeeAlso(value=UpdateRecord.class)
public class RemoveRecordField
extends AbstractRecordProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private RecordPathCache	recordPathCache
private List<RecordFieldRemover.RecordPathRemovalProperties>	recordPathsToRemove
private static String	ROOT_PATH

Fields inherited from class org.apache.nifi.processors.standard.AbstractRecordProcessor

INCLUDE_ZERO_RECORD_FLOWFILES, RECORD_READER, RECORD_WRITER, REL_FAILURE, REL_SUCCESS

Constructor Summary

Constructors

Constructor and Description
RemoveRecordField()

Method Summary

Modifier and Type	Method and Description
void	collectRecordPaths(ProcessContext context)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected Record	process(Record record, FlowFile flowFile, ProcessContext context, long count)

Methods inherited from class org.apache.nifi.processors.standard.AbstractRecordProcessor

getRelationships, getSupportedPropertyDescriptors, onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

recordPathCache

private volatile RecordPathCache recordPathCache

recordPathsToRemove

private volatile List<RecordFieldRemover.RecordPathRemovalProperties> recordPathsToRemove

ROOT_PATH

private static final String ROOT_PATH

See Also:

Constant Field Values

Constructor Detail

RemoveRecordField

public RemoveRecordField()

Method Detail

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

collectRecordPaths

@OnScheduled
public void collectRecordPaths(ProcessContext context)

process

protected Record process(Record record,
                         FlowFile flowFile,
                         ProcessContext context,
                         long count)

Specified by:

process in class AbstractRecordProcessor