DpgListFlowFileNamesCommand Object


Description:

Command to give a list of all installed flow file names.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

DpgListFlowFileNamesCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
Filter

An SQL WHERE specification for filtering the list of flow files.

Type: string

Default: "" (empty string)

UpdateDatabase

Force the updating of the database with any new flows which may have been added manually.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Force the update.

FALSE

Only update when significant changes are detected.

DpgListFlowFileNamesCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
FlowFileNameList

A returned list of the flow file names.

Type: string

Default: "" (empty string)

FlowTypeList

A returned list of flow file types, corresponding to the file names retrieved above.

Type: enum

Default: Stream

Possible Values:

Value Description
STREAM

File is stream type.

ATTACK

File is attack type.