org.apache.nifi.web.api.dto

Class ConnectionDTO

java.lang.Object

org.apache.nifi.web.api.dto.ComponentDTO

org.apache.nifi.web.api.dto.ConnectionDTO

public class ConnectionDTO
extends ComponentDTO

A connection between two connectable components.

Constructor Summary

Constructors

Constructor and Description
ConnectionDTO()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAvailableRelationships()
java.lang.String	getBackPressureDataSizeThreshold() The object data size threshold for determining when back pressure is applied.
java.lang.Long	getBackPressureObjectThreshold() The object count threshold for determining when back pressure is applied.
java.util.List<PositionDTO>	getBends()
ConnectableDTO	getDestination() The destination of this connection.
java.lang.String	getFlowFileExpiration() The amount of time a flow file may be in the flow before it will be automatically aged out of the flow.
java.lang.Integer	getLabelIndex()
java.lang.String	getName()
java.util.List<java.lang.String>	getPrioritizers() The prioritizers this connection is using.
java.util.Set<java.lang.String>	getSelectedRelationships() The relationships that make up this connection.
ConnectableDTO	getSource() The source of this connection.
java.lang.Long	getzIndex()
void	setAvailableRelationships(java.util.Set<java.lang.String> availableRelationships)
void	setBackPressureDataSizeThreshold(java.lang.String backPressureDataSizeThreshold)
void	setBackPressureObjectThreshold(java.lang.Long backPressureObjectThreshold)
void	setBends(java.util.List<PositionDTO> bends)
void	setDestination(ConnectableDTO destination)
void	setFlowFileExpiration(java.lang.String flowFileExpiration)
void	setLabelIndex(java.lang.Integer labelIndex)
void	setName(java.lang.String name)
void	setPrioritizers(java.util.List<java.lang.String> prioritizers)
void	setSelectedRelationships(java.util.Set<java.lang.String> relationships)
void	setSource(ConnectableDTO source)
void	setzIndex(java.lang.Long zIndex)
java.lang.String	toString()

Methods inherited from class org.apache.nifi.web.api.dto.ComponentDTO

equals, getId, getParentGroupId, getPosition, hashCode, setId, setParentGroupId, setPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionDTO

public ConnectionDTO()

Method Detail

getSource

public ConnectableDTO getSource()

The source of this connection.

Returns:

The source of this connection

setSource

public void setSource(ConnectableDTO source)

getDestination

public ConnectableDTO getDestination()

The destination of this connection.

Returns:

The destination of this connection

setDestination

public void setDestination(ConnectableDTO destination)

getName

public java.lang.String getName()

Returns:

name of the connection

setName

public void setName(java.lang.String name)

getBends

public java.util.List<PositionDTO> getBends()

Returns:

position of the bend points on this connection

setBends

public void setBends(java.util.List<PositionDTO> bends)

getLabelIndex

public java.lang.Integer getLabelIndex()

Returns:

The index of control point that the connection label should be placed over

setLabelIndex

public void setLabelIndex(java.lang.Integer labelIndex)

getzIndex

public java.lang.Long getzIndex()

Returns:

z index for this connection

setzIndex

public void setzIndex(java.lang.Long zIndex)

getSelectedRelationships

public java.util.Set<java.lang.String> getSelectedRelationships()

The relationships that make up this connection.

Returns:

The relationships

setSelectedRelationships

public void setSelectedRelationships(java.util.Set<java.lang.String> relationships)

getAvailableRelationships

public java.util.Set<java.lang.String> getAvailableRelationships()

Returns:

relationships that the source of the connection currently supports. This property is read only

setAvailableRelationships

public void setAvailableRelationships(java.util.Set<java.lang.String> availableRelationships)

getBackPressureObjectThreshold

public java.lang.Long getBackPressureObjectThreshold()

The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:

The back pressure object threshold

setBackPressureObjectThreshold

public void setBackPressureObjectThreshold(java.lang.Long backPressureObjectThreshold)

getBackPressureDataSizeThreshold

public java.lang.String getBackPressureDataSizeThreshold()

The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:

The back pressure data size threshold

setBackPressureDataSizeThreshold

public void setBackPressureDataSizeThreshold(java.lang.String backPressureDataSizeThreshold)

getFlowFileExpiration

public java.lang.String getFlowFileExpiration()

The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.

Returns:

The flow file expiration in minutes

setFlowFileExpiration

public void setFlowFileExpiration(java.lang.String flowFileExpiration)

getPrioritizers

public java.util.List<java.lang.String> getPrioritizers()

The prioritizers this connection is using.

Returns:

The prioritizer list

setPrioritizers

public void setPrioritizers(java.util.List<java.lang.String> prioritizers)

toString

public java.lang.String toString()

Overrides:

toString in class ComponentDTO