Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-292: Merging NIFI-292 into develop

This commit is contained in:
Matt Gilman 2015-05-01 16:42:44 -04:00
parent a69ed6bae9
commit 997ed94653
132 changed files with 7202 additions and 805 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
nifi/nifi-assembly/NOTICE
View File

@ -467,13 +467,10 @@ The following binary components are provided under the Apache Software License v
Apache Geronimo
Copyright 2003-2008 The Apache Software Foundation
(ASLv2) Enunciate Core Annotations (org.codehaus.enunciate:enunciate-core-annotations:jar:1.28 - http://dist.codehaus.org/enunciate/enunciate-1.28.zip)
(ASLv2) Swagger Core
The following NOTICE information applies:
This product includes software developed by the Spring Framework
Project (http://www.springframework.org).
This product includes software developed by the
Visigoth Software Society (http://www.visigoths.org/).
Swagger Core 1.5.3-M1
Copyright 2015 Reverb Technologies, Inc.
(ASLv2) JSON-SMART
The following NOTICE information applies:
@ -584,7 +581,6 @@ The following binary components are provided under the Common Development and Di
(CDDL 1.0) (GPL3) Streaming API For XML (javax.xml.stream:stax-api:jar:1.0-2 - no url provided)
(CDDL 1.0) JavaBeans Activation Framework (JAF) (javax.activation:activation:jar:1.1 - http://java.sun.com/products/javabeans/jaf/index.jsp)
(CDDL 1.0) JavaServer Pages(TM) API (javax.servlet.jsp:jsp-api:jar:2.1 - http://jsp.java.net)
(CDDL 1.0) SR 250 Common Annotations For The JavaTM Platform (javax.annotation:jsr250-api:jar:1.0 - http://jcp.org/aboutJava/communityprocess/final/jsr250/index.html)
************************
Creative Commons Attribution-ShareAlike 3.0

5
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework-nar/src/main/resources/META-INF/NOTICE
View File

@ -90,6 +90,11 @@ The following binary components are provided under the Apache Software License v
Spring Framework 4.1.4.RELEASE
Copyright (c) 2002-2014 Pivotal, Inc.
(ASLv2) Swagger Core
The following NOTICE information applies:
Swagger Core 1.5.3-M1
Copyright 2015 Reverb Technologies, Inc.
************************
Common Development and Distribution License 1.1
************************

26
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/pom.xml
View File

@ -21,24 +21,10 @@
<version>0.1.0-incubating-SNAPSHOT</version>
</parent>
<artifactId>nifi-client-dto</artifactId>
<build>
<plugins>
<!--
Always attach sources so the enunciate documentation
is complete.
-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-annotations</artifactId>
</dependency>
</dependencies>
</project>

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/AboutDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -33,6 +34,9 @@ public class AboutDTO {
*
* @return The title
*/
@ApiModelProperty(
value = "The title to be used on the page and in the about dialog."
)
public String getTitle() {
return title;
}
@ -46,6 +50,9 @@ public class AboutDTO {
*
* @return The version.
*/
@ApiModelProperty(
value = "The version of this NiFi."
)
public String getVersion() {
return version;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BannerDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -33,6 +34,9 @@ public class BannerDTO {
*
* @return The footer text
*/
@ApiModelProperty(
value = "The footer text."
)
public String getFooterText() {
return footerText;
}
@ -46,6 +50,9 @@ public class BannerDTO {
*
* @return The header text
*/
@ApiModelProperty(
value = "The header text."
)
public String getHeaderText() {
return headerText;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.List;
@ -35,6 +36,9 @@ public class BulletinBoardDTO {
/**
* @return bulletins to populate in the bulletin board
*/
@ApiModelProperty(
value = "The bulletins in the bulletin board, that matches the supplied request."
)
public List<BulletinDTO> getBulletins() {
return bulletins;
}
@ -47,6 +51,9 @@ public class BulletinBoardDTO {
* @return when this bulletin board was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when this report was generated."
)
public Date getGenerated() {
return generated;
}

28
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -40,6 +41,9 @@ public class BulletinDTO {
/**
* @return id of this message
*/
@ApiModelProperty(
value = "The id of the bulletin."
)
public Long getId() {
return id;
}
@ -51,6 +55,9 @@ public class BulletinDTO {
/**
* @return When clustered, the address of the node from which this bulletin originated
*/
@ApiModelProperty(
value = "If clustered, the address of the node from whicih the bulletin originated."
)
public String getNodeAddress() {
return nodeAddress;
}
@ -62,6 +69,9 @@ public class BulletinDTO {
/**
* @return group id of the source component
*/
@ApiModelProperty(
value = "The group id of the source component."
)
public String getGroupId() {
return groupId;
}
@ -73,6 +83,9 @@ public class BulletinDTO {
/**
* @return category of this message
*/
@ApiModelProperty(
value = "The catagory of this bulletin."
)
public String getCategory() {
return category;
}
@ -84,6 +97,9 @@ public class BulletinDTO {
/**
* @return actual message
*/
@ApiModelProperty(
value = "The bulletin message."
)
public String getMessage() {
return message;
}
@ -95,6 +111,9 @@ public class BulletinDTO {
/**
* @return id of the source of this message
*/
@ApiModelProperty(
value = "The id of the source component."
)
public String getSourceId() {
return sourceId;
}
@ -106,6 +125,9 @@ public class BulletinDTO {
/**
* @return name of the source of this message
*/
@ApiModelProperty(
value = "The name of the source component."
)
public String getSourceName() {
return sourceName;
}
@ -117,6 +139,9 @@ public class BulletinDTO {
/**
* @return level of this bulletin
*/
@ApiModelProperty(
value = "The level of the bulletin."
)
public String getLevel() {
return level;
}
@ -129,6 +154,9 @@ public class BulletinDTO {
* @return When this bulletin was generated as a formatted string
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "When this bulletin was generated."
)
public Date getTimestamp() {
return timestamp;
}

20
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -34,6 +35,10 @@ public class BulletinQueryDTO {
/**
* @return Include bulletins after this id
*/
@ApiModelProperty(
value = "Will include bulletins that occurred after this id. The ids are a one-up number that are used to ensure bulletins that "
+ "occur at the same time will not be missed."
)
public Long getAfter() {
return after;
}
@ -45,6 +50,9 @@ public class BulletinQueryDTO {
/**
* @return Include bulletin within this group. Supports a regular expression
*/
@ApiModelProperty(
value = "Will include bulletins that occurred within this group. Supports a regular expression."
)
public String getGroupId() {
return groupId;
}
@ -56,6 +64,9 @@ public class BulletinQueryDTO {
/**
* @return Include bulletins that match this message. Supports a regular expression
*/
@ApiModelProperty(
value = "Will include bulletins that match this message. Supports a regular expression."
)
public String getMessage() {
return message;
}
@ -67,6 +78,9 @@ public class BulletinQueryDTO {
/**
* @return Include bulletins that match this name. Supports a regular expression
*/
@ApiModelProperty(
value = "Will include bulletins that match this name. Supports a regular expression."
)
public String getName() {
return name;
}
@ -78,6 +92,9 @@ public class BulletinQueryDTO {
/**
* @return Include bulletins that match this id. Supports a source id
*/
@ApiModelProperty(
value = "Will include bulletins from components that match this id. Supports a regular expression."
)
public String getSourceId() {
return sourceId;
}
@ -89,6 +106,9 @@ public class BulletinQueryDTO {
/**
* @return The maximum number of bulletins to return
*/
@ApiModelProperty(
value = "The maximum number of bulletins to return."
)
public Integer getLimit() {
return limit;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ClusterDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
@ -35,6 +36,9 @@ public class ClusterDTO {
/**
* @return collection of the node DTOs
*/
@ApiModelProperty(
value = "The collection of nodes that are part of the cluster."
)
public Collection<NodeDTO> getNodes() {
return nodes;
}
@ -47,6 +51,9 @@ public class ClusterDTO {
* @return the date/time that this report was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The timestamp the report was generated."
)
public Date getGenerated() {
return generated;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ComponentHistoryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Map;
import javax.xml.bind.annotation.XmlType;
@ -31,6 +32,9 @@ public class ComponentHistoryDTO {
/**
* @return component id
*/
@ApiModelProperty(
value = "The component id."
)
public String getComponentId() {
return componentId;
}
@ -42,6 +46,9 @@ public class ComponentHistoryDTO {
/**
* @return history for this components properties
*/
@ApiModelProperty(
value = "The history for the properties of the component."
)
public Map<String, PropertyHistoryDTO> getPropertyHistory() {
return propertyHistory;
}

29
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -36,6 +37,10 @@ public class ConnectableDTO {
/**
* @return id of this connectable component
*/
@ApiModelProperty(
value = "The id of the connectable component.",
required = true
)
public String getId() {
return id;
}
@ -47,6 +52,11 @@ public class ConnectableDTO {
/**
* @return type of this connectable component
*/
@ApiModelProperty(
value = "The type of component the connectable is.",
required = true,
allowableValues = "PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL"
)
public String getType() {
return type;
}
@ -58,6 +68,10 @@ public class ConnectableDTO {
/**
* @return id of the group that this connectable component resides in
*/
@ApiModelProperty(
value = "The id of the group that the connectable component resides in",
required = true
)
public String getGroupId() {
return groupId;
}
@ -69,6 +83,9 @@ public class ConnectableDTO {
/**
* @return name of this connectable component
*/
@ApiModelProperty(
value = "The name of the connectable component"
)
public String getName() {
return name;
}
@ -80,6 +97,9 @@ public class ConnectableDTO {
/**
* @return Used to reflect the current state of this Connectable
*/
@ApiModelProperty(
value = "Reflects the current state of the connectable component."
)
public Boolean isRunning() {
return running;
}
@ -91,6 +111,9 @@ public class ConnectableDTO {
/**
* @return If this represents a remote port it is used to indicate whether the target exists
*/
@ApiModelProperty(
value = "If the connectable component represents a remote port, indicates if the target exists."
)
public Boolean getExists() {
return exists;
}
@ -102,6 +125,9 @@ public class ConnectableDTO {
/**
* @return If this represents a remote port it is used to indicate whether is it configured to transmit
*/
@ApiModelProperty(
value = "If the connectable component represents a remote port, indicates if the target is configured to transmit."
)
public Boolean getTransmitting() {
return transmitting;
}
@ -113,6 +139,9 @@ public class ConnectableDTO {
/**
* @return The comments from this Connectable
*/
@ApiModelProperty(
value = "The comments for the connectable component."
)
public String getComments() {
return comments;
}

51
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -41,10 +42,13 @@ public class ConnectionDTO extends NiFiComponentDTO {
private List<PositionDTO> bends;
/**
* The id of the source processor.
* The source of this connection.
*
* @return The id of the source processor
* @return The source of this connection
*/
@ApiModelProperty(
value = "The source of the connection."
)
public ConnectableDTO getSource() {
return source;
}
@ -54,10 +58,13 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
* The id of the target processor.
* The destination of this connection.
*
* @return The id of the target processor
* @return The destination of this connection
*/
@ApiModelProperty(
value = "The destination of the connection."
)
public ConnectableDTO getDestination() {
return destination;
}
@ -69,6 +76,9 @@ public class ConnectionDTO extends NiFiComponentDTO {
/**
* @return name of the connection
*/
@ApiModelProperty(
value = "The name of the connection."
)
public String getName() {
return name;
}
@ -80,6 +90,9 @@ public class ConnectionDTO extends NiFiComponentDTO {
/**
* @return position of the bend points on this connection
*/
@ApiModelProperty(
value = "The bend points on the connection."
)
public List<PositionDTO> getBends() {
return bends;
}
@ -91,6 +104,9 @@ public class ConnectionDTO extends NiFiComponentDTO {
/**
* @return The index of control point that the connection label should be placed over
*/
@ApiModelProperty(
value = "The index of the bend point where to place the connection label."
)
public Integer getLabelIndex() {
return labelIndex;
}
@ -102,6 +118,9 @@ public class ConnectionDTO extends NiFiComponentDTO {
/**
* @return z index for this connection
*/
@ApiModelProperty(
value = "The z index of the connection."
)
public Long getzIndex() {
return zIndex;
}
@ -115,6 +134,9 @@ public class ConnectionDTO extends NiFiComponentDTO {
*
* @return The relationships
*/
@ApiModelProperty(
value = "The selected relationship that comprise the connection."
)
public Set<String> getSelectedRelationships() {
return selectedRelationships;
}
@ -126,6 +148,10 @@ public class ConnectionDTO extends NiFiComponentDTO {
/**
* @return relationships that the source of the connection currently supports. This property is read only
*/
@ApiModelProperty(
value = "The relationships that the source of the connection currently supports. This property is read only.",
readOnly = true
)
public Set<String> getAvailableRelationships() {
return availableRelationships;
}
@ -140,6 +166,10 @@ public class ConnectionDTO extends NiFiComponentDTO {
*
* @return The back pressure object threshold
*/
@ApiModelProperty(
value = "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."
)
public Long getBackPressureObjectThreshold() {
return backPressureObjectThreshold;
}
@ -154,6 +184,10 @@ public class ConnectionDTO extends NiFiComponentDTO {
*
* @return The back pressure data size threshold
*/
@ApiModelProperty(
value = "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."
)
public String getBackPressureDataSizeThreshold() {
return backPressureDataSizeThreshold;
}
@ -168,6 +202,10 @@ public class ConnectionDTO extends NiFiComponentDTO {
*
* @return The flow file expiration in minutes
*/
@ApiModelProperty(
value = "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."
)
public String getFlowFileExpiration() {
return flowFileExpiration;
}
@ -177,10 +215,13 @@ public class ConnectionDTO extends NiFiComponentDTO {
}
/**
* The prioritizers this processor is using.
* The prioritizers this connection is using.
*
* @return The prioritizer list
*/
@ApiModelProperty(
value = "The comparators used to prioritize the queue."
)
public List<String> getPrioritizers() {
return prioritizers;
}

33
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -44,6 +45,9 @@ public class ControllerConfigurationDTO {
/**
* @return maximum number of timer driven threads this NiFi has available
*/
@ApiModelProperty(
value = "The maimum number of timer driven threads the NiFi has available."
)
public Integer getMaxTimerDrivenThreadCount() {
return maxTimerDrivenThreadCount;
}
@ -55,6 +59,9 @@ public class ControllerConfigurationDTO {
/**
* @return maximum number of event driven thread this NiFi has available
*/
@ApiModelProperty(
value = "The maximum number of event driven threads the NiFi has avaiable."
)
public Integer getMaxEventDrivenThreadCount() {
return maxEventDrivenThreadCount;
}
@ -66,6 +73,9 @@ public class ControllerConfigurationDTO {
/**
* @return name of this NiFi
*/
@ApiModelProperty(
value = "The name of this NiFi."
)
public String getName() {
return name;
}
@ -77,6 +87,9 @@ public class ControllerConfigurationDTO {
/**
* @return comments for this NiFi
*/
@ApiModelProperty(
value = "The comments for this NiFi."
)
public String getComments() {
return comments;
}
@ -88,6 +101,10 @@ public class ControllerConfigurationDTO {
/**
* @return interval in seconds between the automatic NiFi refresh requests. This value is read only
*/
@ApiModelProperty(
value = "The interval in seconds between the automatic NiFi refresh requests.",
readOnly = true
)
public Long getAutoRefreshIntervalSeconds() {
return autoRefreshIntervalSeconds;
}
@ -99,6 +116,10 @@ public class ControllerConfigurationDTO {
/**
* @return Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). This value is read only
*/
@ApiModelProperty(
value = "Indicates whether site to site communication with the NiFi is secure (requires 2-way authenticiation).",
readOnly = true
)
public Boolean isSiteToSiteSecure() {
return siteToSiteSecure;
}
@ -111,6 +132,9 @@ public class ControllerConfigurationDTO {
* @return current time on the server
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The current time on the system."
)
public Date getCurrentTime() {
return currentTime;
}
@ -122,6 +146,9 @@ public class ControllerConfigurationDTO {
/**
* @return time offset of the server
*/
@ApiModelProperty(
value = "The time offset of the system."
)
public Integer getTimeOffset() {
return timeOffset;
}
@ -133,6 +160,9 @@ public class ControllerConfigurationDTO {
/**
* @return the URL for the content viewer if configured
*/
@ApiModelProperty(
value = "The URL for the content viewer if configured."
)
public String getContentViewerUrl() {
return contentViewerUrl;
}
@ -144,6 +174,9 @@ public class ControllerConfigurationDTO {
/**
* @return URI for this NiFi controller
*/
@ApiModelProperty(
value = "The URI for the NiFi."
)
public String getUri() {
return uri;
}

50
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -48,6 +49,9 @@ public class ControllerDTO {
/**
* @return id of this NiFi controller
*/
@ApiModelProperty(
value = "The id of the NiFi."
)
public String getId() {
return id;
}
@ -61,6 +65,9 @@ public class ControllerDTO {
*
* @return The name of this controller
*/
@ApiModelProperty(
value = "The name of the NiFi."
)
public String getName() {
return name;
}
@ -72,6 +79,9 @@ public class ControllerDTO {
/**
* @return comments of this NiFi controller
*/
@ApiModelProperty(
value = "The comments for the NiFi."
)
public String getComments() {
return comments;
}
@ -83,6 +93,9 @@ public class ControllerDTO {
/**
* @return input ports available to send data to this NiFi controller
*/
@ApiModelProperty(
value = "The input ports available to send data to for the NiFi."
)
public Set<PortDTO> getInputPorts() {
return inputPorts;
}
@ -94,6 +107,9 @@ public class ControllerDTO {
/**
* @return output ports available to received data from this NiFi controller
*/
@ApiModelProperty(
value = "The output ports available to received data from the NiFi."
)
public Set<PortDTO> getOutputPorts() {
return outputPorts;
}
@ -105,6 +121,9 @@ public class ControllerDTO {
/**
* @return Instance ID of the cluster, if this node is connected to a Cluster Manager, or of this individual instance of in standalone mode
*/
@ApiModelProperty(
value = "If clustered, the id of the Cluster Manager, otherwise the id of the NiFi."
)
public String getInstanceId() {
return instanceId;
}
@ -118,6 +137,10 @@ public class ControllerDTO {
*
* @return a integer between 1 and 65535, or null, if not configured for remote transfer
*/
@ApiModelProperty(
value = "The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote "
+ "instances, this will be null."
)
public Integer getRemoteSiteListeningPort() {
return remoteSiteListeningPort;
}
@ -129,6 +152,9 @@ public class ControllerDTO {
/**
* @return Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)
*/
@ApiModelProperty(
value = "Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)."
)
public Boolean isSiteToSiteSecure() {
return siteToSiteSecure;
}
@ -140,6 +166,9 @@ public class ControllerDTO {
/**
* @return number of running components in this process group
*/
@ApiModelProperty(
value = "The number of running components in the NiFi."
)
public Integer getRunningCount() {
return runningCount;
}
@ -151,6 +180,9 @@ public class ControllerDTO {
/**
* @return number of stopped components in this process group
*/
@ApiModelProperty(
value = "The number of stopped components in the NiFi."
)
public Integer getStoppedCount() {
return stoppedCount;
}
@ -162,6 +194,9 @@ public class ControllerDTO {
/**
* @return number of active remote ports contained in this process group
*/
@ApiModelProperty(
value = "The number of active remote ports contained in the NiFi."
)
public Integer getActiveRemotePortCount() {
return activeRemotePortCount;
}
@ -173,6 +208,9 @@ public class ControllerDTO {
/**
* @return number of inactive remote ports contained in this process group
*/
@ApiModelProperty(
value = "The number of inactive remote porst contained in the NiFi."
)
public Integer getInactiveRemotePortCount() {
return inactiveRemotePortCount;
}
@ -184,6 +222,9 @@ public class ControllerDTO {
/**
* @return number of input ports contained in this process group
*/
@ApiModelProperty(
value = "The number of input ports contained in the NiFi."
)
public Integer getInputPortCount() {
return inputPortCount;
}
@ -195,6 +236,9 @@ public class ControllerDTO {
/**
* @return number of invalid components in this process group
*/
@ApiModelProperty(
value = "The number of invalid components in the NiFi."
)
public Integer getInvalidCount() {
return invalidCount;
}
@ -206,6 +250,9 @@ public class ControllerDTO {
/**
* @return number of disabled components in this process group
*/
@ApiModelProperty(
value = "The number of disabled components in the NiFi."
)
public Integer getDisabledCount() {
return disabledCount;
}
@ -217,6 +264,9 @@ public class ControllerDTO {
/**
* @return number of output ports in this process group
*/
@ApiModelProperty(
value = "The number of output ports in the NiFi."
)
public Integer getOutputPortCount() {
return outputPortCount;
}

36
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
@ -46,6 +47,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return controller service name
*/
@ApiModelProperty(
value = "The name of the controller service."
)
public String getName() {
return name;
}
@ -57,6 +61,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return the controller service type
*/
@ApiModelProperty(
value = "The type of the controller service."
)
public String getType() {
return type;
}
@ -68,6 +75,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return the comment for the Controller Service
*/
@ApiModelProperty(
value = "The comments for the controller service."
)
public String getComments() {
return comments;
}
@ -79,6 +89,10 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return Where this service is available. Possible values are NCM, NODE
*/
@ApiModelProperty(
value = "Where the servcie is available.",
allowableValues = "NCM, NODE"
)
public String getAvailability() {
return availability;
}
@ -90,6 +104,10 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return The state of this controller service. Possible values are ENABLED, ENABLING, DISABLED, DISABLING
*/
@ApiModelProperty(
value = "The state of the controller service.",
allowableValues = "ENABLED, ENABLING, DISABLED, DISABLING"
)
public String getState() {
return state;
}
@ -101,6 +119,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return controller service properties
*/
@ApiModelProperty(
value = "The properties of the controller service."
)
public Map<String, String> getProperties() {
return properties;
}
@ -112,6 +133,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return descriptors for the controller service properties
*/
@ApiModelProperty(
value = "The descriptors for the controller service properties."
)
public Map<String, PropertyDescriptorDTO> getDescriptors() {
return descriptors;
}
@ -123,6 +147,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return the URL for this controller services custom configuration UI if applicable. Null otherwise
*/
@ApiModelProperty(
value = "The URL for the controller services custom configuration UI if applicable."
)
public String getCustomUiUrl() {
return customUiUrl;
}
@ -134,6 +161,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return annotation data for this controller service
*/
@ApiModelProperty(
value = "The annontation for the controller service. This is how the custom UI relays configuration to the controller service."
)
public String getAnnotationData() {
return annotationData;
}
@ -145,6 +175,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
/**
* @return all components referencing this controller service
*/
@ApiModelProperty(
value = "All components referencing this controller service."
)
public Set<ControllerServiceReferencingComponentDTO> getReferencingComponents() {
return referencingComponents;
}
@ -158,6 +191,9 @@ public class ControllerServiceDTO extends NiFiComponentDTO {
*
* @return The validation errors
*/
@ApiModelProperty(
value = "The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled."
)
public Collection<String> getValidationErrors() {
return validationErrors;
}

40
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
@ -47,6 +48,10 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return Group id for this component referencing a controller service. If this component is another service, this field is blank
*/
@ApiModelProperty(
value = "The group id for the component referencing a controller service. If this component is another controller service or a reporting "
+ "task, this field is blank."
)
public String getGroupId() {
return groupId;
}
@ -58,6 +63,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return id for this component referencing a controller service
*/
@ApiModelProperty(
value = "The id of the component referencing a controller service."
)
public String getId() {
return id;
}
@ -69,6 +77,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return name for this component referencing a controller service
*/
@ApiModelProperty(
value = "The name of the component referencing a controller service."
)
public String getName() {
return name;
}
@ -80,6 +91,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return type for this component referencing a controller service
*/
@ApiModelProperty(
value = "The type of the component referencing a controller service."
)
public String getType() {
return type;
}
@ -91,6 +105,10 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return state of the processor referencing a controller service. If this component is another service, this field is blank
*/
@ApiModelProperty(
value = "The state of a processor or reporting task referencing a controller service. If this component is another controller "
+ "service, this field is blank."
)
public String getState() {
return state;
}
@ -102,6 +120,10 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return type of reference this is (Processor, ControllerService, or ReportingTask)
*/
@ApiModelProperty(
value = "The type of reference this is.",
allowableValues = "Processor, ControllerService, or ReportingTask"
)
public String getReferenceType() {
return referenceType;
}
@ -113,6 +135,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return component properties
*/
@ApiModelProperty(
value = "The properties for the component."
)
public Map<String, String> getProperties() {
return properties;
}
@ -124,6 +149,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return descriptors for the components properties
*/
@ApiModelProperty(
value = "The descriptors for the componet properties."
)
public Map<String, PropertyDescriptorDTO> getDescriptors() {
return descriptors;
}
@ -135,6 +163,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return Any validation error associated with this component
*/
@ApiModelProperty(
value = "The validation errors for the component."
)
public Collection<String> getValidationErrors() {
return validationErrors;
}
@ -146,6 +177,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return active thread count for the referencing component
*/
@ApiModelProperty(
value = "The number of active threads for the referencing component."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -157,6 +191,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return If this referencing component represents a ControllerService, these are the components that reference it
*/
@ApiModelProperty(
value = "If the referencing component represents a controller service, these are the components that referenc it."
)
public Set<ControllerServiceReferencingComponentDTO> getReferencingComponents() {
return referencingComponents;
}
@ -168,6 +205,9 @@ public class ControllerServiceReferencingComponentDTO {
/**
* @return If this referencing component represents a ControllerService, this indicates whether it has already been represented in this hierarchy
*/
@ApiModelProperty(
value = "If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy."
)
public Boolean getReferenceCycle() {
return referenceCycle;
}

16
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -33,6 +34,9 @@ public class CounterDTO {
/**
* @return context of the counter
*/
@ApiModelProperty(
value = "The context of the counter."
)
public String getContext() {
return context;
}
@ -44,6 +48,9 @@ public class CounterDTO {
/**
* @return id of the counter
*/
@ApiModelProperty(
value = "The id of the counter."
)
public String getId() {
return id;
}
@ -55,6 +62,9 @@ public class CounterDTO {
/**
* @return name of the counter
*/
@ApiModelProperty(
value = "The name of the counter."
)
public String getName() {
return name;
}
@ -66,6 +76,9 @@ public class CounterDTO {
/**
* @return value for the counter
*/
@ApiModelProperty(
value = "The value of the counter."
)
public String getValue() {
return value;
}
@ -74,6 +87,9 @@ public class CounterDTO {
this.value = value;
}
@ApiModelProperty(
value = "The value count."
)
public Long getValueCount() {
return valueCount;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CountersDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
@ -35,6 +36,9 @@ public class CountersDTO {
/**
* @return the collection of counters
*/
@ApiModelProperty(
value = "All counters in the NiFi."
)
public Collection<CounterDTO> getCounters() {
return counters;
}
@ -47,6 +51,9 @@ public class CountersDTO {
* @return the date/time that this report was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when the report was generated."
)
public Date getGenerated() {
return generated;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/DocumentedTypeDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -32,6 +33,9 @@ public class DocumentedTypeDTO {
/**
* @return An optional description of the corresponding type
*/
@ApiModelProperty(
value = "The description of the type."
)
public String getDescription() {
return description;
}
@ -43,6 +47,9 @@ public class DocumentedTypeDTO {
/**
* @return The type is the fully-qualified name of a Java class
*/
@ApiModelProperty(
value = "The fulley qualified name of the type."
)
public String getType() {
return type;
}
@ -54,6 +61,9 @@ public class DocumentedTypeDTO {
/**
* @return The tags associated with this type
*/
@ApiModelProperty(
value = "The tags associated with this type."
)
public Set<String> getTags() {
return tags;
}

28
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/FlowSnippetDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.LinkedHashSet;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -39,6 +40,9 @@ public class FlowSnippetDTO {
/**
* @return connections in this flow snippet
*/
@ApiModelProperty(
value = "The connections in this flow snippet."
)
public Set<ConnectionDTO> getConnections() {
return connections;
}
@ -50,6 +54,9 @@ public class FlowSnippetDTO {
/**
* @return input ports in this flow snippet
*/
@ApiModelProperty(
value = "The input ports in this flow snippet."
)
public Set<PortDTO> getInputPorts() {
return inputPorts;
}
@ -61,6 +68,9 @@ public class FlowSnippetDTO {
/**
* @return labels in this flow snippet
*/
@ApiModelProperty(
value = "The labels in this flow snippet."
)
public Set<LabelDTO> getLabels() {
return labels;
}
@ -72,6 +82,9 @@ public class FlowSnippetDTO {
/**
* @return funnels in this flow snippet
*/
@ApiModelProperty(
value = "The funnels in this flow snippet."
)
public Set<FunnelDTO> getFunnels() {
return funnels;
}
@ -83,6 +96,9 @@ public class FlowSnippetDTO {
/**
* @return output ports in this flow snippet
*/
@ApiModelProperty(
value = "The output ports in this flow snippet."
)
public Set<PortDTO> getOutputPorts() {
return outputPorts;
}
@ -94,6 +110,9 @@ public class FlowSnippetDTO {
/**
* @return process groups in this flow snippet
*/
@ApiModelProperty(
value = "The process groups in this flow snippet."
)
public Set<ProcessGroupDTO> getProcessGroups() {
return processGroups;
}
@ -105,6 +124,9 @@ public class FlowSnippetDTO {
/**
* @return processors in this flow group
*/
@ApiModelProperty(
value = "The processors in this flow snippet."
)
public Set<ProcessorDTO> getProcessors() {
return processors;
}
@ -116,6 +138,9 @@ public class FlowSnippetDTO {
/**
* @return remote process groups in this flow snippet
*/
@ApiModelProperty(
value = "The remote process groups in this flow snippet."
)
public Set<RemoteProcessGroupDTO> getRemoteProcessGroups() {
return remoteProcessGroups;
}
@ -127,6 +152,9 @@ public class FlowSnippetDTO {
/**
* @return the Controller Services in this flow snippet
*/
@ApiModelProperty(
value = "The controller services in this flow snippet."
)
public Set<ControllerServiceDTO> getControllerServices() {
return controllerServices;
}

15
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Map;
import javax.xml.bind.annotation.XmlType;
@ -32,7 +33,7 @@ public class LabelDTO extends NiFiComponentDTO {
private Double height;
// font-size = 12px
// color = #eee
// background-color = #eee
private Map<String, String> style;
public LabelDTO() {
@ -43,6 +44,9 @@ public class LabelDTO extends NiFiComponentDTO {
*
* @return The label text
*/
@ApiModelProperty(
value = "The text that appears in the label."
)
public String getLabel() {
return label;
}
@ -54,6 +58,9 @@ public class LabelDTO extends NiFiComponentDTO {
/**
* @return style for this label
*/
@ApiModelProperty(
value = "The styles for this label (font-size => 12px, background-color => #eee, etc)."
)
public Map<String, String> getStyle() {
return style;
}
@ -65,6 +72,9 @@ public class LabelDTO extends NiFiComponentDTO {
/**
* @return height of the label in pixels when at a 1:1 scale
*/
@ApiModelProperty(
value = "The height of the label in pixels when at a 1:1 scale."
)
public Double getHeight() {
return height;
}
@ -76,6 +86,9 @@ public class LabelDTO extends NiFiComponentDTO {
/**
* @return width of the label in pixels when at a 1:1 scale
*/
@ApiModelProperty(
value = "The width of the label in pixels when at a 1:1 scale."
)
public Double getWidth() {
return width;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -46,6 +47,9 @@ public class NiFiComponentDTO {
*
* @return The id
*/
@ApiModelProperty(
value = "The id of the component."
)
public String getId() {
return this.id;
}
@ -57,6 +61,9 @@ public class NiFiComponentDTO {
/**
* @return id for the parent group of this component if applicable, null otherwise
*/
@ApiModelProperty(
value = "The id of parent process group of this component if applicable."
)
public String getParentGroupId() {
return parentGroupId;
}
@ -70,6 +77,9 @@ public class NiFiComponentDTO {
*
* @return The uri
*/
@ApiModelProperty(
value = "The URI for futures requests to the component."
)
public String getUri() {
return uri;
}
@ -87,6 +97,9 @@ public class NiFiComponentDTO {
*
* @return The position
*/
@ApiModelProperty(
value = "The position of this component in the UI if applicable."
)
public PositionDTO getPosition() {
return position;
}

34
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -44,6 +45,9 @@ public class NodeDTO {
* @return node's last heartbeat timestamp
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "the time of the nodes's last heartbeat."
)
public Date getHeartbeat() {
return heartbeat;
}
@ -56,6 +60,9 @@ public class NodeDTO {
* @return time of the node's last connection request
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The time of the node's last connection request."
)
public Date getConnectionRequested() {
return connectionRequested;
}
@ -69,6 +76,9 @@ public class NodeDTO {
*
* @return The active thread count
*/
@ApiModelProperty(
value = "The active threads for the NiFi on the node."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -80,6 +90,9 @@ public class NodeDTO {
/**
* @return queue for the controller
*/
@ApiModelProperty(
value = "The queue the NiFi on the node."
)
public String getQueued() {
return queued;
}
@ -91,6 +104,9 @@ public class NodeDTO {
/**
* @return node's host/IP address
*/
@ApiModelProperty(
value = "The node's host/ip address."
)
public String getAddress() {
return address;
}
@ -102,6 +118,9 @@ public class NodeDTO {
/**
* @return node ID
*/
@ApiModelProperty(
value = "The id of the node."
)
public String getNodeId() {
return nodeId;
}
@ -113,6 +132,9 @@ public class NodeDTO {
/**
* @return port the node is listening for API requests
*/
@ApiModelProperty(
value = "The port the node is listening for API requests."
)
public Integer getApiPort() {
return apiPort;
}
@ -124,6 +146,9 @@ public class NodeDTO {
/**
* @return node's status
*/
@ApiModelProperty(
value = "The node's status."
)
public String getStatus() {
return status;
}
@ -135,6 +160,9 @@ public class NodeDTO {
/**
* @return node's events
*/
@ApiModelProperty(
value = "The node's events."
)
public List<NodeEventDTO> getEvents() {
return events;
}
@ -146,6 +174,9 @@ public class NodeDTO {
/**
* @return whether this node is the primary node within the cluster
*/
@ApiModelProperty(
value = "Whether the node is the primary node within the cluster."
)
public Boolean isPrimary() {
return primary;
}
@ -158,6 +189,9 @@ public class NodeDTO {
* @return time at which this Node was last restarted
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The time at which this Node was last refreshed."
)
public Date getNodeStartTime() {
return nodeStartTime;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeEventDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -34,6 +35,9 @@ public class NodeEventDTO {
/**
* @return category of the node event
*/
@ApiModelProperty(
value = "The category of the node event."
)
public String getCategory() {
return category;
}
@ -45,6 +49,9 @@ public class NodeEventDTO {
/**
* @return message of the node event
*/
@ApiModelProperty(
value = "The message in the node event."
)
public String getMessage() {
return message;
}
@ -57,6 +64,9 @@ public class NodeEventDTO {
* @return timestamp of the node event
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp of the node event."
)
public Date getTimestamp() {
return timestamp;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NodeSystemDiagnosticsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -30,6 +31,9 @@ public class NodeSystemDiagnosticsDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -41,6 +45,9 @@ public class NodeSystemDiagnosticsDTO {
/**
* @return the system diagnostics
*/
@ApiModelProperty(
value = "The diagnostics for the system the node is on."
)
public SystemDiagnosticsDTO getSystemDiagnostics() {
return systemDiagnostics;
}

30
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -40,6 +41,9 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return name of this port
*/
@ApiModelProperty(
value = "The name of the port."
)
public String getName() {
return name;
}
@ -51,6 +55,10 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return The state of this port. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED'
*/
@ApiModelProperty(
value = "The state of the port.",
allowableValues = "RUNNING, STOPPED, DISABLED"
)
public String getState() {
return state;
}
@ -64,6 +72,10 @@ public class PortDTO extends NiFiComponentDTO {
*
* @return The type of port
*/
@ApiModelProperty(
value = "The type of port.",
allowableValues = "INPUT_PORT, OUTPUT_PORT"
)
public String getType() {
return type;
}
@ -75,6 +87,9 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return number of tasks that should be concurrently scheduled for this port
*/
@ApiModelProperty(
value = "The number of tasks that should be concurrently scheduled for the port."
)
public Integer getConcurrentlySchedulableTaskCount() {
return concurrentlySchedulableTaskCount;
}
@ -86,6 +101,9 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return comments for this port
*/
@ApiModelProperty(
value = "The comments for the port."
)
public String getComments() {
return comments;
}
@ -97,6 +115,9 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return whether this port has incoming or outgoing connections to a remote NiFi. This is only applicable when the port is running on the root group
*/
@ApiModelProperty(
value = "Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is running in the root group."
)
public Boolean isTransmitting() {
return transmitting;
}
@ -108,6 +129,9 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return groups that are allowed to access this port
*/
@ApiModelProperty(
value = "The user groups that are allowed to access the port."
)
public Set<String> getGroupAccessControl() {
return groupAccessControl;
}
@ -119,6 +143,9 @@ public class PortDTO extends NiFiComponentDTO {
/**
* @return users that are allowed to access this port
*/
@ApiModelProperty(
value = "The users that are allowed to access the port."
)
public Set<String> getUserAccessControl() {
return userAccessControl;
}
@ -132,6 +159,9 @@ public class PortDTO extends NiFiComponentDTO {
*
* @return The validation errors
*/
@ApiModelProperty(
value = "Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started."
)
public Collection<String> getValidationErrors() {
return validationErrors;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PositionDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -39,6 +40,9 @@ public class PositionDTO {
/**
* @return the x coordinate
*/
@ApiModelProperty(
value = "The x coordinate."
)
public Double getX() {
return x;
}
@ -50,6 +54,9 @@ public class PositionDTO {
/**
* @return the y coordinate
*/
@ApiModelProperty(
value = "The y coordinate."
)
public Double getY() {
return y;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PreviousValueDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -34,6 +35,9 @@ public class PreviousValueDTO {
/**
* @return previous value
*/
@ApiModelProperty(
value = "The previous value."
)
public String getPreviousValue() {
return previousValue;
}
@ -46,6 +50,9 @@ public class PreviousValueDTO {
* @return when it was modified
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when the value was modified."
)
public Date getTimestamp() {
return timestamp;
}
@ -57,6 +64,9 @@ public class PreviousValueDTO {
/**
* @return user who changed the previous value
*/
@ApiModelProperty(
value = "The user who changed the previous value."
)
public String getUserName() {
return userName;
}

40
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -51,6 +52,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
*
* @return The name of this Process Group
*/
@ApiModelProperty(
value = "The name of the process group."
)
public String getName() {
return name;
}
@ -64,6 +68,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
*
* @return This Process Group's parent
*/
@ApiModelProperty(
value = "The part of the process group."
)
public ProcessGroupDTO getParent() {
return parent;
}
@ -75,6 +82,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return comments for this process group
*/
@ApiModelProperty(
value = "The comments for the process group."
)
public String getComments() {
return comments;
}
@ -86,6 +96,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return contents of this process group. This field will be populated if the request is marked verbose
*/
@ApiModelProperty(
value = "The contents of this process group. This field will be populated if the request is marked verbose."
)
public FlowSnippetDTO getContents() {
return contents;
}
@ -97,6 +110,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of input ports contained in this process group
*/
@ApiModelProperty(
value = "The number of input ports in the process group."
)
public Integer getInputPortCount() {
return inputPortCount;
}
@ -108,6 +124,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of invalid components in this process group
*/
@ApiModelProperty(
value = "The number of invalid components in the process group."
)
public Integer getInvalidCount() {
return invalidCount;
}
@ -119,6 +138,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of output ports in this process group
*/
@ApiModelProperty(
value = "The number of output ports in the process group."
)
public Integer getOutputPortCount() {
return outputPortCount;
}
@ -130,6 +152,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return Used in requests, indicates whether this process group should be running
*/
@ApiModelProperty(
value = "Used in requests, indicates whether the process group should be running."
)
public Boolean isRunning() {
return running;
}
@ -141,6 +166,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of running component in this process group
*/
@ApiModelProperty(
value = "The number of running componetns in this process group."
)
public Integer getRunningCount() {
return runningCount;
}
@ -152,6 +180,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of stopped components in this process group
*/
@ApiModelProperty(
value = "The number of stopped components in the process group."
)
public Integer getStoppedCount() {
return stoppedCount;
}
@ -163,6 +194,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of disabled components in this process group
*/
@ApiModelProperty(
value = "The number of disabled components in the process group."
)
public Integer getDisabledCount() {
return disabledCount;
}
@ -174,6 +208,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of active remote ports in this process group
*/
@ApiModelProperty(
value = "The number of active remote ports in the process group."
)
public Integer getActiveRemotePortCount() {
return activeRemotePortCount;
}
@ -185,6 +222,9 @@ public class ProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of inactive remote ports in this process group
*/
@ApiModelProperty(
value = "The number of inactive remote ports in the process group."
)
public Integer getInactiveRemotePortCount() {
return inactiveRemotePortCount;
}

53
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Map;
import java.util.Set;
@ -58,6 +59,9 @@ public class ProcessorConfigDTO {
*
* @return The scheduling period
*/
@ApiModelProperty(
value = "The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy."
)
public String getSchedulingPeriod() {
return schedulingPeriod;
}
@ -71,6 +75,9 @@ public class ProcessorConfigDTO {
*
* @return scheduling strategy
*/
@ApiModelProperty(
value = "Indcates whether the prcessor should be scheduled to run in event or timer driven mode."
)
public String getSchedulingStrategy() {
return schedulingStrategy;
}
@ -80,8 +87,11 @@ public class ProcessorConfigDTO {
}
/**
* @return the amount of time that is used when this processor penalizes a flow file
* @return the amount of time that is used when this processor penalizes a flowfile
*/
@ApiModelProperty(
value = "The amout of time that is used when the process penalizes a flowfile."
)
public String getPenaltyDuration() {
return penaltyDuration;
}
@ -91,8 +101,11 @@ public class ProcessorConfigDTO {
}
/**
* @return amount of time must elaspe before this processor is scheduled again when yielding
* @return amount of time must elapse before this processor is scheduled again when yielding
*/
@ApiModelProperty(
value = "The amount of time that must elapse before this processor is scheduled again after yielding."
)
public String getYieldDuration() {
return yieldDuration;
}
@ -104,6 +117,9 @@ public class ProcessorConfigDTO {
/**
* @return the level at this this processor will report bulletins
*/
@ApiModelProperty(
value = "The level at which the processor will report bulletins."
)
public String getBulletinLevel() {
return bulletinLevel;
}
@ -117,6 +133,9 @@ public class ProcessorConfigDTO {
*
* @return the concurrently schedulable task count
*/
@ApiModelProperty(
value = "The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored."
)
public Integer getConcurrentlySchedulableTaskCount() {
return concurrentlySchedulableTaskCount;
}
@ -128,6 +147,9 @@ public class ProcessorConfigDTO {
/**
* @return whether or not this Processor is Loss Tolerant
*/
@ApiModelProperty(
value = "Whether the processor is loss tolerant."
)
public Boolean isLossTolerant() {
return lossTolerant;
}
@ -139,6 +161,9 @@ public class ProcessorConfigDTO {
/**
* @return the comments
*/
@ApiModelProperty(
value = "The comments for the processor."
)
public String getComments() {
return comments;
}
@ -153,6 +178,9 @@ public class ProcessorConfigDTO {
*
* @return The optional properties
*/
@ApiModelProperty(
value = "The properties for the processor. Properties whose value is not set will only contain the property name."
)
public Map<String, String> getProperties() {
return properties;
}
@ -164,6 +192,9 @@ public class ProcessorConfigDTO {
/**
* @return descriptors for this processor's properties
*/
@ApiModelProperty(
value = "Descriptors for the processor's properties."
)
public Map<String, PropertyDescriptorDTO> getDescriptors() {
return descriptors;
}
@ -177,6 +208,9 @@ public class ProcessorConfigDTO {
*
* @return The annotation data
*/
@ApiModelProperty(
value = "The annotation data for the processor used to relay configuration between a custom UI and the procesosr."
)
public String getAnnotationData() {
return annotationData;
}
@ -188,6 +222,9 @@ public class ProcessorConfigDTO {
/**
* @return the URL for this processors custom configuration UI if applicable. Null otherwise.
*/
@ApiModelProperty(
value = "The URL for the processor's custom configuration UI if applicable."
)
public String getCustomUiUrl() {
return customUiUrl;
}
@ -199,6 +236,9 @@ public class ProcessorConfigDTO {
/**
* @return the names of all processor relationships that cause a flow file to be terminated if the relationship is not connected to anything
*/
@ApiModelProperty(
value = "The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere."
)
public Set<String> getAutoTerminatedRelationships() {
return autoTerminatedRelationships;
}
@ -210,6 +250,9 @@ public class ProcessorConfigDTO {
/**
* @return maps default values for concurrent tasks for each applicable scheduling strategy.
*/
@ApiModelProperty(
value = "Maps default values for concurrent tasks for each applicable scheduling strategy."
)
public Map<String, String> getDefaultConcurrentTasks() {
return defaultConcurrentTasks;
}
@ -221,6 +264,9 @@ public class ProcessorConfigDTO {
/**
* @return run duration in milliseconds
*/
@ApiModelProperty(
value = "The run duration for the processor in milliseconds."
)
public Long getRunDurationMillis() {
return runDurationMillis;
}
@ -232,6 +278,9 @@ public class ProcessorConfigDTO {
/**
* @return Maps default values for scheduling period for each applicable scheduling strategy
*/
@ApiModelProperty(
value = "Maps default values for scheduling period for each applicable scheduling strategy."
)
public Map<String, String> getDefaultSchedulingPeriod() {
return defaultSchedulingPeriod;
}

32
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.List;
import java.util.Map;
@ -49,6 +50,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
*
* @return This processors name
*/
@ApiModelProperty(
value = "The name of the processor."
)
public String getName() {
return name;
}
@ -62,6 +66,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
*
* @return This processors type
*/
@ApiModelProperty(
value = "The type of the processor."
)
public String getType() {
return type;
}
@ -73,6 +80,10 @@ public class ProcessorDTO extends NiFiComponentDTO {
/**
* @return The state of this processor. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED'
*/
@ApiModelProperty(
value = "The state of the processor",
allowableValues = "RUNNING, STOPPED, DISABLED"
)
public String getState() {
return state;
}
@ -84,6 +95,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
/**
* @return The styles for this processor. (Currently only supports color)
*/
@ApiModelProperty(
value = "Styles for the processor (background-color => #eee)."
)
public Map<String, String> getStyle() {
return style;
}
@ -95,6 +109,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
/**
* @return whether this processor supports parallel processing
*/
@ApiModelProperty(
value = "Whether the processor supports parallel processing."
)
public Boolean getSupportsParallelProcessing() {
return supportsParallelProcessing;
}
@ -106,6 +123,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
/**
* @return whether this processor supports event driven scheduling
*/
@ApiModelProperty(
value = "Whether the processor supports event driven scheduling."
)
public Boolean getSupportsEventDriven() {
return supportsEventDriven;
}
@ -119,6 +139,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
*
* @return The available relationships
*/
@ApiModelProperty(
value = "The available relationships that the processor currently supports."
)
public List<RelationshipDTO> getRelationships() {
return relationships;
}
@ -132,6 +155,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
*
* @return The processor configuration details
*/
@ApiModelProperty(
value = "The configuration details for the processor. These details will be included in a resopnse if the verbose flag is included in a request."
)
public ProcessorConfigDTO getConfig() {
return config;
}
@ -145,6 +171,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
*
* @return The validation errors
*/
@ApiModelProperty(
value = "The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started."
)
public Collection<String> getValidationErrors() {
return validationErrors;
}
@ -156,6 +185,9 @@ public class ProcessorDTO extends NiFiComponentDTO {
/**
* @return the description for this processor
*/
@ApiModelProperty(
value = "The description of the processor."
)
public String getDescription() {
return description;
}

40
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -39,6 +40,9 @@ public class PropertyDescriptorDTO {
/**
* @return set of allowable values for this property. If empty then the allowable values are not constrained
*/
@ApiModelProperty(
value = "Allowable values for the property. If empty then the allowed values are not constrained."
)
public List<AllowableValueDTO> getAllowableValues() {
return allowableValues;
}
@ -50,6 +54,9 @@ public class PropertyDescriptorDTO {
/**
* @return default value for this property
*/
@ApiModelProperty(
value = "The default value for the property."
)
public String getDefaultValue() {
return defaultValue;
}
@ -61,6 +68,9 @@ public class PropertyDescriptorDTO {
/**
* @return An explanation of the meaning of the given property. This description is meant to be displayed to a user or simply provide a mechanism of documenting intent
*/
@ApiModelProperty(
value = "The descriptoin for the property. Used to relay additional details to a user or provide a mechanism of documenting intent."
)
public String getDescription() {
return description;
}
@ -72,6 +82,9 @@ public class PropertyDescriptorDTO {
/**
* @return property name
*/
@ApiModelProperty(
value = "The name for the property."
)
public String getName() {
return name;
}
@ -83,6 +96,9 @@ public class PropertyDescriptorDTO {
/**
* @return human-readable name to display to users
*/
@ApiModelProperty(
value = "The human readable name for the property."
)
public String getDisplayName() {
return displayName;
}
@ -94,6 +110,9 @@ public class PropertyDescriptorDTO {
/**
* @return whether the property is required for this processor
*/
@ApiModelProperty(
value = "Whether the property is required."
)
public boolean isRequired() {
return required;
}
@ -105,6 +124,9 @@ public class PropertyDescriptorDTO {
/**
* @return indicates that the value for this property should be considered sensitive and protected whenever stored or represented
*/
@ApiModelProperty(
value = "Whether the property is sensitive and protected whenever stored or represented."
)
public boolean isSensitive() {
return sensitive;
}
@ -116,6 +138,9 @@ public class PropertyDescriptorDTO {
/**
* @return indicates whether this property is dynamic
*/
@ApiModelProperty(
value = "Whether the property is dynamic (user-defined)."
)
public boolean isDynamic() {
return dynamic;
}
@ -127,6 +152,9 @@ public class PropertyDescriptorDTO {
/**
* @return specifies whether or not this property support expression language
*/
@ApiModelProperty(
value = "Whether the property supports expression language."
)
public boolean getSupportsEl() {
return supportsEl;
}
@ -138,6 +166,9 @@ public class PropertyDescriptorDTO {
/**
* @return if this property identifies a controller service, this returns the fully qualified type, null otherwise
*/
@ApiModelProperty(
value = "If the property identifies a controller service, this returns the fully qualified type."
)
public String getIdentifiesControllerService() {
return identifiesControllerService;
}
@ -159,6 +190,9 @@ public class PropertyDescriptorDTO {
/**
* @return the human-readable value that is allowed for this PropertyDescriptor
*/
@ApiModelProperty(
value = "A human readable value that is allowed for the property descriptor."
)
public String getDisplayName() {
return displayName;
}
@ -170,6 +204,9 @@ public class PropertyDescriptorDTO {
/**
* @return the value for this allowable value
*/
@ApiModelProperty(
value = "A value that is allowed for the property descriptor."
)
public String getValue() {
return value;
}
@ -181,6 +218,9 @@ public class PropertyDescriptorDTO {
/**
* @return a description of this Allowable Value, or <code>null</code> if no description is given
*/
@ApiModelProperty(
value = "A description for this allowable value."
)
public String getDescription() {
return description;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyHistoryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -30,6 +31,9 @@ public class PropertyHistoryDTO {
/**
* @return previous values
*/
@ApiModelProperty(
value = "Previous values for a given property."
)
public List<PreviousValueDTO> getPreviousValues() {
return previousValues;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RelationshipDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -31,6 +32,9 @@ public class RelationshipDTO {
/**
* @return the relationship name
*/
@ApiModelProperty(
value = "The relationship name."
)
public String getName() {
return name;
}
@ -42,6 +46,9 @@ public class RelationshipDTO {
/**
* @return the relationship description
*/
@ApiModelProperty(
value = "The relationship description."
)
public String getDescription() {
return description;
}
@ -53,6 +60,9 @@ public class RelationshipDTO {
/**
* @return true if relationship is auto terminated;false otherwise
*/
@ApiModelProperty(
value = "Whether or not flowfiles sent to this relationship should auto terminate."
)
public Boolean isAutoTerminate() {
return autoTerminate;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupContentsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -31,6 +32,9 @@ public class RemoteProcessGroupContentsDTO {
/**
* @return Controller Input Ports to which data can be sent
*/
@ApiModelProperty(
value = "The input ports to which data can be sent."
)
public Set<RemoteProcessGroupPortDTO> getInputPorts() {
return inputPorts;
}
@ -42,6 +46,9 @@ public class RemoteProcessGroupContentsDTO {
/**
* @return Controller Output Ports from which data can be retrieved
*/
@ApiModelProperty(
value = "The output ports from which data can be retrieved."
)
public Set<RemoteProcessGroupPortDTO> getOutputPorts() {
return outputPorts;
}

51
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -69,6 +70,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return target uri of this remote process group
*/
@ApiModelProperty(
value = "The target URI of the remote process group."
)
public String getTargetUri() {
return this.targetUri;
}
@ -76,6 +80,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @param name of this remote process group
*/
@ApiModelProperty(
value = "The name of the remote process group."
)
public void setName(final String name) {
this.name = name;
}
@ -87,6 +94,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return Comments for this remote process group
*/
@ApiModelProperty(
value = "The comments for the remote process group."
)
public String getComments() {
return comments;
}
@ -98,6 +108,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return any remote authorization issues for this remote process group
*/
@ApiModelProperty(
value = "Any remote authorization issues for the remote process group."
)
public List<String> getAuthorizationIssues() {
return authorizationIssues;
}
@ -109,6 +122,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return whether or not this remote process group is actively transmitting
*/
@ApiModelProperty(
value = "Whether the remote process group is actively transmitting."
)
public Boolean isTransmitting() {
return transmitting;
}
@ -120,6 +136,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return whether or not the target is running securely
*/
@ApiModelProperty(
value = "Whether the target is running securely."
)
public Boolean isTargetSecure() {
return targetSecure;
}
@ -131,6 +150,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return the time period used for the timeout when communicating with this RemoteProcessGroup
*/
@ApiModelProperty(
value = "The time period used for the timeout when commicating with the target."
)
public String getCommunicationsTimeout() {
return communicationsTimeout;
}
@ -140,8 +162,11 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
}
/**
* @return when yielding, this amount of time must elaspe before this remote process group is scheduled again
* @return when yielding, this amount of time must elapse before this remote process group is scheduled again
*/
@ApiModelProperty(
value = "When yielding, this amount of time must elapse before the remote process group is scheduled again."
)
public String getYieldDuration() {
return yieldDuration;
}
@ -153,6 +178,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of active remote input ports
*/
@ApiModelProperty(
value = "The number of active remote input ports."
)
public Integer getActiveRemoteInputPortCount() {
return activeRemoteInputPortCount;
}
@ -164,6 +192,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of inactive remote input ports
*/
@ApiModelProperty(
value = "The number of inactive remote input ports."
)
public Integer getInactiveRemoteInputPortCount() {
return inactiveRemoteInputPortCount;
}
@ -175,6 +206,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of active remote output ports
*/
@ApiModelProperty(
value = "The number of acitve remote output ports."
)
public Integer getActiveRemoteOutputPortCount() {
return activeRemoteOutputPortCount;
}
@ -186,6 +220,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of inactive remote output ports
*/
@ApiModelProperty(
value = "The number of inactive remote output ports."
)
public Integer getInactiveRemoteOutputPortCount() {
return inactiveRemoteOutputPortCount;
}
@ -197,6 +234,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of Remote Input Ports currently available in the remote NiFi instance
*/
@ApiModelProperty(
value = "The number of remote input ports currently available on the target."
)
public Integer getInputPortCount() {
return inputPortCount;
}
@ -208,6 +248,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return number of Remote Output Ports currently available in the remote NiFi instance
*/
@ApiModelProperty(
value = "The number of remote output ports currently available on the target."
)
public Integer getOutputPortCount() {
return outputPortCount;
}
@ -219,6 +262,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
/**
* @return contents of this remote process group. Will contain available input/output ports
*/
@ApiModelProperty(
value = "The contents of the remote process group. Will contain available input/output ports."
)
public RemoteProcessGroupContentsDTO getContents() {
return contents;
}
@ -231,6 +277,9 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO {
* @return the flow for this remote group was last refreshed
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when this remote process group was last refreshed."
)
public Date getFlowRefreshed() {
return flowRefreshed;
}

31
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -38,6 +39,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return comments as configured in the target port
*/
@ApiModelProperty(
value = "The comments as configured on the target port."
)
public String getComments() {
return comments;
}
@ -49,6 +53,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return number tasks that may transmit flow files to the target port concurrently
*/
@ApiModelProperty(
value = "The number of task that may transmit flowfiles to the target port concurrently."
)
public Integer getConcurrentlySchedulableTaskCount() {
return concurrentlySchedulableTaskCount;
}
@ -60,6 +67,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return id of the target port
*/
@ApiModelProperty(
value = "The id of the target port."
)
public String getId() {
return id;
}
@ -71,6 +81,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return id of the remote process group that this port resides in
*/
@ApiModelProperty(
value = "The id of the remote process group that the port resides in."
)
public String getGroupId() {
return groupId;
}
@ -82,6 +95,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return name of the target port
*/
@ApiModelProperty(
value = "The name of the target port."
)
public String getName() {
return name;
}
@ -93,6 +109,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return whether or not this remote group port is configured for transmission
*/
@ApiModelProperty(
value = "Whether the remote port is configured for transmission."
)
public Boolean isTransmitting() {
return transmitting;
}
@ -104,6 +123,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return whether or not flow file are compressed when sent to this target port
*/
@ApiModelProperty(
value = "Whether the flowfiles are compressed when sent to the target port."
)
public Boolean getUseCompression() {
return useCompression;
}
@ -115,6 +137,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return whether or not the target port exists
*/
@ApiModelProperty(
value = "Whether the target port exists."
)
public Boolean getExists() {
return exists;
}
@ -126,6 +151,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return whether or not the target port is running
*/
@ApiModelProperty(
value = "Whether the target port is running."
)
public Boolean isTargetRunning() {
return targetRunning;
}
@ -137,6 +165,9 @@ public class RemoteProcessGroupPortDTO {
/**
* @return whether or not this port has either an incoming or outgoing connection
*/
@ApiModelProperty(
value = "Whether the port has either an incoming or outgoing connection."
)
public Boolean isConnected() {
return connected;
}

48
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Map;
@ -49,6 +50,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return user-defined name of the reporting task
*/
@ApiModelProperty(
value = "The name of the reporting task."
)
public String getName() {
return name;
}
@ -60,6 +64,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return user-defined comments for the reporting task
*/
@ApiModelProperty(
value = "The comments of the reporting task."
)
public String getComments() {
return comments;
}
@ -71,6 +78,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return type of reporting task
*/
@ApiModelProperty(
value = "The fully qualified type of the reporting task."
)
public String getType() {
return type;
}
@ -84,6 +94,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
*
* @return The scheduling period
*/
@ApiModelProperty(
value = "The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy."
)
public String getSchedulingPeriod() {
return schedulingPeriod;
}
@ -95,6 +108,10 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return current scheduling state of the reporting task
*/
@ApiModelProperty(
value = "The state of the reporting task.",
allowableValues = "RUNNING, STOPPED, DISABLED"
)
public String getState() {
return state;
}
@ -106,6 +123,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return The scheduling strategy that determines how the {@link #getSchedulingPeriod()} value should be interpreted
*/
@ApiModelProperty(
value = "The scheduling strategy that determines how the schedulingPeriod value should be interpreted."
)
public String getSchedulingStrategy() {
return schedulingStrategy;
}
@ -115,8 +135,12 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
}
/**
* @return Where this service is available. Possible values are CLUSTER_MANAGER_ONLY, NODE_ONLY, BOTH
* @return Where this service is available. Possible values are NCM, NODE
*/
@ApiModelProperty(
value = "Where the reporting task is available.",
allowableValues = "NCM, NODE"
)
public String getAvailability() {
return availability;
}
@ -128,6 +152,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return reporting task's properties
*/
@ApiModelProperty(
value = "The properties of the reporting task."
)
public Map<String, String> getProperties() {
return properties;
}
@ -139,6 +166,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return Map of property name to descriptor
*/
@ApiModelProperty(
value = "The descriptors for the reporting tasks properties."
)
public Map<String, PropertyDescriptorDTO> getDescriptors() {
return descriptors;
}
@ -150,6 +180,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return the URL for this reporting task custom configuration UI if applicable. Null otherwise
*/
@ApiModelProperty(
value = "The URL for the custom configuration UI for the reporting task."
)
public String getCustomUiUrl() {
return customUiUrl;
}
@ -161,6 +194,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return currently configured annotation data for the reporting task
*/
@ApiModelProperty(
value = "The anntation data for the repoting task. This is how the custom UI relays configuration to the reporting task."
)
public String getAnnotationData() {
return annotationData;
}
@ -174,6 +210,10 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
*
* @return The validation errors
*/
@ApiModelProperty(
value = "Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before "
+ "it can be scheduled to run."
)
public Collection<String> getValidationErrors() {
return validationErrors;
}
@ -185,6 +225,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return default scheduling period for the different scheduling strategies
*/
@ApiModelProperty(
value = "The default scheduling period for the different scheduling strategies."
)
public Map<String, String> getDefaultSchedulingPeriod() {
return defaultSchedulingPeriod;
}
@ -196,6 +239,9 @@ public class ReportingTaskDTO extends NiFiComponentDTO {
/**
* @return number of active threads for this reporting task
*/
@ApiModelProperty(
value = "The number of active threads for the reporting task."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}

12
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -35,6 +36,10 @@ public class RevisionDTO {
*
* @return The client id
*/
@ApiModelProperty(
value = "A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous "
+ "nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back"
)
public String getClientId() {
return clientId;
}
@ -48,6 +53,10 @@ public class RevisionDTO {
*
* @return The revision
*/
@ApiModelProperty(
value = "NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this "
+ "field represents the updated base version."
)
public Long getVersion() {
return version;
}
@ -59,6 +68,9 @@ public class RevisionDTO {
/**
* @return The user that last modified the flow
*/
@ApiModelProperty(
value = "The user that last modified the flow."
)
public String getLastModifier() {
return lastModifier;
}

50
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.HashSet;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -46,6 +47,9 @@ public class SnippetDTO {
/**
* @return id of this snippet
*/
@ApiModelProperty(
value = "The id of the snippet."
)
public String getId() {
return id;
}
@ -57,6 +61,9 @@ public class SnippetDTO {
/**
* @return uri of this snippet
*/
@ApiModelProperty(
value = "The URI of the snippet."
)
public String getUri() {
return uri;
}
@ -68,6 +75,9 @@ public class SnippetDTO {
/**
* @return group id for the components in this snippet
*/
@ApiModelProperty(
value = "The group id for the components in the snippet."
)
public String getParentGroupId() {
return parentGroupId;
}
@ -79,6 +89,11 @@ public class SnippetDTO {
/**
* @return whether or not this snippet is linked to the underlying data flow
*/
@ApiModelProperty(
value = "Whether or not the snippet is linked to the underlying data flow. For instance if linked was set to true and the snippet was deleted "
+ "it would also deleted the components in the snippet. If the snippet was not linked, deleting the snippet would only remove the "
+ "snippet and leave the component intact."
)
public Boolean isLinked() {
return linked;
}
@ -91,6 +106,10 @@ public class SnippetDTO {
* @return the ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its
* contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getConnections() {
return connections;
}
@ -103,6 +122,10 @@ public class SnippetDTO {
* @return the ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its
* contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getFunnels() {
return funnels;
}
@ -115,6 +138,10 @@ public class SnippetDTO {
* @return the ids of the input port in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its
* contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getInputPorts() {
return inputPorts;
}
@ -127,6 +154,10 @@ public class SnippetDTO {
* @return the ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its
* contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getLabels() {
return labels;
}
@ -139,6 +170,10 @@ public class SnippetDTO {
* @return the ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created
* its contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getOutputPorts() {
return outputPorts;
}
@ -151,6 +186,10 @@ public class SnippetDTO {
* @return The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created
* its contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getProcessGroups() {
return processGroups;
}
@ -163,6 +202,10 @@ public class SnippetDTO {
* @return The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its
* contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getProcessors() {
return processors;
}
@ -175,6 +218,10 @@ public class SnippetDTO {
* @return the ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been
* created its contents cannot be modified (these ids are ignored during update requests)
*/
@ApiModelProperty(
value = "The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet "
+ "has been created its contents cannot be modified (these ids are ignored during update requests)."
)
public Set<String> getRemoteProcessGroups() {
return remoteProcessGroups;
}
@ -186,6 +233,9 @@ public class SnippetDTO {
/**
* @return the contents of the configuration for this snippet
*/
@ApiModelProperty(
value = "The contents of the configuration for the snippet."
)
public FlowSnippetDTO getContents() {
return contents;
}

88
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SystemDiagnosticsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -56,6 +57,9 @@ public class SystemDiagnosticsDTO {
/**
* @return number of available processors, if supported
*/
@ApiModelProperty(
value = "Number of available processors if supported by the underlying system."
)
public Integer getAvailableProcessors() {
return availableProcessors;
}
@ -67,6 +71,9 @@ public class SystemDiagnosticsDTO {
/**
* @return number of daemon threads
*/
@ApiModelProperty(
value = "Number of daemon threads."
)
public Integer getDaemonThreads() {
return daemonThreads;
}
@ -78,6 +85,9 @@ public class SystemDiagnosticsDTO {
/**
* @return amount of free heap
*/
@ApiModelProperty(
value = "Amount of free heap."
)
public String getFreeHeap() {
return freeHeap;
}
@ -89,6 +99,9 @@ public class SystemDiagnosticsDTO {
/**
* @return amount of free non-heap
*/
@ApiModelProperty(
value = "Amount of free non heap."
)
public String getFreeNonHeap() {
return freeNonHeap;
}
@ -100,6 +113,9 @@ public class SystemDiagnosticsDTO {
/**
* @return max size of the heap
*/
@ApiModelProperty(
value = "Maximum size of heap."
)
public String getMaxHeap() {
return maxHeap;
}
@ -111,6 +127,9 @@ public class SystemDiagnosticsDTO {
/**
* @return max size of the non-heap
*/
@ApiModelProperty(
value = "Maximum size of non heap."
)
public String getMaxNonHeap() {
return maxNonHeap;
}
@ -122,6 +141,9 @@ public class SystemDiagnosticsDTO {
/**
* @return processor load average, if supported
*/
@ApiModelProperty(
value = "The processor load average if supported by the underlying system."
)
public Double getProcessorLoadAverage() {
return processorLoadAverage;
}
@ -133,6 +155,9 @@ public class SystemDiagnosticsDTO {
/**
* @return total size of the heap
*/
@ApiModelProperty(
value = "Total size of heap."
)
public String getTotalHeap() {
return totalHeap;
}
@ -144,6 +169,9 @@ public class SystemDiagnosticsDTO {
/**
* @return total size of non-heap
*/
@ApiModelProperty(
value = "Total size of non heap."
)
public String getTotalNonHeap() {
return totalNonHeap;
}
@ -155,6 +183,9 @@ public class SystemDiagnosticsDTO {
/**
* @return total number of threads
*/
@ApiModelProperty(
value = "Total number of threads."
)
public Integer getTotalThreads() {
return totalThreads;
}
@ -166,6 +197,9 @@ public class SystemDiagnosticsDTO {
/**
* @return amount of used heap
*/
@ApiModelProperty(
value = "Amount of used heap."
)
public String getUsedHeap() {
return usedHeap;
}
@ -177,6 +211,9 @@ public class SystemDiagnosticsDTO {
/**
* @return amount of used non-heap
*/
@ApiModelProperty(
value = "Amount of use non heap."
)
public String getUsedNonHeap() {
return usedNonHeap;
}
@ -188,6 +225,9 @@ public class SystemDiagnosticsDTO {
/**
* @return heap utilization
*/
@ApiModelProperty(
value = "Utilization of heap."
)
public String getHeapUtilization() {
return heapUtilization;
}
@ -199,6 +239,9 @@ public class SystemDiagnosticsDTO {
/**
* @return non-heap utilization
*/
@ApiModelProperty(
value = "Utilization of non heap."
)
public String getNonHeapUtilization() {
return nonHeapUtilization;
}
@ -210,6 +253,9 @@ public class SystemDiagnosticsDTO {
/**
* @return content repository storage usage
*/
@ApiModelProperty(
value = "The content repository storage usage."
)
public Set<StorageUsageDTO> getContentRepositoryStorageUsage() {
return contentRepositoryStorageUsage;
}
@ -221,6 +267,9 @@ public class SystemDiagnosticsDTO {
/**
* @return flowfile repository storage usage
*/
@ApiModelProperty(
value = "The flowfile repository storage usage."
)
public StorageUsageDTO getFlowFileRepositoryStorageUsage() {
return flowFileRepositoryStorageUsage;
}
@ -232,6 +281,9 @@ public class SystemDiagnosticsDTO {
/**
* @return Garbage collection details
*/
@ApiModelProperty(
value = "The garbage collection details."
)
public Set<GarbageCollectionDTO> getGarbageCollection() {
return garbageCollection;
}
@ -244,6 +296,9 @@ public class SystemDiagnosticsDTO {
* @return When these diagnostics were generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "When the diagnostics were generated."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}
@ -270,6 +325,9 @@ public class SystemDiagnosticsDTO {
/**
* @return identifier for this storage location
*/
@ApiModelProperty(
value = "The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration."
)
public String getIdentifier() {
return identifier;
}
@ -281,6 +339,9 @@ public class SystemDiagnosticsDTO {
/**
* @return amount of free space
*/
@ApiModelProperty(
value = "Amount of free space."
)
public String getFreeSpace() {
return freeSpace;
}
@ -292,6 +353,9 @@ public class SystemDiagnosticsDTO {
/**
* @return freeSpace amount of total space
*/
@ApiModelProperty(
value = "Amount of total space."
)
public String getTotalSpace() {
return totalSpace;
}
@ -303,6 +367,9 @@ public class SystemDiagnosticsDTO {
/**
* @return amount of used space
*/
@ApiModelProperty(
value = "Amount of used space."
)
public String getUsedSpace() {
return usedSpace;
}
@ -314,6 +381,9 @@ public class SystemDiagnosticsDTO {
/**
* @return utilization of this storage location
*/
@ApiModelProperty(
value = "Utilization of this storage location."
)
public String getUtilization() {
return utilization;
}
@ -325,6 +395,9 @@ public class SystemDiagnosticsDTO {
/**
* @return number of bytes of free space
*/
@ApiModelProperty(
value = "The number of bytes of free space."
)
public Long getFreeSpaceBytes() {
return freeSpaceBytes;
}
@ -336,6 +409,9 @@ public class SystemDiagnosticsDTO {
/**
* @return number of bytes of total space
*/
@ApiModelProperty(
value = "The number of bytes of total space."
)
public Long getTotalSpaceBytes() {
return totalSpaceBytes;
}
@ -347,6 +423,9 @@ public class SystemDiagnosticsDTO {
/**
* @return number of bytes of used space
*/
@ApiModelProperty(
value = "The number of bytes of used space."
)
public Long getUsedSpaceBytes() {
return usedSpaceBytes;
}
@ -369,6 +448,9 @@ public class SystemDiagnosticsDTO {
/**
* @return name of the garbage collector
*/
@ApiModelProperty(
value = "The name of the garbage collector."
)
public String getName() {
return name;
}
@ -377,6 +459,9 @@ public class SystemDiagnosticsDTO {
this.name = name;
}
@ApiModelProperty(
value = "The number of times garbage collection has run."
)
public long getCollectionCount() {
return collectionCount;
}
@ -391,6 +476,9 @@ public class SystemDiagnosticsDTO {
/**
* @return total amount of time spent garbage collecting
*/
@ApiModelProperty(
value = "The total amount of time spent garbage collecting."
)
public String getCollectionTime() {
return collectionTime;
}

19
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/TemplateDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -39,6 +40,9 @@ public class TemplateDTO {
/**
* @return id for this template
*/
@ApiModelProperty(
value = "The id of the template."
)
public String getId() {
return id;
}
@ -50,6 +54,9 @@ public class TemplateDTO {
/**
* @return uri for this template
*/
@ApiModelProperty(
value = "The URI for the template."
)
public String getUri() {
return uri;
}
@ -61,6 +68,9 @@ public class TemplateDTO {
/**
* @return name of this template
*/
@ApiModelProperty(
value = "The name of the template."
)
public String getName() {
return name;
}
@ -72,6 +82,9 @@ public class TemplateDTO {
/**
* @return description of this template
*/
@ApiModelProperty(
value = "The description of the template."
)
public String getDescription() {
return description;
}
@ -84,6 +97,9 @@ public class TemplateDTO {
* @return timestamp when this template was created
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when this template was created."
)
public Date getTimestamp() {
return timestamp;
}
@ -95,6 +111,9 @@ public class TemplateDTO {
/**
* @return snippet in this template
*/
@ApiModelProperty(
value = "The contents of the template."
)
public FlowSnippetDTO getSnippet() {
return snippet;
}

31
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -43,6 +44,9 @@ public class UserDTO {
/**
* @return user id
*/
@ApiModelProperty(
value = "The id of the user."
)
public String getId() {
return id;
}
@ -54,6 +58,9 @@ public class UserDTO {
/**
* @return users authorities
*/
@ApiModelProperty(
value = "The users authorities."
)
public Set<String> getAuthorities() {
return authorities;
}
@ -66,6 +73,9 @@ public class UserDTO {
* @return creation time for this users account
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when the user was created."
)
public Date getCreation() {
return creation;
}
@ -77,6 +87,9 @@ public class UserDTO {
/**
* @return users DN
*/
@ApiModelProperty(
value = "The dn of the user."
)
public String getDn() {
return dn;
}
@ -88,6 +101,9 @@ public class UserDTO {
/**
* @return users name. If the name could not be extracted from the DN, this value will be the entire DN
*/
@ApiModelProperty(
value = "The username. If it could not be extracted from the DN, this value will be the entire DN."
)
public String getUserName() {
return userName;
}
@ -99,6 +115,9 @@ public class UserDTO {
/**
* @return user group
*/
@ApiModelProperty(
value = "The group this user belongs to."
)
public String getUserGroup() {
return userGroup;
}
@ -110,6 +129,9 @@ public class UserDTO {
/**
* @return users account justification
*/
@ApiModelProperty(
value = "The justification for the user account."
)
public String getJustification() {
return justification;
}
@ -122,6 +144,9 @@ public class UserDTO {
* @return time that the user last accessed the system
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp the user last accessed the system."
)
public Date getLastAccessed() {
return lastAccessed;
}
@ -134,6 +159,9 @@ public class UserDTO {
* @return time that the users credentials were last verified
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp the user authorities were verified."
)
public Date getLastVerified() {
return lastVerified;
}
@ -145,6 +173,9 @@ public class UserDTO {
/**
* @return status of the users account
*/
@ApiModelProperty(
value = "The user status."
)
public String getStatus() {
return status;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserGroupDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -33,6 +34,9 @@ public class UserGroupDTO {
/**
* @return user group
*/
@ApiModelProperty(
value = "The user group."
)
public String getGroup() {
return group;
}
@ -44,6 +48,9 @@ public class UserGroupDTO {
/**
* @return users in this group
*/
@ApiModelProperty(
value = "The users that belong to the group."
)
public Set<String> getUserIds() {
return userIds;
}
@ -55,6 +62,9 @@ public class UserGroupDTO {
/**
* @return status of the users account
*/
@ApiModelProperty(
value = "The status of the users accounts."
)
public String getStatus() {
return status;
}
@ -66,6 +76,9 @@ public class UserGroupDTO {
/**
* @return users authorities
*/
@ApiModelProperty(
value = "The authorities of the users."
)
public Set<String> getAuthorities() {
return authorities;
}

31
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/ActionDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -45,6 +46,9 @@ public class ActionDTO {
/**
* @return action id
*/
@ApiModelProperty(
value = "The action id."
)
public Integer getId() {
return id;
}
@ -56,6 +60,9 @@ public class ActionDTO {
/**
* @return user dn who perform this action
*/
@ApiModelProperty(
value = "The dn of the user that performed the action."
)
public String getUserDn() {
return userDn;
}
@ -67,6 +74,9 @@ public class ActionDTO {
/**
* @return user name who perform this action
*/
@ApiModelProperty(
value = "The name of the user that performed the action."
)
public String getUserName() {
return userName;
}
@ -79,6 +89,9 @@ public class ActionDTO {
* @return action's timestamp
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The timestamp of the action."
)
public Date getTimestamp() {
return timestamp;
}
@ -90,6 +103,9 @@ public class ActionDTO {
/**
* @return id of the source component of this action
*/
@ApiModelProperty(
value = "The id of the source component."
)
public String getSourceId() {
return sourceId;
}
@ -101,6 +117,9 @@ public class ActionDTO {
/**
* @return name of the source component of this action
*/
@ApiModelProperty(
value = "The name of the source component."
)
public String getSourceName() {
return sourceName;
}
@ -112,6 +131,9 @@ public class ActionDTO {
/**
* @return type of the source component of this action
*/
@ApiModelProperty(
value = "The type of the source component."
)
public String getSourceType() {
return sourceType;
}
@ -123,6 +145,9 @@ public class ActionDTO {
/**
* @return component details (if any) for this action
*/
@ApiModelProperty(
value = "The details of the source component."
)
public ComponentDetailsDTO getComponentDetails() {
return componentDetails;
}
@ -134,6 +159,9 @@ public class ActionDTO {
/**
* @return operation being performed in this action
*/
@ApiModelProperty(
value = "The operation that was performed."
)
public String getOperation() {
return operation;
}
@ -145,6 +173,9 @@ public class ActionDTO {
/**
* @return action details (if any) for this action
*/
@ApiModelProperty(
value = "The details of the action."
)
public ActionDetailsDTO getActionDetails() {
return actionDetails;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -35,6 +36,9 @@ public class HistoryDTO {
/**
* @return total number of actions
*/
@ApiModelProperty(
value = "The number of number of actions that matched the search criteria.."
)
public Integer getTotal() {
return total;
}
@ -47,6 +51,9 @@ public class HistoryDTO {
* @return timestamp when these records were returned
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when the report was generated."
)
public Date getLastRefreshed() {
return lastRefreshed;
}
@ -58,6 +65,9 @@ public class HistoryDTO {
/**
* @return actions for this range
*/
@ApiModelProperty(
value = "The actions."
)
public Collection<ActionDTO> getActions() {
return actions;
}

25
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/HistoryQueryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -39,6 +40,9 @@ public class HistoryQueryDTO {
/**
* @return user name
*/
@ApiModelProperty(
value = "The name of the source component."
)
public String getUserName() {
return userName;
}
@ -50,6 +54,9 @@ public class HistoryQueryDTO {
/**
* @return source component id
*/
@ApiModelProperty(
value = "The id of the source component."
)
public String getSourceId() {
return sourceId;
}
@ -62,6 +69,9 @@ public class HistoryQueryDTO {
* @return start date
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The start date of actions to return."
)
public Date getStartDate() {
return startDate;
}
@ -74,6 +84,9 @@ public class HistoryQueryDTO {
* @return end date
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The end date of actions to return."
)
public Date getEndDate() {
return endDate;
}
@ -85,6 +98,9 @@ public class HistoryQueryDTO {
/**
* @return offset
*/
@ApiModelProperty(
value = "The offset into the result set."
)
public Integer getOffset() {
return offset;
}
@ -96,6 +112,9 @@ public class HistoryQueryDTO {
/**
* @return desired row count
*/
@ApiModelProperty(
value = "The number of actions to return."
)
public Integer getCount() {
return count;
}
@ -107,6 +126,9 @@ public class HistoryQueryDTO {
/**
* @return desired sort column
*/
@ApiModelProperty(
value = "The field to sort on."
)
public String getSortColumn() {
return sortColumn;
}
@ -118,6 +140,9 @@ public class HistoryQueryDTO {
/**
* @return desired sort order
*/
@ApiModelProperty(
value = "The sort order."
)
public String getSortOrder() {
return sortOrder;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/ExtensionDetailsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action.component.details;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -29,6 +30,9 @@ public class ExtensionDetailsDTO extends ComponentDetailsDTO {
/**
* @return extension type
*/
@ApiModelProperty(
value = "The fully qualified type of extension."
)
public String getType() {
return type;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/component/details/RemoteProcessGroupDetailsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action.component.details;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -29,6 +30,9 @@ public class RemoteProcessGroupDetailsDTO extends ComponentDetailsDTO {
/**
* @return URI of the remote process group
*/
@ApiModelProperty(
value = "The uri of the target of the remote process group."
)
public String getUri() {
return uri;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConfigureDetailsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action.details;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -31,6 +32,9 @@ public class ConfigureDetailsDTO extends ActionDetailsDTO {
/**
* @return name of the property that was modified
*/
@ApiModelProperty(
value = "The name of the property that was modified."
)
public String getName() {
return name;
}
@ -42,6 +46,9 @@ public class ConfigureDetailsDTO extends ActionDetailsDTO {
/**
* @return previous value
*/
@ApiModelProperty(
value = "The previous value."
)
public String getPreviousValue() {
return previousValue;
}
@ -53,6 +60,9 @@ public class ConfigureDetailsDTO extends ActionDetailsDTO {
/**
* @return new value
*/
@ApiModelProperty(
value = "The new value."
)
public String getValue() {
return value;
}

22
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/ConnectDetailsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action.details;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -35,6 +36,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return id of the source of the connection
*/
@ApiModelProperty(
value = "The id of the source of the connection."
)
public String getSourceId() {
return sourceId;
}
@ -46,6 +50,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return name of the source of the connection
*/
@ApiModelProperty(
value = "The name of the source of the connection."
)
public String getSourceName() {
return sourceName;
}
@ -57,6 +64,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return type of the source of the connection
*/
@ApiModelProperty(
value = "The type of the source of the connection."
)
public String getSourceType() {
return sourceType;
}
@ -68,6 +78,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return name of the relationship that was connected
*/
@ApiModelProperty(
value = "The name of the relationship that was connected."
)
public String getRelationship() {
return relationship;
}
@ -79,6 +92,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return id of the destination of the connection
*/
@ApiModelProperty(
value = "The id of the destination of the connection."
)
public String getDestinationId() {
return destinationId;
}
@ -90,6 +106,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return name of the destination of the connection
*/
@ApiModelProperty(
value = "The name of the destination of the connection."
)
public String getDestinationName() {
return destinationName;
}
@ -101,6 +120,9 @@ public class ConnectDetailsDTO extends ActionDetailsDTO {
/**
* @return type of the destination of the connection
*/
@ApiModelProperty(
value = "The type of the destination of the connection."
)
public String getDestinationType() {
return destinationType;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/MoveDetailsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action.details;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -32,6 +33,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO {
/**
* @return id of the group the components previously belonged to
*/
@ApiModelProperty(
value = "The id of the group the components previously belonged to."
)
public String getPreviousGroupId() {
return previousGroupId;
}
@ -43,6 +47,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO {
/**
* @return name of the group of the components previously belonged to
*/
@ApiModelProperty(
value = "The name of the group the components previously belonged to."
)
public String getPreviousGroup() {
return previousGroup;
}
@ -54,6 +61,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO {
/**
* @return id of the group the components belong to
*/
@ApiModelProperty(
value = "The id of the group that components belong to."
)
public String getGroupId() {
return groupId;
}
@ -65,6 +75,9 @@ public class MoveDetailsDTO extends ActionDetailsDTO {
/**
* @return name of the group the components belong to
*/
@ApiModelProperty(
value = "The name of the group the components belong to."
)
public String getGroup() {
return group;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/action/details/PurgeDetailsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.action.details;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -33,6 +34,9 @@ public class PurgeDetailsDTO extends ActionDetailsDTO {
* @return end date for this purge action
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The end date for the purge action."
)
public Date getEndDate() {
return endDate;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/AttributeDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -31,6 +32,9 @@ public class AttributeDTO {
/**
* @return attribute name
*/
@ApiModelProperty(
value = "The attribute name."
)
public String getName() {
return name;
}
@ -42,6 +46,9 @@ public class AttributeDTO {
/**
* @return attribute value
*/
@ApiModelProperty(
value = "The attribute value."
)
public String getValue() {
return value;
}
@ -53,6 +60,9 @@ public class AttributeDTO {
/**
* @return value of this attribute before the event took place
*/
@ApiModelProperty(
value = "The value of the attribute before the event took place."
)
public String getPreviousValue() {
return previousValue;
}

28
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -45,6 +46,9 @@ public class ProvenanceDTO {
/**
* @return id of this provenance query
*/
@ApiModelProperty(
value = "The id of the provenance query."
)
public String getId() {
return id;
}
@ -56,6 +60,9 @@ public class ProvenanceDTO {
/**
* @return URI for this query. Used for obtaining the requests at a later time
*/
@ApiModelProperty(
value = "The URI for this query. Used for obtaining/deleting the request at a later time"
)
public String getUri() {
return uri;
}
@ -67,6 +74,9 @@ public class ProvenanceDTO {
/**
* @return id of the node in the cluster where this provenance originated
*/
@ApiModelProperty(
value = "The id of the node in the cluster where this provenance originated."
)
public String getClusterNodeId() {
return clusterNodeId;
}
@ -79,6 +89,9 @@ public class ProvenanceDTO {
* @return time the query was submitted
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "The timestamp when the query was submitted."
)
public Date getSubmissionTime() {
return submissionTime;
}
@ -91,6 +104,9 @@ public class ProvenanceDTO {
* @return expiration time of the query results
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "The timestamp when the query will expire."
)
public Date getExpiration() {
return expiration;
}
@ -102,6 +118,9 @@ public class ProvenanceDTO {
/**
* @return percent completed
*/
@ApiModelProperty(
value = "The current percent complete."
)
public Integer getPercentCompleted() {
return percentCompleted;
}
@ -113,6 +132,9 @@ public class ProvenanceDTO {
/**
* @return whether the query has finished
*/
@ApiModelProperty(
value = "Whether the query has finished."
)
public Boolean isFinished() {
return finished;
}
@ -124,6 +146,9 @@ public class ProvenanceDTO {
/**
* @return provenance request
*/
@ApiModelProperty(
value = "The provenance request."
)
public ProvenanceRequestDTO getRequest() {
return request;
}
@ -135,6 +160,9 @@ public class ProvenanceDTO {
/**
* @return results of this query
*/
@ApiModelProperty(
value = "The provenance results."
)
public ProvenanceResultsDTO getResults() {
return results;
}

125
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import java.util.List;
@ -85,6 +86,9 @@ public class ProvenanceEventDTO {
/**
* @return event uuid
*/
@ApiModelProperty(
value = "The event uuid."
)
public String getId() {
return id;
}
@ -96,6 +100,9 @@ public class ProvenanceEventDTO {
/**
* @return event id
*/
@ApiModelProperty(
value = "The event id. This is a one up number thats unique per node."
)
public Long getEventId() {
return eventId;
}
@ -108,6 +115,9 @@ public class ProvenanceEventDTO {
* @return time the event occurred
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "The timestamp of the event."
)
public Date getEventTime() {
return eventTime;
}
@ -119,6 +129,9 @@ public class ProvenanceEventDTO {
/**
* @return UUID of the FlowFile for this event
*/
@ApiModelProperty(
value = "The uuid of the flowfile for the event."
)
public String getFlowFileUuid() {
return flowFileUuid;
}
@ -130,6 +143,9 @@ public class ProvenanceEventDTO {
/**
* @return size of the FlowFile for this event
*/
@ApiModelProperty(
value = "The size of the flowfile for the event."
)
public String getFileSize() {
return fileSize;
}
@ -141,6 +157,9 @@ public class ProvenanceEventDTO {
/**
* @return size of the FlowFile in bytes for this event
*/
@ApiModelProperty(
value = "The size of the flowfile in bytes for the event."
)
public Long getFileSizeBytes() {
return fileSizeBytes;
}
@ -152,6 +171,9 @@ public class ProvenanceEventDTO {
/**
* @return type of this event
*/
@ApiModelProperty(
value = "The type of the event."
)
public String getEventType() {
return eventType;
}
@ -163,6 +185,9 @@ public class ProvenanceEventDTO {
/**
* @return attributes for the FlowFile for this event
*/
@ApiModelProperty(
value = "The attributes of the flowfile for the event."
)
public Collection<AttributeDTO> getAttributes() {
return attributes;
}
@ -174,6 +199,9 @@ public class ProvenanceEventDTO {
/**
* @return id of the group that this component resides in. If the component is no longer in the flow, the group id will not be set
*/
@ApiModelProperty(
value = "The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set."
)
public String getGroupId() {
return groupId;
}
@ -185,6 +213,9 @@ public class ProvenanceEventDTO {
/**
* @return id of the component that generated this event
*/
@ApiModelProperty(
value = "The id of the component that generated the event."
)
public String getComponentId() {
return componentId;
}
@ -196,6 +227,9 @@ public class ProvenanceEventDTO {
/**
* @return name of the component that generated this event
*/
@ApiModelProperty(
value = "The name of the component that generated the event."
)
public String getComponentName() {
return componentName;
}
@ -207,6 +241,9 @@ public class ProvenanceEventDTO {
/**
* @return type of the component that generated this event
*/
@ApiModelProperty(
value = "The type of the component that generated the event."
)
public String getComponentType() {
return componentType;
}
@ -218,6 +255,9 @@ public class ProvenanceEventDTO {
/**
* @return source/destination system URI if the event was a RECEIVE/SEND
*/
@ApiModelProperty(
value = "The source/destination system uri if the event was a RECEIVE/SEND."
)
public String getTransitUri() {
return transitUri;
}
@ -229,6 +269,9 @@ public class ProvenanceEventDTO {
/**
* @return alternate identifier URI for the FlowFile for this event
*/
@ApiModelProperty(
value = "The alternate identifier uri for the fileflow for the event."
)
public String getAlternateIdentifierUri() {
return alternateIdentifierUri;
}
@ -240,6 +283,9 @@ public class ProvenanceEventDTO {
/**
* @return identifier of the node where this event originated
*/
@ApiModelProperty(
value = "The identifier for the node where the event originated."
)
public String getClusterNodeId() {
return clusterNodeId;
}
@ -251,6 +297,9 @@ public class ProvenanceEventDTO {
/**
* @return label to use to show which node this event originated from
*/
@ApiModelProperty(
value = "The label for the node where the event originated."
)
public String getClusterNodeAddress() {
return clusterNodeAddress;
}
@ -262,6 +311,9 @@ public class ProvenanceEventDTO {
/**
* @return parent uuids for this event
*/
@ApiModelProperty(
value = "The parent uuids for the event."
)
public List<String> getParentUuids() {
return parentUuids;
}
@ -273,6 +325,9 @@ public class ProvenanceEventDTO {
/**
* @return child uuids for this event
*/
@ApiModelProperty(
value = "The child uuids for the event."
)
public List<String> getChildUuids() {
return childUuids;
}
@ -284,6 +339,9 @@ public class ProvenanceEventDTO {
/**
* @return duration of the event, in milliseconds
*/
@ApiModelProperty(
value = "The event duration in milliseconds."
)
public Long getEventDuration() {
return eventDuration;
}
@ -295,6 +353,9 @@ public class ProvenanceEventDTO {
/**
* @return duration since the lineage began, in milliseconds
*/
@ApiModelProperty(
value = "The duration since the lineage began, in milliseconds."
)
public Long getLineageDuration() {
return lineageDuration;
}
@ -306,6 +367,9 @@ public class ProvenanceEventDTO {
/**
* @return source system FlowFile id
*/
@ApiModelProperty(
value = "The source system flowfile id."
)
public String getSourceSystemFlowFileId() {
return sourceSystemFlowFileId;
}
@ -317,6 +381,9 @@ public class ProvenanceEventDTO {
/**
* @return If this represents a route event, this is the relationship to which the flowfile was routed
*/
@ApiModelProperty(
value = "The relationship to which the flowfile was routed if the event is of type ROUTE."
)
public String getRelationship() {
return relationship;
}
@ -328,6 +395,9 @@ public class ProvenanceEventDTO {
/**
* @return event details
*/
@ApiModelProperty(
value = "The event details."
)
public String getDetails() {
return details;
}
@ -339,6 +409,9 @@ public class ProvenanceEventDTO {
/**
* @return whether or not the input and output content claim is the same
*/
@ApiModelProperty(
value = "Whether the input and output content claim is the same."
)
public Boolean getContentEqual() {
return contentEqual;
}
@ -350,6 +423,9 @@ public class ProvenanceEventDTO {
/**
* @return whether or not the output content is still available
*/
@ApiModelProperty(
value = "Whether the output content is still available."
)
public Boolean getOutputContentAvailable() {
return outputContentAvailable;
}
@ -361,6 +437,9 @@ public class ProvenanceEventDTO {
/**
* @return the Section in which the output Content Claim lives, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The section in which the output content claim lives."
)
public String getOutputContentClaimSection() {
return outputContentClaimSection;
}
@ -372,6 +451,9 @@ public class ProvenanceEventDTO {
/**
* @return the Container in which the output Content Claim lives, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The container in which the output content claim lives."
)
public String getOutputContentClaimContainer() {
return outputContentClaimContainer;
}
@ -383,6 +465,9 @@ public class ProvenanceEventDTO {
/**
* @return the Identifier of the output Content Claim, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The identifier of the output content claim."
)
public String getOutputContentClaimIdentifier() {
return outputContentClaimIdentifier;
}
@ -394,6 +479,9 @@ public class ProvenanceEventDTO {
/**
* @return the offset into the the output Content Claim where the FlowFile's content begins, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The offset into the output content claim where the flowfiles content begins."
)
public Long getOutputContentClaimOffset() {
return outputContentClaimOffset;
}
@ -405,6 +493,9 @@ public class ProvenanceEventDTO {
/**
* @return the formatted file size of the input content claim
*/
@ApiModelProperty(
value = "The file size of the output content claim formatted."
)
public String getOutputContentClaimFileSize() {
return outputContentClaimFileSize;
}
@ -416,6 +507,9 @@ public class ProvenanceEventDTO {
/**
* @return the number of bytes of the input content claim
*/
@ApiModelProperty(
value = "The file size of the output content claim in bytes."
)
public Long getOutputContentClaimFileSizeBytes() {
return outputContentClaimFileSizeBytes;
}
@ -427,6 +521,9 @@ public class ProvenanceEventDTO {
/**
* @return whether or not the input content is still available
*/
@ApiModelProperty(
value = "Whether the input content is still available."
)
public Boolean getInputContentAvailable() {
return inputContentAvailable;
}
@ -438,6 +535,9 @@ public class ProvenanceEventDTO {
/**
* @return the Section in which the input Content Claim lives, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The section in which the input content claim lives."
)
public String getInputContentClaimSection() {
return inputContentClaimSection;
}
@ -449,6 +549,9 @@ public class ProvenanceEventDTO {
/**
* @return the Container in which the input Content Claim lives, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The container in which the input content claim lives."
)
public String getInputContentClaimContainer() {
return inputContentClaimContainer;
}
@ -460,6 +563,9 @@ public class ProvenanceEventDTO {
/**
* @return the Identifier of the input Content Claim, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The identifier of the input content claim."
)
public String getInputContentClaimIdentifier() {
return inputContentClaimIdentifier;
}
@ -471,6 +577,9 @@ public class ProvenanceEventDTO {
/**
* @return the offset into the the input Content Claim where the FlowFile's content begins, or <code>null</code> if no Content Claim exists
*/
@ApiModelProperty(
value = "The offset into the input content claim where the flowfiles content begins."
)
public Long getInputContentClaimOffset() {
return inputContentClaimOffset;
}
@ -482,6 +591,9 @@ public class ProvenanceEventDTO {
/**
* @return the formatted file size of the input content claim
*/
@ApiModelProperty(
value = "The file size of the input content claim formatted."
)
public String getInputContentClaimFileSize() {
return inputContentClaimFileSize;
}
@ -493,6 +605,9 @@ public class ProvenanceEventDTO {
/**
* @return the number of bytes of the input content claim
*/
@ApiModelProperty(
value = "The file size of the intput content claim in bytes."
)
public Long getInputContentClaimFileSizeBytes() {
return inputContentClaimFileSizeBytes;
}
@ -504,6 +619,9 @@ public class ProvenanceEventDTO {
/**
* @return whether or not replay is available
*/
@ApiModelProperty(
value = "Whether or not replay is available."
)
public Boolean getReplayAvailable() {
return replayAvailable;
}
@ -515,6 +633,9 @@ public class ProvenanceEventDTO {
/**
* @return the explanation as to why replay is unavailable
*/
@ApiModelProperty(
value = "Explanation as to why replay is unavailable."
)
public String getReplayExplanation() {
return replayExplanation;
}
@ -527,6 +648,10 @@ public class ProvenanceEventDTO {
* @return identifier of the FlowFile Queue / Connection from which the FlowFile was pulled to generate this event, or <code>null</code> if either the queue is unknown or the FlowFile was created
* by this event
*/
@ApiModelProperty(
value = "The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the "
+ "flowfile was generated from this event."
)
public String getSourceConnectionIdentifier() {
return sourceConnectionIdentifier;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceOptionsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -30,6 +31,9 @@ public class ProvenanceOptionsDTO {
/**
* @return available searchable fields for this NiFi instance
*/
@ApiModelProperty(
value = "The available searchable field for the NiFi."
)
public List<ProvenanceSearchableFieldDTO> getSearchableFields() {
return searchableFields;
}

19
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceRequestDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.Map;
@ -39,6 +40,9 @@ public class ProvenanceRequestDTO {
/**
* @return the search terms to use for this search
*/
@ApiModelProperty(
value = "The search terms used to perform the search."
)
public Map<String, String> getSearchTerms() {
return searchTerms;
}
@ -51,6 +55,9 @@ public class ProvenanceRequestDTO {
* @return earliest event time to include in the query
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The earliest event time to include in the query."
)
public Date getStartDate() {
return startDate;
}
@ -63,6 +70,9 @@ public class ProvenanceRequestDTO {
* @return latest event time to include in the query
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The latest event time to include in the query."
)
public Date getEndDate() {
return endDate;
}
@ -74,6 +84,9 @@ public class ProvenanceRequestDTO {
/**
* @return minimum file size to include in the query
*/
@ApiModelProperty(
value = "The minimum file size to include in the query."
)
public String getMinimumFileSize() {
return minimumFileSize;
}
@ -85,6 +98,9 @@ public class ProvenanceRequestDTO {
/**
* @return maximum file size to include in the query
*/
@ApiModelProperty(
value = "The maximum file size to include in the query."
)
public String getMaximumFileSize() {
return maximumFileSize;
}
@ -96,6 +112,9 @@ public class ProvenanceRequestDTO {
/**
* @return number of max results
*/
@ApiModelProperty(
value = "The maximum number of results to include."
)
public Integer getMaxResults() {
return maxResults;
}

22
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceResultsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import org.apache.nifi.web.api.dto.util.DateTimeAdapter;
import org.apache.nifi.web.api.dto.util.TimeAdapter;
@ -43,6 +44,9 @@ public class ProvenanceResultsDTO {
/**
* @return error messages
*/
@ApiModelProperty(
value = "Any errors that occurred while performing the provenance request."
)
public Set<String> getErrors() {
return errors;
}
@ -54,6 +58,9 @@ public class ProvenanceResultsDTO {
/**
* @return provenance events that matched the search criteria
*/
@ApiModelProperty(
value = "The provenance events that matched the search criteria."
)
public List<ProvenanceEventDTO> getProvenanceEvents() {
return provenanceEvents;
}
@ -65,6 +72,9 @@ public class ProvenanceResultsDTO {
/**
* @return total number of results formatted
*/
@ApiModelProperty(
value = "The total number of results formatted."
)
public String getTotal() {
return total;
}
@ -76,6 +86,9 @@ public class ProvenanceResultsDTO {
/**
* @return total number of results
*/
@ApiModelProperty(
value = "The total number of results."
)
public Long getTotalCount() {
return totalCount;
}
@ -88,6 +101,9 @@ public class ProvenanceResultsDTO {
* @return when the search was performed
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "Then the search was performed."
)
public Date getGenerated() {
return generated;
}
@ -100,6 +116,9 @@ public class ProvenanceResultsDTO {
* @return oldest event available in the provenance repository
*/
@XmlJavaTypeAdapter(DateTimeAdapter.class)
@ApiModelProperty(
value = "The oldest event available in the provenance repository."
)
public Date getOldestEvent() {
return oldestEvent;
}
@ -111,6 +130,9 @@ public class ProvenanceResultsDTO {
/**
* @return time offset on the server thats used for event time
*/
@ApiModelProperty(
value = "The time offset of the server that's used for event time."
)
public Integer getTimeOffset() {
return timeOffset;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceSearchableFieldDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -32,6 +33,9 @@ public class ProvenanceSearchableFieldDTO {
/**
* @return id of this searchable field
*/
@ApiModelProperty(
value = "The id of the searchable field."
)
public String getId() {
return id;
}
@ -43,6 +47,9 @@ public class ProvenanceSearchableFieldDTO {
/**
* @return the field
*/
@ApiModelProperty(
value = "The searchable field."
)
public String getField() {
return field;
}
@ -54,6 +61,9 @@ public class ProvenanceSearchableFieldDTO {
/**
* @return label for this field
*/
@ApiModelProperty(
value = "The label for the searchable field."
)
public String getLabel() {
return label;
}
@ -65,6 +75,9 @@ public class ProvenanceSearchableFieldDTO {
/**
* @return type of this field
*/
@ApiModelProperty(
value = "The type of the searchable field."
)
public String getType() {
return type;
}

28
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance.lineage;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -42,6 +43,9 @@ public class LineageDTO {
/**
* @return id of this lineage
*/
@ApiModelProperty(
value = "The id of this lineage query."
)
public String getId() {
return id;
}
@ -53,6 +57,9 @@ public class LineageDTO {
/**
* @return uri for this lineage
*/
@ApiModelProperty(
value = "The URI for this lineage query for later retrieval and deletion."
)
public String getUri() {
return uri;
}
@ -64,6 +71,9 @@ public class LineageDTO {
/**
* @return id of the node in the cluster where this lineage originated
*/
@ApiModelProperty(
value = "The id of the node where this lineage originated if clustered."
)
public String getClusterNodeId() {
return clusterNodeId;
}
@ -76,6 +86,9 @@ public class LineageDTO {
* @return submission time for this lineage
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "When the lineage query was submitted."
)
public Date getSubmissionTime() {
return submissionTime;
}
@ -88,6 +101,9 @@ public class LineageDTO {
* @return expiration of this lineage
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "When the lineage query will expire."
)
public Date getExpiration() {
return expiration;
}
@ -99,6 +115,9 @@ public class LineageDTO {
/**
* @return percent completed for this result
*/
@ApiModelProperty(
value = "The percent complete for the lineage query."
)
public Integer getPercentCompleted() {
return percentCompleted;
}
@ -110,6 +129,9 @@ public class LineageDTO {
/**
* @return whether or not the request is finished running
*/
@ApiModelProperty(
value = "Whether the lineage query has finished."
)
public Boolean getFinished() {
return finished;
}
@ -121,6 +143,9 @@ public class LineageDTO {
/**
* @return the lineage request
*/
@ApiModelProperty(
value = "The initial lineage result."
)
public LineageRequestDTO getRequest() {
return request;
}
@ -132,6 +157,9 @@ public class LineageDTO {
/**
* @return the results of this lineage
*/
@ApiModelProperty(
value = "The results of the lineage query."
)
public LineageResultsDTO getResults() {
return results;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance.lineage;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlType;
@ -31,7 +32,6 @@ public class LineageRequestDTO {
@XmlType(name = "lineageRequestType")
@XmlEnum
public enum LineageRequestType {
PARENTS,
CHILDREN,
FLOWFILE;
@ -45,6 +45,9 @@ public class LineageRequestDTO {
/**
* @return event id that was used to generate this lineage
*/
@ApiModelProperty(
value = ""
)
public Long getEventId() {
return eventId;
}
@ -57,6 +60,11 @@ public class LineageRequestDTO {
* @return type of lineage request. Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the
* lineage of for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.
*/
@ApiModelProperty(
value = "The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage "
+ "for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.",
allowableValues = "PARENTS, CHILDREN, and FLOWFILE"
)
public LineageRequestType getLineageRequestType() {
return lineageRequestType;
}
@ -68,6 +76,9 @@ public class LineageRequestDTO {
/**
* @return uuid that was used to generate this lineage
*/
@ApiModelProperty(
value = "The uuid that was used to generate the lineage."
)
public String getUuid() {
return uuid;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageResultsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance.lineage;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import java.util.Set;
import javax.xml.bind.annotation.XmlType;
@ -34,6 +35,9 @@ public class LineageResultsDTO {
/**
* @return any error messages
*/
@ApiModelProperty(
value = "Any errors that occurred while generating the lineage."
)
public Set<String> getErrors() {
return errors;
}
@ -45,6 +49,9 @@ public class LineageResultsDTO {
/**
* @return the nodes
*/
@ApiModelProperty(
value = "The nodes in the lineage."
)
public List<ProvenanceNodeDTO> getNodes() {
return nodes;
}
@ -56,6 +63,9 @@ public class LineageResultsDTO {
/**
* @return the links
*/
@ApiModelProperty(
value = "The links between the nodes in the lineage."
)
public List<ProvenanceLinkDTO> getLinks() {
return links;
}

16
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceLinkDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance.lineage;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
@ -36,6 +37,9 @@ public class ProvenanceLinkDTO {
/**
* @return source node id
*/
@ApiModelProperty(
value = "The source node id of the link."
)
public String getSourceId() {
return sourceId;
}
@ -47,6 +51,9 @@ public class ProvenanceLinkDTO {
/**
* @return target node id
*/
@ApiModelProperty(
value = "The target node id of the link."
)
public String getTargetId() {
return targetId;
}
@ -58,6 +65,9 @@ public class ProvenanceLinkDTO {
/**
* @return flowfile uuid that traversed this link
*/
@ApiModelProperty(
value = "The flowfile uuid that traversed the link."
)
public String getFlowFileUuid() {
return flowFileUuid;
}
@ -70,6 +80,9 @@ public class ProvenanceLinkDTO {
* @return timestamp of this link (based on the destination)
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "The timestamp of the link (based on the destination)."
)
public Date getTimestamp() {
return timestamp;
}
@ -81,6 +94,9 @@ public class ProvenanceLinkDTO {
/**
* @return number of millis since epoch
*/
@ApiModelProperty(
value = "The timestamp of this link in milliseconds."
)
public Long getMillis() {
return millis;
}

29
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.provenance.lineage;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.List;
@ -43,6 +44,9 @@ public class ProvenanceNodeDTO {
/**
* @return id of the node
*/
@ApiModelProperty(
value = "The id of the node."
)
public String getId() {
return id;
}
@ -54,6 +58,9 @@ public class ProvenanceNodeDTO {
/**
* @return flowfile uuid for this provenance event
*/
@ApiModelProperty(
value = "The uuid of the flowfile associated with the provenance event."
)
public String getFlowFileUuid() {
return flowFileUuid;
}
@ -65,6 +72,9 @@ public class ProvenanceNodeDTO {
/**
* @return parent flowfile uuids for this provenance event
*/
@ApiModelProperty(
value = "The uuid of the parent flowfiles of the provenance event."
)
public List<String> getParentUuids() {
return parentUuids;
}
@ -76,6 +86,9 @@ public class ProvenanceNodeDTO {
/**
* @return child flowfile uuids for this provenance event
*/
@ApiModelProperty(
value = "The uuid of the childrent flowfiles of the provenance event."
)
public List<String> getChildUuids() {
return childUuids;
}
@ -87,6 +100,9 @@ public class ProvenanceNodeDTO {
/**
* @return node identifier that this event/flowfile originated from
*/
@ApiModelProperty(
value = "The identifier of the node that this event/flowfile originated from."
)
public String getClusterNodeIdentifier() {
return clusterNodeIdentifier;
}
@ -98,6 +114,10 @@ public class ProvenanceNodeDTO {
/**
* @return type of node
*/
@ApiModelProperty(
value = "The type of the node.",
allowableValues = "FLOWFILE, EVENT"
)
public String getType() {
return type;
}
@ -109,6 +129,9 @@ public class ProvenanceNodeDTO {
/**
* @return this is an event node, this is the type of event
*/
@ApiModelProperty(
value = "If the type is EVENT, this is the type of event."
)
public String getEventType() {
return eventType;
}
@ -121,6 +144,9 @@ public class ProvenanceNodeDTO {
* @return timestamp of this node
*/
@XmlJavaTypeAdapter(TimestampAdapter.class)
@ApiModelProperty(
value = "The timestamp of the node formatted."
)
public Date getTimestamp() {
return timestamp;
}
@ -132,6 +158,9 @@ public class ProvenanceNodeDTO {
/**
* @return number of millis since epoch
*/
@ApiModelProperty(
value = "The timestamp of the node in milliseconds."
)
public Long getMillis() {
return millis;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.search;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -33,6 +34,9 @@ public class ComponentSearchResultDTO {
/**
* @return id of the component that matched
*/
@ApiModelProperty(
value = "The id of the component that matched the search."
)
public String getId() {
return id;
}
@ -44,6 +48,9 @@ public class ComponentSearchResultDTO {
/**
* @return group id of the component that matched
*/
@ApiModelProperty(
value = "The group id of the component that matched the search."
)
public String getGroupId() {
return groupId;
}
@ -55,6 +62,9 @@ public class ComponentSearchResultDTO {
/**
* @return name of the component that matched
*/
@ApiModelProperty(
value = "The name of the component that matched the search."
)
public String getName() {
return name;
}
@ -66,6 +76,9 @@ public class ComponentSearchResultDTO {
/**
* @return What matched the search string for this component
*/
@ApiModelProperty(
value = "What matched the search from the component."
)
public List<String> getMatches() {
return matches;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.search;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -30,6 +31,9 @@ public class NodeSearchResultDTO {
/**
* @return id of the node that was matched
*/
@ApiModelProperty(
value = "The id of the node that matched the search."
)
public String getId() {
return id;
}
@ -41,6 +45,9 @@ public class NodeSearchResultDTO {
/**
* @return address of the node that was matched
*/
@ApiModelProperty(
value = "The address of the node that matched the search."
)
public String getAddress() {
return address;
}

22
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.search;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -37,6 +38,9 @@ public class SearchResultsDTO {
/**
* @return The processors that matched the search
*/
@ApiModelProperty(
value = "The processors that matched the search."
)
public List<ComponentSearchResultDTO> getProcessorResults() {
return processorResults;
}
@ -48,6 +52,9 @@ public class SearchResultsDTO {
/**
* @return connections that matched the search
*/
@ApiModelProperty(
value = "The connections that matched the search."
)
public List<ComponentSearchResultDTO> getConnectionResults() {
return connectionResults;
}
@ -59,6 +66,9 @@ public class SearchResultsDTO {
/**
* @return process group that matched the search
*/
@ApiModelProperty(
value = "The process groups that matched the search."
)
public List<ComponentSearchResultDTO> getProcessGroupResults() {
return processGroupResults;
}
@ -70,6 +80,9 @@ public class SearchResultsDTO {
/**
* @return input ports that matched the search
*/
@ApiModelProperty(
value = "The input ports that matched the search."
)
public List<ComponentSearchResultDTO> getInputPortResults() {
return inputPortResults;
}
@ -77,6 +90,9 @@ public class SearchResultsDTO {
/**
* @return output ports that matched the search
*/
@ApiModelProperty(
value = "The output ports that matched the search."
)
public List<ComponentSearchResultDTO> getOutputPortResults() {
return outputPortResults;
}
@ -92,6 +108,9 @@ public class SearchResultsDTO {
/**
* @return remote process groups that matched the search
*/
@ApiModelProperty(
value = "The remote process groups that matched the search."
)
public List<ComponentSearchResultDTO> getRemoteProcessGroupResults() {
return remoteProcessGroupResults;
}
@ -103,6 +122,9 @@ public class SearchResultsDTO {
/**
* @return funnels that matched the search
*/
@ApiModelProperty(
value = "The funnels that matched the search."
)
public List<ComponentSearchResultDTO> getFunnelResults() {
return funnelResults;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.search;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -29,6 +30,9 @@ public class UserGroupSearchResultDTO {
/**
* @return name of the group that matched
*/
@ApiModelProperty(
value = "The name of the group that matched the search."
)
public String getGroup() {
return group;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.search;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -30,6 +31,9 @@ public class UserSearchResultDTO {
/**
* @return dn of the user that matched
*/
@ApiModelProperty(
value = "The dn of the user that matched the search."
)
public String getUserDn() {
return userDn;
}
@ -41,6 +45,9 @@ public class UserSearchResultDTO {
/**
* @return username of user that matched
*/
@ApiModelProperty(
value = "The name of the user that matched the search."
)
public String getUserName() {
return userName;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -37,6 +38,9 @@ public class ClusterConnectionStatusDTO {
* @return time the status were last refreshed
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The time the status was last refreshed."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}
@ -48,6 +52,9 @@ public class ClusterConnectionStatusDTO {
/**
* @return connection id
*/
@ApiModelProperty(
value = "The id of the connection."
)
public String getConnectionId() {
return connectionId;
}
@ -59,6 +66,9 @@ public class ClusterConnectionStatusDTO {
/**
* @return connection name
*/
@ApiModelProperty(
value = "The name of the connection."
)
public String getConnectionName() {
return connectionName;
}
@ -70,6 +80,9 @@ public class ClusterConnectionStatusDTO {
/**
* @return The collection of node connection status DTO
*/
@ApiModelProperty(
value = "The connection status for each node."
)
public Collection<NodeConnectionStatusDTO> getNodeConnectionStatus() {
return nodeConnectionStatus;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -37,6 +38,9 @@ public class ClusterPortStatusDTO {
* @return the time the status were last refreshed
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The time the status was last refreshed."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}
@ -48,6 +52,9 @@ public class ClusterPortStatusDTO {
/**
* @return port status from each node in the cluster
*/
@ApiModelProperty(
value = "The port status for each node."
)
public Collection<NodePortStatusDTO> getNodePortStatus() {
return nodePortStatus;
}
@ -59,6 +66,9 @@ public class ClusterPortStatusDTO {
/**
* @return port id
*/
@ApiModelProperty(
value = "The id of the port."
)
public String getPortId() {
return portId;
}
@ -70,6 +80,9 @@ public class ClusterPortStatusDTO {
/**
* @return port name
*/
@ApiModelProperty(
value = "The name of the port."
)
public String getPortName() {
return portName;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -39,6 +40,9 @@ public class ClusterProcessGroupStatusDTO {
* @return The time the status were last refreshed
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The time when the stats was last refreshed."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}
@ -52,6 +56,9 @@ public class ClusterProcessGroupStatusDTO {
*
* @return The process group id
*/
@ApiModelProperty(
value = "The id of the process group."
)
public String getProcessGroupId() {
return processGroupId;
}
@ -65,6 +72,9 @@ public class ClusterProcessGroupStatusDTO {
*
* @return The process group name
*/
@ApiModelProperty(
value = "The name of the process group."
)
public String getProcessGroupName() {
return processGroupName;
}
@ -78,6 +88,9 @@ public class ClusterProcessGroupStatusDTO {
*
* @return The collection of node process group status DTO
*/
@ApiModelProperty(
value = "The process groups status for each node."
)
public Collection<NodeProcessGroupStatusDTO> getNodeProcessGroupStatus() {
return nodeProcessGroupStatus;
}

20
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -39,6 +40,9 @@ public class ClusterProcessorStatusDTO {
* @return time the status were last refreshed
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The time when the status was last refreshed."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}
@ -50,6 +54,9 @@ public class ClusterProcessorStatusDTO {
/**
* @return processor id
*/
@ApiModelProperty(
value = "The processor id."
)
public String getProcessorId() {
return processorId;
}
@ -61,6 +68,9 @@ public class ClusterProcessorStatusDTO {
/**
* @return processor name
*/
@ApiModelProperty(
value = "The processor name."
)
public String getProcessorName() {
return processorName;
}
@ -72,6 +82,9 @@ public class ClusterProcessorStatusDTO {
/**
* @return processor type
*/
@ApiModelProperty(
value = "The processor type."
)
public String getProcessorType() {
return processorType;
}
@ -83,6 +96,10 @@ public class ClusterProcessorStatusDTO {
/**
* @return processor run status
*/
@ApiModelProperty(
value = "The processor state.",
allowableValues = "RUNNING, STOPPED, DISABLED, INVALID"
)
public String getProcessorRunStatus() {
return processorRunStatus;
}
@ -96,6 +113,9 @@ public class ClusterProcessorStatusDTO {
*
* @return The collection of node processor status DTO
*/
@ApiModelProperty(
value = "The processor status for each node."
)
public Collection<NodeProcessorStatusDTO> getNodeProcessorStatus() {
return nodeProcessorStatus;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -37,6 +38,9 @@ public class ClusterRemoteProcessGroupStatusDTO {
* @return the time the status were last refreshed
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The time when the remote process group status was last refreshed."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}
@ -48,6 +52,9 @@ public class ClusterRemoteProcessGroupStatusDTO {
/**
* @return remote process group status from each node in the cluster
*/
@ApiModelProperty(
value = "The remote process group status from each node in the cluster."
)
public Collection<NodeRemoteProcessGroupStatusDTO> getNodeRemoteProcessGroupStatus() {
return nodeRemoteProcessGroupStatus;
}
@ -59,6 +66,9 @@ public class ClusterRemoteProcessGroupStatusDTO {
/**
* @return remote process group id
*/
@ApiModelProperty(
value = "The id of the remote process group."
)
public String getRemoteProcessGroupId() {
return remoteProcessGroupId;
}
@ -70,6 +80,9 @@ public class ClusterRemoteProcessGroupStatusDTO {
/**
* @return remote process group name
*/
@ApiModelProperty(
value = "The name of the remote process group."
)
public String getRemoteProcessGroupName() {
return remoteProcessGroupName;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import javax.xml.bind.annotation.XmlType;
@ -31,6 +32,9 @@ public class ClusterStatusDTO {
/**
* @return collection of the node status DTOs
*/
@ApiModelProperty(
value = "The status of each node."
)
public Collection<NodeStatusDTO> getNodeStatus() {
return nodeStatus;
}

10
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -36,6 +37,9 @@ public class ClusterStatusHistoryDTO {
* @return when this status history was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "When the status history was generated."
)
public Date getGenerated() {
return generated;
}
@ -47,6 +51,9 @@ public class ClusterStatusHistoryDTO {
/**
* @return status history from each node in the cluster
*/
@ApiModelProperty(
value = "The status history from each node."
)
public Collection<NodeStatusHistoryDTO> getNodeStatusHistory() {
return nodeStatusHistory;
}
@ -58,6 +65,9 @@ public class ClusterStatusHistoryDTO {
/**
* @return status history for this component across the entire cluster
*/
@ApiModelProperty(
value = "The status history for the entire cluster."
)
public StatusHistoryDTO getClusterStatusHistory() {
return clusterStatusHistory;
}

39
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -42,6 +43,9 @@ public class ConnectionStatusDTO {
/**
* @return The connection id
*/
@ApiModelProperty(
value = "The id of the connection."
)
public String getId() {
return id;
}
@ -51,8 +55,11 @@ public class ConnectionStatusDTO {
}
/**
* @return the ID of the Process Group to which this processor belongs.
* @return the ID of the Process Group to which this connection belongs.
*/
@ApiModelProperty(
value = "The id of the process group the connection belongs to."
)
public String getGroupId() {
return groupId;
}
@ -64,6 +71,9 @@ public class ConnectionStatusDTO {
/**
* @return name of this connection
*/
@ApiModelProperty(
value = "The name of the connection."
)
public String getName() {
return name;
}
@ -75,6 +85,9 @@ public class ConnectionStatusDTO {
/**
* @return total count of flow files that are queued
*/
@ApiModelProperty(
value = "The number of flowfiles that are queued."
)
public String getQueuedCount() {
return queuedCount;
}
@ -86,6 +99,9 @@ public class ConnectionStatusDTO {
/**
* @return total size of flow files that are queued
*/
@ApiModelProperty(
value = "The total size of flowfiles that are queued formatted."
)
public String getQueuedSize() {
return queuedSize;
}
@ -97,6 +113,9 @@ public class ConnectionStatusDTO {
/**
* @return The total count and size of queued flow files
*/
@ApiModelProperty(
value = "The total count and size of queued flowfiles formatted."
)
public String getQueued() {
return queued;
}
@ -108,6 +127,9 @@ public class ConnectionStatusDTO {
/**
* @return id of the source of this connection
*/
@ApiModelProperty(
value = "The id of the source of the connection."
)
public String getSourceId() {
return sourceId;
}
@ -119,6 +141,9 @@ public class ConnectionStatusDTO {
/**
* @return name of the source of this connection
*/
@ApiModelProperty(
value = "The name of the source of the connection."
)
public String getSourceName() {
return sourceName;
}
@ -130,6 +155,9 @@ public class ConnectionStatusDTO {
/**
* @return id of the destination of this connection
*/
@ApiModelProperty(
value = "The id of the destination of the connection."
)
public String getDestinationId() {
return destinationId;
}
@ -141,6 +169,9 @@ public class ConnectionStatusDTO {
/**
* @return name of the destination of this connection
*/
@ApiModelProperty(
value = "The name of the destination of the connection."
)
public String getDestinationName() {
return destinationName;
}
@ -152,6 +183,9 @@ public class ConnectionStatusDTO {
/**
* @return input for this connection
*/
@ApiModelProperty(
value = "The input count/size for the connection in the last 5 minutes."
)
public String getInput() {
return input;
}
@ -163,6 +197,9 @@ public class ConnectionStatusDTO {
/**
* @return output for this connection
*/
@ApiModelProperty(
value = "The output count/sie for the connection in the last 5 minutes."
)
public String getOutput() {
return output;
}

34
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.BulletinDTO;
@ -45,6 +46,9 @@ public class ControllerStatusDTO {
*
* @return The active thread count
*/
@ApiModelProperty(
value = "The number of active threads in the NiFi."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -56,6 +60,9 @@ public class ControllerStatusDTO {
/**
* @return queue for the controller
*/
@ApiModelProperty(
value = "The number of flowfilew queued in the NiFi."
)
public String getQueued() {
return queued;
}
@ -67,6 +74,9 @@ public class ControllerStatusDTO {
/**
* @return Used in clustering, will report the number of nodes connected vs the number of nodes in the cluster
*/
@ApiModelProperty(
value = "When clustered, reports the number of nodes connected vs the number of nodes in the cluster."
)
public String getConnectedNodes() {
return connectedNodes;
}
@ -78,6 +88,9 @@ public class ControllerStatusDTO {
/**
* @return System bulletins to be reported to the user
*/
@ApiModelProperty(
value = "System level bulletins to be reported to the user."
)
public List<BulletinDTO> getBulletins() {
return bulletins;
}
@ -89,6 +102,9 @@ public class ControllerStatusDTO {
/**
* @return whether or not there are pending user requests
*/
@ApiModelProperty(
value = "Whether there are any pending user account requests."
)
public Boolean getHasPendingAccounts() {
return hasPendingAccounts;
}
@ -100,6 +116,9 @@ public class ControllerStatusDTO {
/**
* @return number of running components in this controller
*/
@ApiModelProperty(
value = "The number of running components in the NiFi."
)
public Integer getRunningCount() {
return runningCount;
}
@ -111,6 +130,9 @@ public class ControllerStatusDTO {
/**
* @return number of stopped components in this controller
*/
@ApiModelProperty(
value = "The number of stopped components in the NiFi."
)
public Integer getStoppedCount() {
return stoppedCount;
}
@ -122,6 +144,9 @@ public class ControllerStatusDTO {
/**
* @return number of invalid components in this controller
*/
@ApiModelProperty(
value = "The number of invalid components in the NiFi."
)
public Integer getInvalidCount() {
return invalidCount;
}
@ -133,6 +158,9 @@ public class ControllerStatusDTO {
/**
* @return number of disabled components in this controller
*/
@ApiModelProperty(
value = "The number of disabled components in the NiFi."
)
public Integer getDisabledCount() {
return disabledCount;
}
@ -144,6 +172,9 @@ public class ControllerStatusDTO {
/**
* @return number of active remote ports in this controller
*/
@ApiModelProperty(
value = "The number of active remote ports in the NiFi."
)
public Integer getActiveRemotePortCount() {
return activeRemotePortCount;
}
@ -155,6 +186,9 @@ public class ControllerStatusDTO {
/**
* @return number of inactive remote ports in this controller
*/
@ApiModelProperty(
value = "The number of inactive remote ports in the NiFi."
)
public Integer getInactiveRemotePortCount() {
return inactiveRemotePortCount;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeConnectionStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -31,6 +32,9 @@ public class NodeConnectionStatusDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -42,6 +46,9 @@ public class NodeConnectionStatusDTO {
/**
* @return connection's status
*/
@ApiModelProperty(
value = "The connection status from the node."
)
public ConnectionStatusDTO getConnectionStatus() {
return connectionStatus;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodePortStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -31,6 +32,9 @@ public class NodePortStatusDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -42,6 +46,9 @@ public class NodePortStatusDTO {
/**
* @return port status
*/
@ApiModelProperty(
value = "The port status from the node."
)
public PortStatusDTO getPortStatus() {
return portStatus;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessGroupStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -33,6 +34,9 @@ public class NodeProcessGroupStatusDTO {
*
* @return The node DTO
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -46,6 +50,9 @@ public class NodeProcessGroupStatusDTO {
*
* @return The process group status
*/
@ApiModelProperty(
value = "The process group status from the node."
)
public ProcessGroupStatusDTO getProcessGroupStatus() {
return processGroupStatus;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessorStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -31,6 +32,9 @@ public class NodeProcessorStatusDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -42,6 +46,9 @@ public class NodeProcessorStatusDTO {
/**
* @return processor's status
*/
@ApiModelProperty(
value = "The processor status from the node."
)
public ProcessorStatusDTO getProcessorStatus() {
return processorStatus;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeRemoteProcessGroupStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -31,6 +32,9 @@ public class NodeRemoteProcessGroupStatusDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -42,6 +46,9 @@ public class NodeRemoteProcessGroupStatusDTO {
/**
* @return remote process group's status
*/
@ApiModelProperty(
value = "The remote process group status from the node."
)
public RemoteProcessGroupStatusDTO getRemoteProcessGroupStatus() {
return remoteProcessGroupStatus;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -31,6 +32,9 @@ public class NodeStatusDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -42,6 +46,9 @@ public class NodeStatusDTO {
/**
* @return the controller status
*/
@ApiModelProperty(
value = "The controller status for each node."
)
public ProcessGroupStatusDTO getControllerStatus() {
return controllerStatus;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusHistoryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.NodeDTO;
@ -31,6 +32,9 @@ public class NodeStatusHistoryDTO {
/**
* @return the node
*/
@ApiModelProperty(
value = "The node."
)
public NodeDTO getNode() {
return node;
}
@ -42,6 +46,9 @@ public class NodeStatusHistoryDTO {
/**
* @return processor status history
*/
@ApiModelProperty(
value = "The processor status for each node."
)
public StatusHistoryDTO getStatusHistory() {
return statusHistory;
}

25
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -36,6 +37,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return whether this port has incoming or outgoing connections to a remote NiFi
*/
@ApiModelProperty(
value = "Whether the port has incoming or outgoing connections to a remote NiFi."
)
public Boolean isTransmitting() {
return transmitting;
}
@ -47,6 +51,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return the active thread count for this port
*/
@ApiModelProperty(
value = "The active thread count for the port."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -58,6 +65,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return id of this port
*/
@ApiModelProperty(
value = "The id of the port."
)
public String getId() {
return id;
}
@ -69,6 +79,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return id of the group this port resides in
*/
@ApiModelProperty(
value = "The id of the parent process group of the port."
)
public String getGroupId() {
return groupId;
}
@ -80,6 +93,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return name of this port
*/
@ApiModelProperty(
value = "The name of the port."
)
public String getName() {
return name;
}
@ -91,6 +107,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return run status of this port
*/
@ApiModelProperty(
value = "The run status of the port."
)
public String getRunStatus() {
return runStatus;
}
@ -102,6 +121,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return The total count and size of flow files that have been accepted in the last five minutes
*/
@ApiModelProperty(
value = "The count/size of flowfiles that have been accepted in the last 5 minutes."
)
public String getInput() {
return input;
}
@ -113,6 +135,9 @@ public class PortStatusDTO extends StatusDTO {
/**
* @return The total count and size of flow files that have been processed in the last five minutes
*/
@ApiModelProperty(
value = "The count/size of flowfiles that have been processed in the last 5 minutes."
)
public String getOutput() {
return output;
}

61
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Collection;
import java.util.Date;
import javax.xml.bind.annotation.XmlType;
@ -55,6 +56,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The id for the process group
*/
@ApiModelProperty(
value = "The id of the process group."
)
public String getId() {
return id;
}
@ -66,6 +70,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
/**
* @return name of this process group
*/
@ApiModelProperty(
value = "The name of this process group."
)
public String getName() {
return name;
}
@ -77,6 +84,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
/**
* @return active thread count for this process group
*/
@ApiModelProperty(
value = "The active thread count for this process group."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -90,6 +100,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The status of all connections
*/
@ApiModelProperty(
value = "The status of all conenctions in the process group."
)
public Collection<ConnectionStatusDTO> getConnectionStatus() {
return connectionStatus;
}
@ -103,6 +116,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The status of all process groups
*/
@ApiModelProperty(
value = "The status of all process groups in the process group."
)
public Collection<ProcessGroupStatusDTO> getProcessGroupStatus() {
return processGroupStatus;
}
@ -116,6 +132,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The status of all remote process groups
*/
@ApiModelProperty(
value = "The status of all remote process groups in the process group.."
)
public Collection<RemoteProcessGroupStatusDTO> getRemoteProcessGroupStatus() {
return remoteProcessGroupStatus;
}
@ -129,6 +148,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The status of all processors
*/
@ApiModelProperty(
value = "The status of all processors in the process group."
)
public Collection<ProcessorStatusDTO> getProcessorStatus() {
return processorStatus;
}
@ -142,6 +164,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The status of all input ports
*/
@ApiModelProperty(
value = "The status of all input ports in the process group."
)
public Collection<PortStatusDTO> getInputPortStatus() {
return inputPortStatus;
}
@ -155,6 +180,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The status of all output ports
*/
@ApiModelProperty(
value = "The status of all output ports in the process group."
)
public Collection<PortStatusDTO> getOutputPortStatus() {
return outputPortStatus;
}
@ -168,6 +196,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The output stats
*/
@ApiModelProperty(
value = "The output count/size for the process group in the last 5 minutes."
)
public String getOutput() {
return output;
}
@ -181,6 +212,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The transferred status for this process group
*/
@ApiModelProperty(
value = "The count/size transferred to/frome queues in the process group in the last 5 minutes."
)
public String getTransferred() {
return transferred;
}
@ -194,6 +228,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The received stats for this process group
*/
@ApiModelProperty(
value = "The count/size sent to the process group in the last 5 minutes."
)
public String getReceived() {
return received;
}
@ -207,6 +244,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The sent stats for this process group
*/
@ApiModelProperty(
value = "The count/size sent from this process group in the last 5 minutes."
)
public String getSent() {
return sent;
}
@ -220,6 +260,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The queued count for this process group
*/
@ApiModelProperty(
value = "The count that is queued for the process group."
)
public String getQueuedCount() {
return queuedCount;
}
@ -233,6 +276,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The queued size for this process group
*/
@ApiModelProperty(
value = "The size that is queued for the process group."
)
public String getQueuedSize() {
return queuedSize;
}
@ -246,6 +292,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The queued stats
*/
@ApiModelProperty(
value = "The count/size that is queued in the the process group."
)
public String getQueued() {
return queued;
}
@ -259,6 +308,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The read stats
*/
@ApiModelProperty(
value = "The number of bytes read in the last 5 minutes."
)
public String getRead() {
return read;
}
@ -272,6 +324,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The written stats
*/
@ApiModelProperty(
value = "The number of bytes written in the last 5 minutes."
)
public String getWritten() {
return written;
}
@ -285,6 +340,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
*
* @return The input stats
*/
@ApiModelProperty(
value = "The input count/size for the process group in the last 5 minutes."
)
public String getInput() {
return input;
}
@ -299,6 +357,9 @@ public class ProcessGroupStatusDTO extends StatusDTO {
* @return The the status was calculated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The time the status for the process group was last refreshed."
)
public Date getStatsLastRefreshed() {
return statsLastRefreshed;
}

38
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -44,6 +45,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return The processor id
*/
@ApiModelProperty(
value = "The id of the processor."
)
public String getId() {
return id;
}
@ -55,6 +59,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return The processor name
*/
@ApiModelProperty(
value = "The name of the prcessor."
)
public String getName() {
return name;
}
@ -66,6 +73,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return The processor type
*/
@ApiModelProperty(
value = "The type of the processor."
)
public String getType() {
return type;
}
@ -77,6 +87,10 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return run status of this processor
*/
@ApiModelProperty(
value = "The state of the processor.",
allowableValues = "RUNNING, STOPPED, DISABLED, INVALID"
)
public String getRunStatus() {
return runStatus;
}
@ -88,6 +102,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return The total count and size of flow files that have been accepted in the last five minutes
*/
@ApiModelProperty(
value = "The count/size of flowfiles that have been accepted in the last 5 minutes."
)
public String getInput() {
return input;
}
@ -99,6 +116,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return number of bytes read
*/
@ApiModelProperty(
value = "The number of bytes read in the last 5 minutes."
)
public String getRead() {
return read;
}
@ -110,6 +130,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return number of bytes written
*/
@ApiModelProperty(
value = "The number of bytes written in the last 5 minutes."
)
public String getWritten() {
return written;
}
@ -121,6 +144,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return the ID of the Process Group to which this processor belongs.
*/
@ApiModelProperty(
value = "The id of the parent process group to which the processor belongs."
)
public String getGroupId() {
return groupId;
}
@ -132,6 +158,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return The total count and size of flow files that have been processed in the last five minutes
*/
@ApiModelProperty(
value = "The count/size of flowfiles that have been processed in the last 5 minutes."
)
public String getOutput() {
return output;
}
@ -143,6 +172,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return number of threads currently running for this Processor
*/
@ApiModelProperty(
value = "The number of threads currently executing in the processor."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -154,6 +186,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return number of task this connectable has had over the last 5 minutes
*/
@ApiModelProperty(
value = "The total number of task this connectable has completed over the last 5 minutes."
)
public String getTasks() {
return tasks;
}
@ -165,6 +200,9 @@ public class ProcessorStatusDTO extends StatusDTO {
/**
* @return total duration of all tasks for this connectable over the last 5 minutes
*/
@ApiModelProperty(
value = "The total duration of all tasks for this connectable over the last 5 minutes."
)
public String getTasksDuration() {
return tasksDuration;
}

16
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemotePortStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -33,6 +34,9 @@ public class RemotePortStatusDTO {
/**
* @return id of the connection this remote port is connected to
*/
@ApiModelProperty(
value = "The id of the conneciton the remote is connected to."
)
public String getConnectionId() {
return connectionId;
}
@ -44,6 +48,9 @@ public class RemotePortStatusDTO {
/**
* @return id of the remote port
*/
@ApiModelProperty(
value = "The id of the remote port."
)
public String getId() {
return id;
}
@ -55,6 +62,9 @@ public class RemotePortStatusDTO {
/**
* @return name of the remote port
*/
@ApiModelProperty(
value = "The name of the remote port."
)
public String getName() {
return name;
}
@ -66,6 +76,9 @@ public class RemotePortStatusDTO {
/**
* @return whether or not the remote port exists
*/
@ApiModelProperty(
value = "Whether or not the remote port exists."
)
public Boolean getExists() {
return exists;
}
@ -77,6 +90,9 @@ public class RemotePortStatusDTO {
/**
* @return whether or not the remote port is running
*/
@ApiModelProperty(
value = "Whether or not the remote port is running."
)
public Boolean getRunning() {
return running;
}

28
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
@ -40,6 +41,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return The id for the remote process group
*/
@ApiModelProperty(
value = "The id of the remote process group."
)
public String getId() {
return id;
}
@ -51,6 +55,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return id of the group this remote process group is in
*/
@ApiModelProperty(
value = "The id of the parent process group the remote process group resides in."
)
public String getGroupId() {
return groupId;
}
@ -62,6 +69,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return URI of the target system
*/
@ApiModelProperty(
value = "The URI of the target system."
)
public String getTargetUri() {
return targetUri;
}
@ -73,6 +83,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return name of this remote process group
*/
@ApiModelProperty(
value = "The name of the remote process group."
)
public String getName() {
return name;
}
@ -84,6 +97,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return transmission status of this remote process group
*/
@ApiModelProperty(
value = "The transmission status of the remote process group."
)
public String getTransmissionStatus() {
return transmissionStatus;
}
@ -95,6 +111,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return number of active threads
*/
@ApiModelProperty(
value = "The number of active threads for the remote process group."
)
public Integer getActiveThreadCount() {
return activeThreadCount;
}
@ -106,6 +125,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return any remote authorization issues for this remote process group
*/
@ApiModelProperty(
value = "Any remote authorization issues for the remote process group."
)
public List<String> getAuthorizationIssues() {
return authorizationIssues;
}
@ -117,6 +139,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return Formatted description of the amount of data sent to this remote process group
*/
@ApiModelProperty(
value = "The count/size of the flowfiles sent to the remote process group in the last 5 minutes."
)
public String getSent() {
return sent;
}
@ -128,6 +153,9 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO {
/**
* @return Formatted description of the amount of data received from this remote process group
*/
@ApiModelProperty(
value = "The count/size of the flowfiles received from the remote process group in the last 5 minutes."
)
public String getReceived() {
return received;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.List;
import javax.xml.bind.annotation.XmlType;
import org.apache.nifi.web.api.dto.BulletinDTO;
@ -31,6 +32,9 @@ public abstract class StatusDTO {
/**
* @return Bulletins for this component
*/
@ApiModelProperty(
value = "The current bulletins for the component."
)
public List<BulletinDTO> getBulletins() {
return bulletins;
}

14
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDescriptorDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -25,7 +26,6 @@ import javax.xml.bind.annotation.XmlType;
public class StatusDescriptorDTO {
public enum Formatter {
COUNT,
DURATION,
DATA_SIZE
@ -49,6 +49,9 @@ public class StatusDescriptorDTO {
/**
* @return name of this status field
*/
@ApiModelProperty(
value = "The name of the status field."
)
public String getField() {
return field;
}
@ -60,6 +63,9 @@ public class StatusDescriptorDTO {
/**
* @return label of this status field
*/
@ApiModelProperty(
value = "The label for the status field."
)
public String getLabel() {
return label;
}
@ -71,6 +77,9 @@ public class StatusDescriptorDTO {
/**
* @return description of this status field
*/
@ApiModelProperty(
value = "The description of the status field."
)
public String getDescription() {
return description;
}
@ -82,6 +91,9 @@ public class StatusDescriptorDTO {
/**
* @return formatter for this descriptor
*/
@ApiModelProperty(
value = "The formatter for the status descriptor."
)
public String getFormatter() {
return formatter;
}

13
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
@ -40,6 +41,9 @@ public class StatusHistoryDTO {
* @return when this status history was generated
*/
@XmlJavaTypeAdapter(TimeAdapter.class)
@ApiModelProperty(
value = "The timestamp when the status history was generated."
)
public Date getGenerated() {
return generated;
}
@ -51,6 +55,9 @@ public class StatusHistoryDTO {
/**
* @return The component details for this status history
*/
@ApiModelProperty(
value = "The component details for the status history."
)
public LinkedHashMap<String, String> getDetails() {
return details;
}
@ -62,6 +69,9 @@ public class StatusHistoryDTO {
/**
* @return Descriptors for each supported status field
*/
@ApiModelProperty(
value = "The descriptor for each support status field."
)
public List<StatusDescriptorDTO> getFieldDescriptors() {
return fieldDescriptors;
}
@ -73,6 +83,9 @@ public class StatusHistoryDTO {
/**
* @return The status snapshots
*/
@ApiModelProperty(
value = "The status snapshots."
)
public List<StatusSnapshotDTO> getStatusSnapshots() {
return statusSnapshots;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDetailDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlType;
/**
@ -30,6 +31,9 @@ public class StatusHistoryDetailDTO {
/**
* @return label for this status detail
*/
@ApiModelProperty(
value = "The label for the status detail."
)
public String getLabel() {
return label;
}
@ -41,6 +45,9 @@ public class StatusHistoryDetailDTO {
/**
* @return value for this status detail
*/
@ApiModelProperty(
value = "The value for the status detail."
)
public String getValue() {
return value;
}

7
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusSnapshotDTO.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.dto.status;
import com.wordnik.swagger.annotations.ApiModelProperty;
import java.util.Date;
import java.util.Map;
import javax.xml.bind.annotation.XmlType;
@ -32,6 +33,9 @@ public class StatusSnapshotDTO {
/**
* @return timestamp of this snapshot
*/
@ApiModelProperty(
value = "The timestamp of the snapshot."
)
public Date getTimestamp() {
return timestamp;
}
@ -43,6 +47,9 @@ public class StatusSnapshotDTO {
/**
* @return status metrics
*/
@ApiModelProperty(
value = "The status metrics."
)
public Map<String, Long> getStatusMetrics() {
return statusMetrics;
}

4
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/Entity.java
View File

@ -16,6 +16,7 @@
*/
package org.apache.nifi.web.api.entity;
import com.wordnik.swagger.annotations.ApiModelProperty;
import javax.xml.bind.annotation.XmlRootElement;
import org.apache.nifi.web.api.dto.RevisionDTO;
@ -30,6 +31,9 @@ public class Entity {
/**
* @return revision for this request/response
*/
@ApiModelProperty(
value = "The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses."
)
public RevisionDTO getRevision() {
return revision;
}

137
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/pom.xml
View File

@ -23,56 +23,6 @@
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-web-api</artifactId>
<packaging>war</packaging>
<profiles>
<profile>
<id>docs</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<build>
<resources>
<resource>
<directory>src/main/enunciate/images</directory>
<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/docs/rest-api/img</targetPath>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.codehaus.enunciate</groupId>
<artifactId>maven-enunciate-plugin</artifactId>
<version>1.28</version>
<configuration>
<configFile>src/main/enunciate/enunciate.xml</configFile>
</configuration>
<executions>
<execution>
<goals>
<goal>docs</goal>
</goals>
<configuration>
<docsDir>${project.build.directory}/${project.artifactId}-${project.version}/docs/rest-api</docsDir>
</configuration>
</execution>
</executions>
<!--
Enunciate currently uses APT to process class annotations. APT
has been deprecated in Java 7. As a result, a direct dependency
must be added to tools.jar where APT is located.
-->
<dependencies>
<dependency>
<groupId>com.sun</groupId>
<artifactId>tools</artifactId>
<version>1.7.0</version>
<scope>system</scope>
<systemPath>${java.home}/../lib/tools.jar</systemPath>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</profile>
</profiles>
<build>
<resources>
<resource>
@ -89,6 +39,69 @@
<reuseForks>false</reuseForks>
</configuration>
</plugin>
<plugin>
<groupId>com.github.kongchen</groupId>
<artifactId>swagger-maven-plugin</artifactId>
<version>3.0-M1</version>
<executions>
<execution>
<phase>compile</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
<apiSources>
<apiSource>
<locations>org.apache.nifi.web.api</locations>
<schemes>http,https</schemes>
<basePath>/nifi-api</basePath>
<info>
<title>NiFi Rest Api</title>
<version>${project.version}</version>
<description>
The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and
stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description,
definitions of the expected input and output, potential response codes, and the authorities required
to invoke each service.
</description>
<contact>
<email>dev@nifi.incubator.apache.org</email>
<url>https://nifi.incubator.apache.org</url>
</contact>
<license>
<url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
<name>Apache 2.0</name>
</license>
</info>
<templatePath>classpath:/templates/index.html.hbs</templatePath>
<outputPath>${project.build.directory}/${project.artifactId}-${project.version}/docs/rest-api/index.html</outputPath>
<swaggerDirectory>${project.build.directory}/swagger-ui</swaggerDirectory>
</apiSource>
</apiSources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<id>copy-resources</id>
<phase>validate</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/${project.artifactId}-${project.version}/docs/rest-api/images</outputDirectory>
<resources>
<resource>
<directory>src/main/resources/images</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
@ -112,22 +125,10 @@
<artifactId>nifi-client-dto</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.codehaus.enunciate</groupId>
<artifactId>enunciate-core-annotations</artifactId>
<version>1.28</version>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-client-dto</artifactId>
<classifier>sources</classifier>
<scope>provided</scope>
<optional>true</optional>
<version>0.1.0-incubating-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
<artifactId>nifi-data-provenance-utils</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.nifi</groupId>
@ -197,6 +198,11 @@
<artifactId>javax.servlet-api</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-annotations</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
@ -207,6 +213,11 @@
<artifactId>commons-collections4</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>

36
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/enunciate/enunciate.xml
View File

@ -1,36 +0,0 @@
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<enunciate label="NiFi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.28.xsd">
<disable-rule id="all.warnings"/>
<modules>
<c disabled="true"/>
<obj-c disabled="true"/>
<csharp disabled="true"/>
<jaxws-client disabled="true"/>
<jaxws-ri disabled="true"/>
<jaxws-support disabled="true"/>
<xfire-client disabled="true"/>
<rest disabled="true"/>
<jersey useSubcontext="false" usePathBasedConneg="false"/>
<docs splashPackage="org.apache.nifi.web.api" includeDefaultDownloads="false">
<additional-css file="override.css"/>
</docs>
</modules>
</enunciate>

BIN
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/enunciate/images/home.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 144 B

Some files were not shown because too many files have changed in this diff Show More