Package org.apache.nifi.api.toolkit.model

Class VersionedProcessGroup

java.lang.Object

org.apache.nifi.api.toolkit.model.VersionedProcessGroup

@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
           date="2023-11-22T19:25:26.907436939-06:00[America/Chicago]")
public class VersionedProcessGroup
extends Object

VersionedProcessGroup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VersionedProcessGroup.ComponentTypeEnum	Gets or Sets componentType
static enum	VersionedProcessGroup.ExecutionEngineEnum	The Execution Engine that should be used to run the components within the group.
static enum	VersionedProcessGroup.ScheduledStateEnum	The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine.

Field Summary

Fields

Modifier and Type	Field	Description
private String	comments
private VersionedProcessGroup.ComponentTypeEnum	componentType
private List<VersionedConnection>	connections
private List<VersionedControllerService>	controllerServices
private String	defaultBackPressureDataSizeThreshold
private Long	defaultBackPressureObjectThreshold
private String	defaultFlowFileExpiration
private VersionedProcessGroup.ExecutionEngineEnum	executionEngine
private String	flowFileConcurrency
private String	flowFileOutboundPolicy
private List<VersionedFunnel>	funnels
private String	groupIdentifier
private String	identifier
private List<VersionedPort>	inputPorts
private String	instanceIdentifier
private List<VersionedLabel>	labels
private String	logFileSuffix
private Integer	maxConcurrentTasks
private String	name
private List<VersionedPort>	outputPorts
private String	parameterContextName
private Position	position
private List<VersionedProcessGroup>	processGroups
private List<VersionedProcessor>	processors
private List<VersionedRemoteProcessGroup>	remoteProcessGroups
private VersionedProcessGroup.ScheduledStateEnum	scheduledState
private String	statelessFlowTimeout
private VersionedFlowCoordinates	versionedFlowCoordinates

Constructor Summary

Constructors

Constructor	Description
VersionedProcessGroup()

Method Summary

