org.apache.nifi.controller

Interface Snippet

public interface Snippet

A Snippet represents a segment of the flow

Method Summary

Modifier and Type	Method and Description
Set<String>	getConnections()
Set<String>	getFunnels()
String	getId()
Set<String>	getInputPorts()
Set<String>	getLabels()
Set<String>	getOutputPorts()
String	getParentGroupId()
Set<String>	getProcessGroups()
Set<String>	getProcessors()
Set<String>	getRemoteProcessGroups()
boolean	isEmpty()
boolean	isLinked()

Method Detail

getId

String getId()

Returns:

id of this snippet

isLinked

boolean isLinked()

Returns:

Whether or not this snippet is linked to the data flow. If the Snippet is deleted and is linked, then the underlying components will also be deleted. If the Snippet is deleted and is NOT linked, only the Snippet is removed

getParentGroupId

String getParentGroupId()

Returns:

parent group id of the components in this snippet

getConnections

Set<String> getConnections()

Returns:

connections in this snippet

getFunnels

Set<String> getFunnels()

Returns:

funnels in this snippet

getInputPorts

Set<String> getInputPorts()

Returns:

input ports in this snippet

getOutputPorts

Set<String> getOutputPorts()

Returns:

output ports in this snippet

getLabels

Set<String> getLabels()

Returns:

labels in this snippet

getProcessGroups

Set<String> getProcessGroups()

Returns:

the identifiers of all ProcessGroups in this Snippet

getProcessors

Set<String> getProcessors()

Returns:

the identifiers of all Processors in this Snippet

getRemoteProcessGroups

Set<String> getRemoteProcessGroups()

Returns:

the identifiers of all RemoteProcessGroups in this Snippet

isEmpty

boolean isEmpty()

Returns:

Determines if this snippet is empty