ProcessGroupDTO (nifi-client-dto 1.23.2 API)

java.lang.Object
- org.apache.nifi.web.api.dto.ComponentDTO
- - org.apache.nifi.web.api.dto.ProcessGroupDTO

```
public class ProcessGroupDTO
extends ComponentDTO
```
The details for a process group within this NiFi flow.

Field Summary

Fields
Modifier and Type	Field and Description
`private Integer`	`activeRemotePortCount`
`private String`	`comments`
`private FlowSnippetDTO`	`contents`
`private String`	`defaultBackPressureDataSizeThreshold`
`private Long`	`defaultBackPressureObjectThreshold`
`private String`	`defaultFlowFileExpiration`
`private Integer`	`disabledCount`
`private String`	`flowfileConcurrency`
`private String`	`flowfileOutboundPolicy`
`private Integer`	`inactiveRemotePortCount`
`private Integer`	`invalidCount`
`private Integer`	`localInputPortCount`
`private Integer`	`locallyModifiedAndStaleCount`
`private Integer`	`locallyModifiedCount`
`private Integer`	`localOutputPortCount`
`private String`	`logFileSuffix`
`private String`	`name`
`private ParameterContextReferenceEntity`	`parameterContext`
`private Integer`	`publicInputPortCount`
`private Integer`	`publicOutputPortCount`
`private Integer`	`runningCount`
`private Integer`	`staleCount`
`private Integer`	`stoppedCount`
`private Integer`	`syncFailureCount`
`private Integer`	`upToDateCount`
`private Map<String,String>`	`variables`
`private VersionControlInformationDTO`	`versionControlInformation`

Constructor Summary

Constructors
Constructor and Description

ProcessGroupDTO()

Constructors
Constructor and Description
`ProcessGroupDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getActiveRemotePortCount()`
`String`	`getComments()`
`FlowSnippetDTO`	`getContents()`
`String`	`getDefaultBackPressureDataSizeThreshold()`
`Long`	`getDefaultBackPressureObjectThreshold()`
`String`	`getDefaultFlowFileExpiration()`
`Integer`	`getDisabledCount()`
`String`	`getFlowfileConcurrency()`
`String`	`getFlowfileOutboundPolicy()`
`Integer`	`getInactiveRemotePortCount()`
`Integer`	`getInputPortCount()`
`Integer`	`getInvalidCount()`
`Integer`	`getLocalInputPortCount()`
`Integer`	`getLocallyModifiedAndStaleCount()`
`Integer`	`getLocallyModifiedCount()`
`Integer`	`getLocalOutputPortCount()`
`String`	`getLogFileSuffix()`
`String`	`getName()` The name of this Process Group.
`Integer`	`getOutputPortCount()`
`ParameterContextReferenceEntity`	`getParameterContext()`
`Integer`	`getPublicInputPortCount()`
`Integer`	`getPublicOutputPortCount()`
`Integer`	`getRunningCount()`
`Integer`	`getStaleCount()`
`Integer`	`getStoppedCount()`
`Integer`	`getSyncFailureCount()`
`Integer`	`getUpToDateCount()`
`Map<String,String>`	`getVariables()`
`VersionControlInformationDTO`	`getVersionControlInformation()`
`void`	`setActiveRemotePortCount(Integer activeRemotePortCount)`
`void`	`setComments(String comments)`
`void`	`setContents(FlowSnippetDTO contents)`
`void`	`setDefaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold)`
`void`	`setDefaultBackPressureObjectThreshold(Long defaultBackPressureObjectThreshold)`
`void`	`setDefaultFlowFileExpiration(String defaultFlowFileExpiration)`
`void`	`setDisabledCount(Integer disabledCount)`
`void`	`setFlowfileConcurrency(String flowfileConcurrency)`
`void`	`setFlowfileOutboundPolicy(String flowfileOutboundPolicy)`
`void`	`setInactiveRemotePortCount(Integer inactiveRemotePortCount)`
`void`	`setInputPortCount(Integer inputPortCount)`
`void`	`setInvalidCount(Integer invalidCount)`
`void`	`setLocalInputPortCount(Integer localInputPortCount)`
`void`	`setLocallyModifiedAndStaleCount(Integer locallyModifiedAndStaleCount)`
`void`	`setLocallyModifiedCount(Integer locallyModifiedCount)`
`void`	`setLocalOutputPortCount(Integer localOutputPortCount)`
`void`	`setLogFileSuffix(String logFileSuffix)`
`void`	`setName(String name)`
`void`	`setOutputPortCount(Integer outputPortCount)`
`void`	`setParameterContext(ParameterContextReferenceEntity parameterContext)`
`void`	`setPublicInputPortCount(Integer publicInputPortCount)`
`void`	`setPublicOutputPortCount(Integer publicOutputPortCount)`
`void`	`setRunningCount(Integer runningCount)`
`void`	`setStaleCount(Integer staleCount)`
`void`	`setStoppedCount(Integer stoppedCount)`
`void`	`setSyncFailureCount(Integer syncFailureCount)`
`void`	`setUpToDateCount(Integer upToDateCount)`
`void`	`setVariables(Map<String,String> variables)`
`void`	`setVersionControlInformation(VersionControlInformationDTO versionControlInformation)`