Modifier and Type	Method	Description
VersionedProcessGroup	addConnectionsItem(VersionedConnection connectionsItem)
VersionedProcessGroup	addControllerServicesItem(VersionedControllerService controllerServicesItem)
VersionedProcessGroup	addFunnelsItem(VersionedFunnel funnelsItem)
VersionedProcessGroup	addInputPortsItem(VersionedPort inputPortsItem)
VersionedProcessGroup	addLabelsItem(VersionedLabel labelsItem)
VersionedProcessGroup	addOutputPortsItem(VersionedPort outputPortsItem)
VersionedProcessGroup	addProcessGroupsItem(VersionedProcessGroup processGroupsItem)
VersionedProcessGroup	addProcessorsItem(VersionedProcessor processorsItem)
VersionedProcessGroup	addRemoteProcessGroupsItem(VersionedRemoteProcessGroup remoteProcessGroupsItem)
VersionedProcessGroup	comments(String comments)
VersionedProcessGroup	componentType(VersionedProcessGroup.ComponentTypeEnum componentType)
VersionedProcessGroup	connections(List<VersionedConnection> connections)
VersionedProcessGroup	controllerServices(List<VersionedControllerService> controllerServices)
VersionedProcessGroup	defaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold)
VersionedProcessGroup	defaultBackPressureObjectThreshold(Long defaultBackPressureObjectThreshold)
VersionedProcessGroup	defaultFlowFileExpiration(String defaultFlowFileExpiration)
boolean	equals(Object o)
VersionedProcessGroup	executionEngine(VersionedProcessGroup.ExecutionEngineEnum executionEngine)
VersionedProcessGroup	flowFileConcurrency(String flowFileConcurrency)
VersionedProcessGroup	flowFileOutboundPolicy(String flowFileOutboundPolicy)
VersionedProcessGroup	funnels(List<VersionedFunnel> funnels)
String	getComments()	The user-supplied comments for the component
VersionedProcessGroup.ComponentTypeEnum	getComponentType()	Get componentType
List<VersionedConnection>	getConnections()	The Connections
List<VersionedControllerService>	getControllerServices()	The Controller Services
String	getDefaultBackPressureDataSizeThreshold()	Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.
Long	getDefaultBackPressureObjectThreshold()	Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.
String	getDefaultFlowFileExpiration()	The default FlowFile Expiration for this Process Group.
VersionedProcessGroup.ExecutionEngineEnum	getExecutionEngine()	The Execution Engine that should be used to run the components within the group.
String	getFlowFileConcurrency()	The configured FlowFile Concurrency for the Process Group
String	getFlowFileOutboundPolicy()	The FlowFile Outbound Policy for the Process Group
List<VersionedFunnel>	getFunnels()	The Funnels
String	getGroupIdentifier()	The ID of the Process Group that this component belongs to
String	getIdentifier()	The component's unique identifier
List<VersionedPort>	getInputPorts()	The Input Ports
String	getInstanceIdentifier()	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
List<VersionedLabel>	getLabels()	The Labels
String	getLogFileSuffix()	The log file suffix for this Process Group for dedicated logging.
Integer	getMaxConcurrentTasks()	The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine
String	getName()	The component's name
List<VersionedPort>	getOutputPorts()	The Output Ports
String	getParameterContextName()	The name of the parameter context used by this process group
Position	getPosition()	Get position
List<VersionedProcessGroup>	getProcessGroups()	The child Process Groups
List<VersionedProcessor>	getProcessors()	The Processors
List<VersionedRemoteProcessGroup>	getRemoteProcessGroups()	The Remote Process Groups
VersionedProcessGroup.ScheduledStateEnum	getScheduledState()	The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine.
String	getStatelessFlowTimeout()	The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure
VersionedFlowCoordinates	getVersionedFlowCoordinates()	Get versionedFlowCoordinates
VersionedProcessGroup	groupIdentifier(String groupIdentifier)
int	hashCode()
VersionedProcessGroup	identifier(String identifier)
VersionedProcessGroup	inputPorts(List<VersionedPort> inputPorts)
VersionedProcessGroup	instanceIdentifier(String instanceIdentifier)
VersionedProcessGroup	labels(List<VersionedLabel> labels)
VersionedProcessGroup	logFileSuffix(String logFileSuffix)
VersionedProcessGroup	maxConcurrentTasks(Integer maxConcurrentTasks)
VersionedProcessGroup	name(String name)
VersionedProcessGroup	outputPorts(List<VersionedPort> outputPorts)
VersionedProcessGroup	parameterContextName(String parameterContextName)
VersionedProcessGroup	position(Position position)
VersionedProcessGroup	processGroups(List<VersionedProcessGroup> processGroups)
VersionedProcessGroup	processors(List<VersionedProcessor> processors)
VersionedProcessGroup	remoteProcessGroups(List<VersionedRemoteProcessGroup> remoteProcessGroups)
VersionedProcessGroup	scheduledState(VersionedProcessGroup.ScheduledStateEnum scheduledState)
void	setComments(String comments)
void	setComponentType(VersionedProcessGroup.ComponentTypeEnum componentType)
void	setConnections(List<VersionedConnection> connections)
void	setControllerServices(List<VersionedControllerService> controllerServices)
void	setDefaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold)
void	setDefaultBackPressureObjectThreshold(Long defaultBackPressureObjectThreshold)
void	setDefaultFlowFileExpiration(String defaultFlowFileExpiration)
void	setExecutionEngine(VersionedProcessGroup.ExecutionEngineEnum executionEngine)
void	setFlowFileConcurrency(String flowFileConcurrency)
void	setFlowFileOutboundPolicy(String flowFileOutboundPolicy)
void	setFunnels(List<VersionedFunnel> funnels)
void	setGroupIdentifier(String groupIdentifier)
void	setIdentifier(String identifier)
void	setInputPorts(List<VersionedPort> inputPorts)
void	setInstanceIdentifier(String instanceIdentifier)
void	setLabels(List<VersionedLabel> labels)
void	setLogFileSuffix(String logFileSuffix)
void	setMaxConcurrentTasks(Integer maxConcurrentTasks)
void	setName(String name)
void	setOutputPorts(List<VersionedPort> outputPorts)
void	setParameterContextName(String parameterContextName)
void	setPosition(Position position)
void	setProcessGroups(List<VersionedProcessGroup> processGroups)
void	setProcessors(List<VersionedProcessor> processors)
void	setRemoteProcessGroups(List<VersionedRemoteProcessGroup> remoteProcessGroups)
void	setScheduledState(VersionedProcessGroup.ScheduledStateEnum scheduledState)
void	setStatelessFlowTimeout(String statelessFlowTimeout)
void	setVersionedFlowCoordinates(VersionedFlowCoordinates versionedFlowCoordinates)
VersionedProcessGroup	statelessFlowTimeout(String statelessFlowTimeout)
private String	toIndentedString(Object o)	Convert the given object to string with each line indented by 4 spaces (except the first line).
String	toString()
VersionedProcessGroup	versionedFlowCoordinates(VersionedFlowCoordinates versionedFlowCoordinates)

