org.apache.nifi.processors.standard

Class GenerateRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.GenerateRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @Tags(value={"test","random","generate","fake"})
 @InputRequirement(value=INPUT_FORBIDDEN)
 @WritesAttribute(attribute="mime.type",description="Sets the mime.type attribute to the MIME Type specified by the Record Writer") @WritesAttribute(attribute="record.count",description="The number of records in the FlowFile")
 @CapabilityDescription(value="This processor creates FlowFiles with records having random value for the specified fields. GenerateRecord is useful for testing, configuration, and simulation. It uses either user-defined properties to define a record schema or a provided schema and generates the specified number of records using random data for the fields in the schema.")
 @DynamicProperties(value=@DynamicProperty(name="Field name in generated record",value="Faker category for generated record values",description="Custom properties define the generated record schema using configured field names and value data types in absence of the Schema Text property"))
public class GenerateRecord
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private com.github.javafaker.Faker	faker
private static AllowableValue[]	fakerDatatypeValues
private static String	KEY1
private static String	KEY2
private static String	KEY3
private static String	KEY4
(package private) static PropertyDescriptor	NULL_PERCENTAGE
(package private) static PropertyDescriptor	NULLABLE_FIELDS
(package private) static PropertyDescriptor	NUM_RECORDS
(package private) static PropertyDescriptor	RECORD_WRITER
(package private) static Relationship	REL_SUCCESS
(package private) static Set<Relationship>	RELATIONSHIPS
(package private) static PropertyDescriptor	SCHEMA_TEXT

Constructor Summary

Constructors

Constructor and Description
GenerateRecord()

Method Summary

Modifier and Type	Method and Description
private String	generateRandomString()
protected RecordSchema	generateRecordSchema(Map<String,String> fields, boolean nullable)
private Object	generateValueFromRecordField(RecordField recordField, com.github.javafaker.Faker faker, int nullPercentage)
protected Map<String,String>	getFields(ProcessContext context)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)

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

customValidate, 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

fakerDatatypeValues

private static final AllowableValue[] fakerDatatypeValues

KEY1

private static final String KEY1

See Also:

Constant Field Values

KEY2

private static final String KEY2

See Also:

Constant Field Values

KEY3

private static final String KEY3

See Also:

Constant Field Values

KEY4

private static final String KEY4

See Also:

Constant Field Values

RECORD_WRITER

static final PropertyDescriptor RECORD_WRITER

NUM_RECORDS

static final PropertyDescriptor NUM_RECORDS

NULLABLE_FIELDS

static final PropertyDescriptor NULLABLE_FIELDS

NULL_PERCENTAGE

static final PropertyDescriptor NULL_PERCENTAGE

SCHEMA_TEXT

static final PropertyDescriptor SCHEMA_TEXT

REL_SUCCESS

static final Relationship REL_SUCCESS

RELATIONSHIPS

static final Set<Relationship> RELATIONSHIPS

faker

private volatile com.github.javafaker.Faker faker

Constructor Detail

GenerateRecord

public GenerateRecord()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getFields

protected Map<String,String> getFields(ProcessContext context)

generateValueFromRecordField

private Object generateValueFromRecordField(RecordField recordField,
                                            com.github.javafaker.Faker faker,
                                            int nullPercentage)

generateRandomString

private String generateRandomString()

generateRecordSchema

protected RecordSchema generateRecordSchema(Map<String,String> fields,
                                            boolean nullable)