Methods inherited from class org.apache.nifi.web.api.dto.ComponentDTO
equals, getId, getParentGroupId, getPosition, getVersionedComponentId, hashCode, setId, setParentGroupId, setPosition, setVersionedComponentId, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name
```
private String name
```

comments
```
private String comments
```

variables
```
private Map<String,String> variables
```

versionControlInformation

private VersionControlInformationDTO versionControlInformation

parameterContext

private ParameterContextReferenceEntity parameterContext

flowfileConcurrency
```
private String flowfileConcurrency
```

flowfileOutboundPolicy
```
private String flowfileOutboundPolicy
```

defaultFlowFileExpiration

private String defaultFlowFileExpiration

defaultBackPressureObjectThreshold

private Long defaultBackPressureObjectThreshold

defaultBackPressureDataSizeThreshold

private String defaultBackPressureDataSizeThreshold

logFileSuffix
```
private String logFileSuffix
```

runningCount
```
private Integer runningCount
```

stoppedCount
```
private Integer stoppedCount
```

invalidCount
```
private Integer invalidCount
```

disabledCount
```
private Integer disabledCount
```

activeRemotePortCount
```
private Integer activeRemotePortCount
```

inactiveRemotePortCount

private Integer inactiveRemotePortCount

upToDateCount
```
private Integer upToDateCount
```

locallyModifiedCount
```
private Integer locallyModifiedCount
```

staleCount
```
private Integer staleCount
```

locallyModifiedAndStaleCount

private Integer locallyModifiedAndStaleCount

syncFailureCount
```
private Integer syncFailureCount
```

localInputPortCount
```
private Integer localInputPortCount
```

localOutputPortCount
```
private Integer localOutputPortCount
```

publicInputPortCount
```
private Integer publicInputPortCount
```

publicOutputPortCount
```
private Integer publicOutputPortCount
```

contents
```
private FlowSnippetDTO contents
```

Constructor Detail
- ProcessGroupDTO
```
public ProcessGroupDTO()
```

Method Detail

getName
```
public String getName()
```
The name of this Process Group.

Returns:

The name of this Process Group

setName
```
public void setName(String name)
```

getComments
```
public String getComments()
```
Returns:

comments for this process group

setComments

public void setComments(String comments)

getContents
```
public FlowSnippetDTO getContents()
```
Returns:

contents of this process group.

setContents

public void setContents(FlowSnippetDTO contents)

getInputPortCount
```
public Integer getInputPortCount()
```
Returns:

number of input ports contained in this process group

setInputPortCount

public void setInputPortCount(Integer inputPortCount)

getLocalInputPortCount
```
public Integer getLocalInputPortCount()
```
Returns:

number of local input ports contained in this process group

setLocalInputPortCount

public void setLocalInputPortCount(Integer localInputPortCount)

getPublicInputPortCount
```
public Integer getPublicInputPortCount()
```
Returns:

number of public input ports contained in this process group

setPublicInputPortCount

public void setPublicInputPortCount(Integer publicInputPortCount)

getInvalidCount
```
public Integer getInvalidCount()
```
Returns:

number of invalid components in this process group

setInvalidCount

public void setInvalidCount(Integer invalidCount)

getOutputPortCount
```
public Integer getOutputPortCount()
```
Returns:

number of output ports in this process group

setOutputPortCount

public void setOutputPortCount(Integer outputPortCount)

getLocalOutputPortCount
```
public Integer getLocalOutputPortCount()
```
Returns:

number of local output ports in this process group

setLocalOutputPortCount

public void setLocalOutputPortCount(Integer localOutputPortCount)

getPublicOutputPortCount
```
public Integer getPublicOutputPortCount()
```
Returns:

number of public output ports in this process group

setPublicOutputPortCount

public void setPublicOutputPortCount(Integer publicOutputPortCount)

getRunningCount
```
public Integer getRunningCount()
```
Returns:

number of running component in this process group

setRunningCount

public void setRunningCount(Integer runningCount)

getStoppedCount
```
public Integer getStoppedCount()
```
Returns:

number of stopped components in this process group

setStoppedCount

public void setStoppedCount(Integer stoppedCount)