Methods inherited from class java.lang.Object

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

Field Details

identifier

private String identifier

instanceIdentifier

private String instanceIdentifier

name

private String name

comments

private String comments

position

private Position position

processGroups

private List<VersionedProcessGroup> processGroups

remoteProcessGroups

private List<VersionedRemoteProcessGroup> remoteProcessGroups

processors

private List<VersionedProcessor> processors

inputPorts

private List<VersionedPort> inputPorts

outputPorts

private List<VersionedPort> outputPorts

connections

private List<VersionedConnection> connections

labels

private List<VersionedLabel> labels

funnels

private List<VersionedFunnel> funnels

controllerServices

private List<VersionedControllerService> controllerServices

versionedFlowCoordinates

private VersionedFlowCoordinates versionedFlowCoordinates

parameterContextName

private String parameterContextName

defaultFlowFileExpiration

private String defaultFlowFileExpiration

defaultBackPressureObjectThreshold

private Long defaultBackPressureObjectThreshold

defaultBackPressureDataSizeThreshold

private String defaultBackPressureDataSizeThreshold

scheduledState

private VersionedProcessGroup.ScheduledStateEnum scheduledState

executionEngine

private VersionedProcessGroup.ExecutionEngineEnum executionEngine

maxConcurrentTasks

private Integer maxConcurrentTasks

statelessFlowTimeout

private String statelessFlowTimeout

logFileSuffix

private String logFileSuffix

flowFileConcurrency

private String flowFileConcurrency

flowFileOutboundPolicy

private String flowFileOutboundPolicy

componentType

private VersionedProcessGroup.ComponentTypeEnum componentType

groupIdentifier

private String groupIdentifier

Constructor Details

VersionedProcessGroup

public VersionedProcessGroup()

Method Details

identifier

public VersionedProcessGroup identifier(String identifier)

getIdentifier

public String getIdentifier()

The component's unique identifier

Returns:

identifier

setIdentifier

public void setIdentifier(String identifier)

instanceIdentifier

public VersionedProcessGroup instanceIdentifier(String instanceIdentifier)

getInstanceIdentifier

public String getInstanceIdentifier()

The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:

instanceIdentifier

setInstanceIdentifier

public void setInstanceIdentifier(String instanceIdentifier)

name

public VersionedProcessGroup name(String name)

getName

public String getName()

The component's name

Returns:

name

setName

public void setName(String name)

comments

public VersionedProcessGroup comments(String comments)

getComments

public String getComments()

The user-supplied comments for the component

Returns:

comments

setComments

public void setComments(String comments)

position

public VersionedProcessGroup position(Position position)

getPosition

public Position getPosition()

Get position

Returns:

position

setPosition

public void setPosition(Position position)

processGroups

public VersionedProcessGroup processGroups(List<VersionedProcessGroup> processGroups)

addProcessGroupsItem

public VersionedProcessGroup addProcessGroupsItem(VersionedProcessGroup processGroupsItem)

getProcessGroups

public List<VersionedProcessGroup> getProcessGroups()

The child Process Groups

Returns:

processGroups

setProcessGroups

public void setProcessGroups(List<VersionedProcessGroup> processGroups)

remoteProcessGroups

public VersionedProcessGroup remoteProcessGroups(List<VersionedRemoteProcessGroup> remoteProcessGroups)

addRemoteProcessGroupsItem

public VersionedProcessGroup addRemoteProcessGroupsItem(VersionedRemoteProcessGroup remoteProcessGroupsItem)

