org.apache.nifi.web.api.dto.status

Class ComponentStatusDTO

java.lang.Object

org.apache.nifi.web.api.dto.status.ComponentStatusDTO

Direct Known Subclasses:

ControllerServiceStatusDTO, ReportingTaskStatusDTO

public class ComponentStatusDTO
extends Object

General DTO for serializing the status of a component. This DTO is used to expose component status to API clients. This DTO must NOT contain any sensitive information as it can be returned to API clients regardless of having READ privilege to the component.

Field Summary

Fields

Modifier and Type	Field and Description
private Integer	activeThreadCount
static String	INVALID
private String	runStatus
static String	VALID
static String	VALIDATING
private String	validationStatus

Constructor Summary

Constructors

Constructor and Description
ComponentStatusDTO()

Method Summary

Modifier and Type	Method and Description
Integer	getActiveThreadCount()
String	getRunStatus() Sub-classes should override this method to provide API documentation using ApiModelProperty annotation with allowable values.
String	getValidationStatus()
void	setActiveThreadCount(Integer activeThreadCount)
void	setRunStatus(String runStatus)
void	setValidationStatus(String validationStatus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALID

public static final String VALID

See Also:

Constant Field Values

INVALID

public static final String INVALID

See Also:

Constant Field Values

VALIDATING

public static final String VALIDATING

See Also:

Constant Field Values

runStatus

private String runStatus

validationStatus

private String validationStatus

activeThreadCount

private Integer activeThreadCount

Constructor Detail

ComponentStatusDTO

public ComponentStatusDTO()

Method Detail

getRunStatus

public String getRunStatus()

Sub-classes should override this method to provide API documentation using ApiModelProperty annotation with allowable values.

Returns:

the run status of the component

setRunStatus

public void setRunStatus(String runStatus)

getValidationStatus

public String getValidationStatus()

setValidationStatus

public void setValidationStatus(String validationStatus)

getActiveThreadCount

public Integer getActiveThreadCount()

Returns:

number of active threads for this component

setActiveThreadCount

public void setActiveThreadCount(Integer activeThreadCount)