getDisabledCount
```
public Integer getDisabledCount()
```
Returns:

number of disabled components in this process group

setDisabledCount

public void setDisabledCount(Integer disabledCount)

getActiveRemotePortCount
```
public Integer getActiveRemotePortCount()
```
Returns:

number of active remote ports in this process group

setActiveRemotePortCount

public void setActiveRemotePortCount(Integer activeRemotePortCount)

getInactiveRemotePortCount
```
public Integer getInactiveRemotePortCount()
```
Returns:

number of inactive remote ports in this process group

setInactiveRemotePortCount

public void setInactiveRemotePortCount(Integer inactiveRemotePortCount)

getUpToDateCount
```
public Integer getUpToDateCount()
```

setUpToDateCount

public void setUpToDateCount(Integer upToDateCount)

getLocallyModifiedCount

public Integer getLocallyModifiedCount()

setLocallyModifiedCount

public void setLocallyModifiedCount(Integer locallyModifiedCount)

getStaleCount
```
public Integer getStaleCount()
```

setStaleCount

public void setStaleCount(Integer staleCount)

getLocallyModifiedAndStaleCount

public Integer getLocallyModifiedAndStaleCount()

setLocallyModifiedAndStaleCount

public void setLocallyModifiedAndStaleCount(Integer locallyModifiedAndStaleCount)

getSyncFailureCount
```
public Integer getSyncFailureCount()
```

setSyncFailureCount

public void setSyncFailureCount(Integer syncFailureCount)

getVariables

public Map<String,String> getVariables()

setVariables

public void setVariables(Map<String,String> variables)

getVersionControlInformation

public VersionControlInformationDTO getVersionControlInformation()

setVersionControlInformation

public void setVersionControlInformation(VersionControlInformationDTO versionControlInformation)

getParameterContext

public ParameterContextReferenceEntity getParameterContext()

setParameterContext

public void setParameterContext(ParameterContextReferenceEntity parameterContext)

getFlowfileConcurrency

public String getFlowfileConcurrency()

setFlowfileConcurrency

public void setFlowfileConcurrency(String flowfileConcurrency)

getFlowfileOutboundPolicy

public String getFlowfileOutboundPolicy()

setFlowfileOutboundPolicy

public void setFlowfileOutboundPolicy(String flowfileOutboundPolicy)

getDefaultFlowFileExpiration

public String getDefaultFlowFileExpiration()

setDefaultFlowFileExpiration

public void setDefaultFlowFileExpiration(String defaultFlowFileExpiration)

getDefaultBackPressureObjectThreshold

public Long getDefaultBackPressureObjectThreshold()

setDefaultBackPressureObjectThreshold

public void setDefaultBackPressureObjectThreshold(Long defaultBackPressureObjectThreshold)

getDefaultBackPressureDataSizeThreshold

public String getDefaultBackPressureDataSizeThreshold()

setDefaultBackPressureDataSizeThreshold

public void setDefaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold)

getLogFileSuffix
```
public String getLogFileSuffix()
```

setLogFileSuffix

public void setLogFileSuffix(String logFileSuffix)

Class ProcessGroupDTO

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

name

comments

variables

versionControlInformation

parameterContext

flowfileConcurrency

flowfileOutboundPolicy

defaultFlowFileExpiration

defaultBackPressureObjectThreshold

defaultBackPressureDataSizeThreshold

logFileSuffix

runningCount

stoppedCount

invalidCount

disabledCount

activeRemotePortCount

inactiveRemotePortCount

upToDateCount

locallyModifiedCount

staleCount

locallyModifiedAndStaleCount

syncFailureCount

localInputPortCount

localOutputPortCount

publicInputPortCount

publicOutputPortCount

contents

Constructor Detail

ProcessGroupDTO

Method Detail

getName

setName

getComments

setComments

getContents

setContents

getInputPortCount

setInputPortCount

getLocalInputPortCount

setLocalInputPortCount

getPublicInputPortCount

setPublicInputPortCount

getInvalidCount

setInvalidCount

getOutputPortCount

setOutputPortCount

getLocalOutputPortCount

setLocalOutputPortCount

getPublicOutputPortCount

setPublicOutputPortCount

getRunningCount

setRunningCount

getStoppedCount

setStoppedCount

getDisabledCount

setDisabledCount

getActiveRemotePortCount

setActiveRemotePortCount

getInactiveRemotePortCount

setInactiveRemotePortCount

getUpToDateCount

setUpToDateCount

getLocallyModifiedCount

setLocallyModifiedCount

getStaleCount

setStaleCount

getLocallyModifiedAndStaleCount

setLocallyModifiedAndStaleCount

getSyncFailureCount

setSyncFailureCount

getVariables

setVariables

getVersionControlInformation