getRemoteProcessGroups

public List<VersionedRemoteProcessGroup> getRemoteProcessGroups()

The Remote Process Groups

Returns:

remoteProcessGroups

setRemoteProcessGroups

public void setRemoteProcessGroups(List<VersionedRemoteProcessGroup> remoteProcessGroups)

processors

public VersionedProcessGroup processors(List<VersionedProcessor> processors)

addProcessorsItem

public VersionedProcessGroup addProcessorsItem(VersionedProcessor processorsItem)

getProcessors

public List<VersionedProcessor> getProcessors()

The Processors

Returns:

processors

setProcessors

public void setProcessors(List<VersionedProcessor> processors)

inputPorts

public VersionedProcessGroup inputPorts(List<VersionedPort> inputPorts)

addInputPortsItem

public VersionedProcessGroup addInputPortsItem(VersionedPort inputPortsItem)

getInputPorts

public List<VersionedPort> getInputPorts()

The Input Ports

Returns:

inputPorts

setInputPorts

public void setInputPorts(List<VersionedPort> inputPorts)

outputPorts

public VersionedProcessGroup outputPorts(List<VersionedPort> outputPorts)

addOutputPortsItem

public VersionedProcessGroup addOutputPortsItem(VersionedPort outputPortsItem)

getOutputPorts

public List<VersionedPort> getOutputPorts()

The Output Ports

Returns:

outputPorts

setOutputPorts

public void setOutputPorts(List<VersionedPort> outputPorts)

connections

public VersionedProcessGroup connections(List<VersionedConnection> connections)

addConnectionsItem

public VersionedProcessGroup addConnectionsItem(VersionedConnection connectionsItem)

getConnections

public List<VersionedConnection> getConnections()

The Connections

Returns:

connections

setConnections

public void setConnections(List<VersionedConnection> connections)

labels

public VersionedProcessGroup labels(List<VersionedLabel> labels)

addLabelsItem

public VersionedProcessGroup addLabelsItem(VersionedLabel labelsItem)

getLabels

public List<VersionedLabel> getLabels()

The Labels

Returns:

labels

setLabels

public void setLabels(List<VersionedLabel> labels)

funnels

public VersionedProcessGroup funnels(List<VersionedFunnel> funnels)

addFunnelsItem

public VersionedProcessGroup addFunnelsItem(VersionedFunnel funnelsItem)

getFunnels

public List<VersionedFunnel> getFunnels()

The Funnels

Returns:

funnels

setFunnels

public void setFunnels(List<VersionedFunnel> funnels)

controllerServices

public VersionedProcessGroup controllerServices(List<VersionedControllerService> controllerServices)

addControllerServicesItem

public VersionedProcessGroup addControllerServicesItem(VersionedControllerService controllerServicesItem)

getControllerServices

public List<VersionedControllerService> getControllerServices()

The Controller Services

Returns:

controllerServices

setControllerServices

public void setControllerServices(List<VersionedControllerService> controllerServices)

versionedFlowCoordinates

public VersionedProcessGroup versionedFlowCoordinates(VersionedFlowCoordinates versionedFlowCoordinates)

getVersionedFlowCoordinates

public VersionedFlowCoordinates getVersionedFlowCoordinates()

Get versionedFlowCoordinates

Returns:

versionedFlowCoordinates

setVersionedFlowCoordinates

public void setVersionedFlowCoordinates(VersionedFlowCoordinates versionedFlowCoordinates)

parameterContextName

public VersionedProcessGroup parameterContextName(String parameterContextName)

getParameterContextName

public String getParameterContextName()

The name of the parameter context used by this process group

Returns:

parameterContextName

setParameterContextName

public void setParameterContextName(String parameterContextName)

defaultFlowFileExpiration

public VersionedProcessGroup defaultFlowFileExpiration(String defaultFlowFileExpiration)

getDefaultFlowFileExpiration

public String getDefaultFlowFileExpiration()

The default FlowFile Expiration for this Process Group.

Returns:

defaultFlowFileExpiration

setDefaultFlowFileExpiration

public void setDefaultFlowFileExpiration(String defaultFlowFileExpiration)

