Class ProcessGroupDTO
java.lang.Object
org.apache.nifi.api.toolkit.model.ProcessGroupDTO
@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen",
date="2023-11-22T19:25:26.907436939-06:00[America/Chicago]")
public class ProcessGroupDTO
extends Object
ProcessGroupDTO
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The Execution Engine that should be used to run the flow represented by this Process Group.static enum
The FlowFile Concurrency for this Process Group.static enum
The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.static enum
If the Process Group is configured to run in using the Stateless Engine, represents the current state. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Integer
private String
private FlowSnippetDTO
private String
private Long
private String
private Integer
private String
private Integer
private Integer
private Integer
private Integer
private Integer
private Integer
private Integer
private String
private Integer
private String
private Integer
private ParameterContextReferenceEntity
private String
private PositionDTO
private Integer
private Integer
private Integer
private Integer
private String
private Integer
private Integer
private Integer
private VersionControlInformationDTO
private String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactiveRemotePortCount
(Integer activeRemotePortCount) contents
(FlowSnippetDTO contents) defaultBackPressureDataSizeThreshold
(String defaultBackPressureDataSizeThreshold) defaultBackPressureObjectThreshold
(Long defaultBackPressureObjectThreshold) defaultFlowFileExpiration
(String defaultFlowFileExpiration) disabledCount
(Integer disabledCount) boolean
executionEngine
(ProcessGroupDTO.ExecutionEngineEnum executionEngine) flowfileConcurrency
(ProcessGroupDTO.FlowfileConcurrencyEnum flowfileConcurrency) flowfileOutboundPolicy
(ProcessGroupDTO.FlowfileOutboundPolicyEnum flowfileOutboundPolicy) The number of active remote ports in the process group.The comments for the process group.Get contentsDefault value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.The default FlowFile Expiration for this Process Group.The number of disabled components in the process group.The Execution Engine that should be used to run the flow represented by this Process Group.The FlowFile Concurrency for this Process Group.The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.getId()
The id of the component.The number of inactive remote ports in the process group.The number of input ports in the process group.The number of invalid components in the process group.The number of local input ports in the process group.The number of locally modified and stale versioned process groups in the process group.The number of locally modified versioned process groups in the process group.The number of local output ports in the process group.The log file suffix for this Process Group for dedicated logging.The maximum number of concurrent tasks to use when running the flow using the Stateless EnginegetName()
The name of the process group.The number of output ports in the process group.Get parameterContextThe id of parent process group of this component if applicable.Get positionThe number of public input ports in the process group.The number of public output ports in the process group.The number of running components in this process group.The number of stale versioned process groups in the process group.The maximum amount of time that the flow can be run using the Stateless Engine before the flow times outIf the Process Group is configured to run in using the Stateless Engine, represents the current state.The number of stopped components in the process group.The number of versioned process groups in the process group that are unable to sync to a registry.The number of up to date versioned process groups in the process group.Get versionControlInformationThe ID of the corresponding component that is under version controlint
hashCode()
inactiveRemotePortCount
(Integer inactiveRemotePortCount) invalidCount
(Integer invalidCount) localInputPortCount
(Integer localInputPortCount) locallyModifiedAndStaleCount
(Integer locallyModifiedAndStaleCount) locallyModifiedCount
(Integer locallyModifiedCount) localOutputPortCount
(Integer localOutputPortCount) logFileSuffix
(String logFileSuffix) maxConcurrentTasks
(Integer maxConcurrentTasks) parameterContext
(ParameterContextReferenceEntity parameterContext) parentGroupId
(String parentGroupId) position
(PositionDTO position) publicInputPortCount
(Integer publicInputPortCount) publicOutputPortCount
(Integer publicOutputPortCount) runningCount
(Integer runningCount) 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
setExecutionEngine
(ProcessGroupDTO.ExecutionEngineEnum executionEngine) void
setFlowfileConcurrency
(ProcessGroupDTO.FlowfileConcurrencyEnum flowfileConcurrency) void
setFlowfileOutboundPolicy
(ProcessGroupDTO.FlowfileOutboundPolicyEnum flowfileOutboundPolicy) void
void
setInactiveRemotePortCount
(Integer inactiveRemotePortCount) 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
setMaxConcurrentTasks
(Integer maxConcurrentTasks) void
void
setParameterContext
(ParameterContextReferenceEntity parameterContext) void
setParentGroupId
(String parentGroupId) void
setPosition
(PositionDTO position) void
setPublicInputPortCount
(Integer publicInputPortCount) void
setPublicOutputPortCount
(Integer publicOutputPortCount) void
setRunningCount
(Integer runningCount) void
setStaleCount
(Integer staleCount) void
setStatelessFlowTimeout
(String statelessFlowTimeout) void
setStatelessGroupScheduledState
(ProcessGroupDTO.StatelessGroupScheduledStateEnum statelessGroupScheduledState) void
setStoppedCount
(Integer stoppedCount) void
setSyncFailureCount
(Integer syncFailureCount) void
setUpToDateCount
(Integer upToDateCount) void
setVersionControlInformation
(VersionControlInformationDTO versionControlInformation) void
setVersionedComponentId
(String versionedComponentId) staleCount
(Integer staleCount) statelessFlowTimeout
(String statelessFlowTimeout) statelessGroupScheduledState
(ProcessGroupDTO.StatelessGroupScheduledStateEnum statelessGroupScheduledState) stoppedCount
(Integer stoppedCount) syncFailureCount
(Integer syncFailureCount) private String
Convert the given object to string with each line indented by 4 spaces (except the first line).toString()
upToDateCount
(Integer upToDateCount) versionControlInformation
(VersionControlInformationDTO versionControlInformation) versionedComponentId
(String versionedComponentId)
-
Field Details
-
id
-
versionedComponentId
-
parentGroupId
-
position
-
name
-
comments
-
versionControlInformation
-
parameterContext
-
flowfileConcurrency
-
flowfileOutboundPolicy
-
defaultFlowFileExpiration
-
defaultBackPressureObjectThreshold
-
defaultBackPressureDataSizeThreshold
-
logFileSuffix
-
executionEngine
-
maxConcurrentTasks
-
statelessFlowTimeout
-
runningCount
-
stoppedCount
-
invalidCount
-
disabledCount
-
activeRemotePortCount
-
inactiveRemotePortCount
-
upToDateCount
-
locallyModifiedCount
-
staleCount
-
locallyModifiedAndStaleCount
-
syncFailureCount
-
localInputPortCount
-
localOutputPortCount
-
publicInputPortCount
-
publicOutputPortCount
-
statelessGroupScheduledState
-
contents
-
inputPortCount
-
outputPortCount
-
-
Constructor Details
-
ProcessGroupDTO
public ProcessGroupDTO()
-
-
Method Details
-
id
-
getId
The id of the component.- Returns:
- id
-
setId
-
versionedComponentId
-
getVersionedComponentId
The ID of the corresponding component that is under version control- Returns:
- versionedComponentId
-
setVersionedComponentId
-
parentGroupId
-
getParentGroupId
The id of parent process group of this component if applicable.- Returns:
- parentGroupId
-
setParentGroupId
-
position
-
getPosition
Get position- Returns:
- position
-
setPosition
-
name
-
getName
The name of the process group.- Returns:
- name
-
setName
-
comments
-
getComments
The comments for the process group.- Returns:
- comments
-
setComments
-
versionControlInformation
public ProcessGroupDTO versionControlInformation(VersionControlInformationDTO versionControlInformation) -
getVersionControlInformation
Get versionControlInformation- Returns:
- versionControlInformation
-
setVersionControlInformation
-
parameterContext
-
getParameterContext
Get parameterContext- Returns:
- parameterContext
-
setParameterContext
-
flowfileConcurrency
public ProcessGroupDTO flowfileConcurrency(ProcessGroupDTO.FlowfileConcurrencyEnum flowfileConcurrency) -
getFlowfileConcurrency
The FlowFile Concurrency for this Process Group.- Returns:
- flowfileConcurrency
-
setFlowfileConcurrency
-
flowfileOutboundPolicy
public ProcessGroupDTO flowfileOutboundPolicy(ProcessGroupDTO.FlowfileOutboundPolicyEnum flowfileOutboundPolicy) -
getFlowfileOutboundPolicy
The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.- Returns:
- flowfileOutboundPolicy
-
setFlowfileOutboundPolicy
public void setFlowfileOutboundPolicy(ProcessGroupDTO.FlowfileOutboundPolicyEnum flowfileOutboundPolicy) -
defaultFlowFileExpiration
-
getDefaultFlowFileExpiration
The default FlowFile Expiration for this Process Group.- Returns:
- defaultFlowFileExpiration
-
setDefaultFlowFileExpiration
-
defaultBackPressureObjectThreshold
-
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
-
defaultBackPressureDataSizeThreshold
public ProcessGroupDTO defaultBackPressureDataSizeThreshold(String defaultBackPressureDataSizeThreshold) -
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
-
logFileSuffix
-
getLogFileSuffix
The log file suffix for this Process Group for dedicated logging.- Returns:
- logFileSuffix
-
setLogFileSuffix
-
executionEngine
-
getExecutionEngine
The Execution Engine that should be used to run the flow represented by this Process Group.- Returns:
- executionEngine
-
setExecutionEngine
-
maxConcurrentTasks
-
getMaxConcurrentTasks
The maximum number of concurrent tasks to use when running the flow using the Stateless Engine- Returns:
- maxConcurrentTasks
-
setMaxConcurrentTasks
-
statelessFlowTimeout
-
getStatelessFlowTimeout
The maximum amount of time that the flow can be run using the Stateless Engine before the flow times out- Returns:
- statelessFlowTimeout
-
setStatelessFlowTimeout
-
runningCount
-
getRunningCount
The number of running components in this process group.- Returns:
- runningCount
-
setRunningCount
-
stoppedCount
-
getStoppedCount
The number of stopped components in the process group.- Returns:
- stoppedCount
-
setStoppedCount
-
invalidCount
-
getInvalidCount
The number of invalid components in the process group.- Returns:
- invalidCount
-
setInvalidCount
-
disabledCount
-
getDisabledCount
The number of disabled components in the process group.- Returns:
- disabledCount
-
setDisabledCount
-
activeRemotePortCount
-
getActiveRemotePortCount
The number of active remote ports in the process group.- Returns:
- activeRemotePortCount
-
setActiveRemotePortCount
-
inactiveRemotePortCount
-
getInactiveRemotePortCount
The number of inactive remote ports in the process group.- Returns:
- inactiveRemotePortCount
-
setInactiveRemotePortCount
-
upToDateCount
-
getUpToDateCount
The number of up to date versioned process groups in the process group.- Returns:
- upToDateCount
-
setUpToDateCount
-
locallyModifiedCount
-
getLocallyModifiedCount
The number of locally modified versioned process groups in the process group.- Returns:
- locallyModifiedCount
-
setLocallyModifiedCount
-
staleCount
-
getStaleCount
The number of stale versioned process groups in the process group.- Returns:
- staleCount
-
setStaleCount
-
locallyModifiedAndStaleCount
-
getLocallyModifiedAndStaleCount
The number of locally modified and stale versioned process groups in the process group.- Returns:
- locallyModifiedAndStaleCount
-
setLocallyModifiedAndStaleCount
-
syncFailureCount
-
getSyncFailureCount
The number of versioned process groups in the process group that are unable to sync to a registry.- Returns:
- syncFailureCount
-
setSyncFailureCount
-
localInputPortCount
-
getLocalInputPortCount
The number of local input ports in the process group.- Returns:
- localInputPortCount
-
setLocalInputPortCount
-
localOutputPortCount
-
getLocalOutputPortCount
The number of local output ports in the process group.- Returns:
- localOutputPortCount
-
setLocalOutputPortCount
-
publicInputPortCount
-
getPublicInputPortCount
The number of public input ports in the process group.- Returns:
- publicInputPortCount
-
setPublicInputPortCount
-
publicOutputPortCount
-
getPublicOutputPortCount
The number of public output ports in the process group.- Returns:
- publicOutputPortCount
-
setPublicOutputPortCount
-
statelessGroupScheduledState
public ProcessGroupDTO statelessGroupScheduledState(ProcessGroupDTO.StatelessGroupScheduledStateEnum statelessGroupScheduledState) -
getStatelessGroupScheduledState
If the Process Group is configured to run in using the Stateless Engine, represents the current state. Otherwise, will be STOPPED.- Returns:
- statelessGroupScheduledState
-
setStatelessGroupScheduledState
public void setStatelessGroupScheduledState(ProcessGroupDTO.StatelessGroupScheduledStateEnum statelessGroupScheduledState) -
contents
-
getContents
Get contents- Returns:
- contents
-
setContents
-
getInputPortCount
The number of input ports in the process group.- Returns:
- inputPortCount
-
getOutputPortCount
The number of output ports in the process group.- Returns:
- outputPortCount
-
equals
-
hashCode
public int hashCode() -
toString
-
toIndentedString
Convert the given object to string with each line indented by 4 spaces (except the first line).
-