Class FluxShellSpout
java.lang.Object
org.apache.storm.spout.ShellSpout
org.apache.storm.flux.wrappers.spouts.FluxShellSpout
- All Implemented Interfaces:
- Serializable,- ISpout,- IComponent,- IRichSpout
A generic `ShellSpout` implementation that allows you specify output fields
 and even streams without having to subclass `ShellSpout` to do so.
- See Also:
- 
Field SummaryFields inherited from class org.apache.storm.spout.ShellSpoutLOG
- 
Constructor SummaryConstructorsConstructorDescriptionFluxShellSpout(String[] command) Create a ShellSpout with command line arguments.FluxShellSpout(String[] args, String[] outputFields) Create a ShellSpout with command line arguments and output fields
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddComponentConfig(String key, Object value) Add configuration for this spout.voidaddComponentConfig(String key, List<Object> values) Add configuration for this spout.voiddeclareOutputFields(OutputFieldsDeclarer declarer) Declare the output schema for all the streams of this topology.Declare configuration specific to this component.voidsetDefaultStream(String[] outputFields) Set default stream outputFields, this method is called from YAML file:voidsetNamedStream(String name, String[] outputFields) Set custom *named* stream outputFields, this method is called from YAML file:Methods inherited from class org.apache.storm.spout.ShellSpoutack, activate, changeChildCWD, close, deactivate, fail, nextTuple, open, setEnv, shouldChangeChildCWD
- 
Constructor Details- 
FluxShellSpoutCreate a ShellSpout with command line arguments.- Parameters:
- command- Command line arguments for the bolt
 
- 
FluxShellSpoutCreate a ShellSpout with command line arguments and output fields Keep this constructor for backward compatibility.- Parameters:
- args- Command line arguments for the spout
- outputFields- Names of fields the spout will emit.
 
 
- 
- 
Method Details- 
addComponentConfigAdd configuration for this spout. This method is called from YAML file: ``` className: "org.apache.storm.flux.wrappers.bolts.FluxShellSpout" constructorArgs: # command line - ["python3", "splitsentence.py"] # output fields - ["word"] configMethods: - name: "addComponentConfig" args: ["publisher.data_paths", "actions"] ```- Parameters:
- key- config key
- value- config value
 
- 
addComponentConfigAdd configuration for this spout. This method is called from YAML file: ``` className: "org.apache.storm.flux.wrappers.bolts.FluxShellSpout" constructorArgs: # command line - ["python3", "splitsentence.py"] # output fields - ["word"] configMethods: - name: "addComponentConfig" args: - "publisher.data_paths" - ["actions"] ```- Parameters:
- key- config key
- values- config values
 
- 
setDefaultStreamSet default stream outputFields, this method is called from YAML file: ``` spouts: - className: org.apache.storm.flux.wrappers.bolts.FluxShellSpout id: my_spout constructorArgs: - [python3, my_spout.py] configMethods: - name: setDefaultStream args: - [word, count] ```- Parameters:
- outputFields- Names of fields the spout will emit (if any) in default stream.
 
- 
setNamedStreamSet custom *named* stream outputFields, this method is called from YAML file: ``` spouts: - className: org.apache.storm.flux.wrappers.bolts.FluxShellSpout id: my_spout constructorArgs: - [python3, my_spout.py] configMethods: - name: setNamedStream args: - first - [word, count] ```- Parameters:
- name- Name of stream the spout will emit into.
- outputFields- Names of fields the spout will emit in custom *named* stream.
 
- 
declareOutputFieldsDescription copied from interface:IComponentDeclare the output schema for all the streams of this topology.- Specified by:
- declareOutputFieldsin interface- IComponent
- Parameters:
- declarer- this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream
 
- 
getComponentConfigurationDescription copied from interface:IComponentDeclare configuration specific to this component. Only a subset of the "topology.*" configs can be overridden. The component configuration can be further overridden when constructing the topology usingTopologyBuilder- Specified by:
- getComponentConfigurationin interface- IComponent
 
 
-