defaultBackPressureObjectThreshold

public VersionedProcessGroup defaultBackPressureObjectThreshold(Long defaultBackPressureObjectThreshold)

getDefaultBackPressureObjectThreshold

public Long getDefaultBackPressureObjectThreshold()

Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:

defaultBackPressureObjectThreshold

setDefaultBackPressureObjectThreshold

public void setDefaultBackPressureObjectThreshold(Long defaultBackPressureObjectThreshold)

defaultBackPressureDataSizeThreshold

public VersionedProcessGroup defaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold)

getDefaultBackPressureDataSizeThreshold

public String getDefaultBackPressureDataSizeThreshold()

Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:

defaultBackPressureDataSizeThreshold

setDefaultBackPressureDataSizeThreshold

public void setDefaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold)

scheduledState

public VersionedProcessGroup scheduledState(VersionedProcessGroup.ScheduledStateEnum scheduledState)

getScheduledState

public VersionedProcessGroup.ScheduledStateEnum getScheduledState()

The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance.

Returns:

scheduledState

setScheduledState

public void setScheduledState(VersionedProcessGroup.ScheduledStateEnum scheduledState)

executionEngine

public VersionedProcessGroup executionEngine(VersionedProcessGroup.ExecutionEngineEnum executionEngine)

getExecutionEngine

public VersionedProcessGroup.ExecutionEngineEnum getExecutionEngine()

The Execution Engine that should be used to run the components within the group.

Returns:

executionEngine

setExecutionEngine

public void setExecutionEngine(VersionedProcessGroup.ExecutionEngineEnum executionEngine)

maxConcurrentTasks

public VersionedProcessGroup maxConcurrentTasks(Integer maxConcurrentTasks)

getMaxConcurrentTasks

public Integer getMaxConcurrentTasks()

The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine

Returns:

maxConcurrentTasks

setMaxConcurrentTasks

public void setMaxConcurrentTasks(Integer maxConcurrentTasks)

statelessFlowTimeout

public VersionedProcessGroup statelessFlowTimeout(String statelessFlowTimeout)

getStatelessFlowTimeout

public String getStatelessFlowTimeout()

The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure

Returns:

statelessFlowTimeout

setStatelessFlowTimeout

public void setStatelessFlowTimeout(String statelessFlowTimeout)

logFileSuffix

public VersionedProcessGroup logFileSuffix(String logFileSuffix)

getLogFileSuffix

public String getLogFileSuffix()

The log file suffix for this Process Group for dedicated logging.

Returns:

logFileSuffix

setLogFileSuffix

public void setLogFileSuffix(String logFileSuffix)

flowFileConcurrency

public VersionedProcessGroup flowFileConcurrency(String flowFileConcurrency)

getFlowFileConcurrency

public String getFlowFileConcurrency()

The configured FlowFile Concurrency for the Process Group

Returns:

flowFileConcurrency

setFlowFileConcurrency

public void setFlowFileConcurrency(String flowFileConcurrency)

flowFileOutboundPolicy

public VersionedProcessGroup flowFileOutboundPolicy(String flowFileOutboundPolicy)

getFlowFileOutboundPolicy

public String getFlowFileOutboundPolicy()

The FlowFile Outbound Policy for the Process Group

Returns:

flowFileOutboundPolicy

setFlowFileOutboundPolicy

public void setFlowFileOutboundPolicy(String flowFileOutboundPolicy)

componentType

public VersionedProcessGroup componentType(VersionedProcessGroup.ComponentTypeEnum componentType)

getComponentType

public VersionedProcessGroup.ComponentTypeEnum getComponentType()

Get componentType

Returns:

componentType

setComponentType

public void setComponentType(VersionedProcessGroup.ComponentTypeEnum componentType)

groupIdentifier

public VersionedProcessGroup groupIdentifier(String groupIdentifier)

getGroupIdentifier

public String getGroupIdentifier()

The ID of the Process Group that this component belongs to

Returns:

groupIdentifier

setGroupIdentifier

public void setGroupIdentifier(String groupIdentifier)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toIndentedString

private String toIndentedString(Object o)

Convert the given object to string with each line indented by 4 spaces (except the first line).