NIFI-292: - Continuing to document/annotate client DTOs. Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/b281d121 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/b281d121 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/b281d121
Branch: refs/heads/NIFI-292 Commit: b281d1216d8fbc0343d19027d3bb378d12202e36 Parents: 1da019d Author: Matt Gilman <[email protected]> Authored: Wed Apr 29 23:32:03 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Wed Apr 29 23:32:03 2015 -0400 ---------------------------------------------------------------------- .../api/dto/provenance/lineage/LineageDTO.java | 28 +++++++++ .../provenance/lineage/LineageRequestDTO.java | 13 ++++- .../provenance/lineage/LineageResultsDTO.java | 10 ++++ .../provenance/lineage/ProvenanceLinkDTO.java | 16 +++++ .../provenance/lineage/ProvenanceNodeDTO.java | 29 ++++++++++ .../dto/search/ComponentSearchResultDTO.java | 13 +++++ .../web/api/dto/search/NodeSearchResultDTO.java | 7 +++ .../web/api/dto/search/SearchResultsDTO.java | 22 +++++++ .../dto/search/UserGroupSearchResultDTO.java | 4 ++ .../web/api/dto/search/UserSearchResultDTO.java | 7 +++ .../dto/status/ClusterConnectionStatusDTO.java | 13 +++++ .../api/dto/status/ClusterPortStatusDTO.java | 13 +++++ .../status/ClusterProcessGroupStatusDTO.java | 13 +++++ .../dto/status/ClusterProcessorStatusDTO.java | 20 +++++++ .../ClusterRemoteProcessGroupStatusDTO.java | 13 +++++ .../web/api/dto/status/ClusterStatusDTO.java | 4 ++ .../api/dto/status/ClusterStatusHistoryDTO.java | 10 ++++ .../web/api/dto/status/ConnectionStatusDTO.java | 39 ++++++++++++- .../web/api/dto/status/ControllerStatusDTO.java | 34 +++++++++++ .../api/dto/status/NodeConnectionStatusDTO.java | 7 +++ .../web/api/dto/status/NodePortStatusDTO.java | 7 +++ .../dto/status/NodeProcessGroupStatusDTO.java | 7 +++ .../api/dto/status/NodeProcessorStatusDTO.java | 7 +++ .../status/NodeRemoteProcessGroupStatusDTO.java | 7 +++ .../nifi/web/api/dto/status/NodeStatusDTO.java | 7 +++ .../api/dto/status/NodeStatusHistoryDTO.java | 7 +++ .../nifi/web/api/dto/status/PortStatusDTO.java | 25 ++++++++ .../api/dto/status/ProcessGroupStatusDTO.java | 61 ++++++++++++++++++++ .../web/api/dto/status/ProcessorStatusDTO.java | 38 ++++++++++++ .../web/api/dto/status/RemotePortStatusDTO.java | 16 +++++ .../dto/status/RemoteProcessGroupStatusDTO.java | 28 +++++++++ .../nifi/web/api/dto/status/StatusDTO.java | 4 ++ .../web/api/dto/status/StatusDescriptorDTO.java | 14 ++++- .../web/api/dto/status/StatusHistoryDTO.java | 13 +++++ .../api/dto/status/StatusHistoryDetailDTO.java | 7 +++ .../web/api/dto/status/StatusSnapshotDTO.java | 7 +++ 36 files changed, 567 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/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 ---------------------------------------------------------------------- diff --git a/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 b/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 index 0ef8aab..bc68d78 100644 --- a/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 +++ b/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 @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/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 ---------------------------------------------------------------------- diff --git a/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 b/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 index 2494962..afab621 100644 --- a/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 +++ b/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 @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/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 ---------------------------------------------------------------------- diff --git a/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 b/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 index 8876e9e..0ac4479 100644 --- a/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 +++ b/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 @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/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 ---------------------------------------------------------------------- diff --git a/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 b/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 index d002626..f91d124 100644 --- a/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 +++ b/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 @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/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 ---------------------------------------------------------------------- diff --git a/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 b/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 index b517751..5e7e329 100644 --- a/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 +++ b/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 @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java index 01965f9..8e9cba5 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/ComponentSearchResultDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java index ab78d06..554966e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/NodeSearchResultDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java index 0319916..60e5bdd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/SearchResultsDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java index 863ba3a..ef81b88 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserGroupSearchResultDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java index b68ab0f..8bed771 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/search/UserSearchResultDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java index 248729e..34f900f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterConnectionStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java index ca4ef07..372bb70 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterPortStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java index 08d76a5..1a4ad63 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessGroupStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java index 8d78b1f..faedc57 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterProcessorStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java index 027bf4f..5fef96f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterRemoteProcessGroupStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java index e170c8b..73529d0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java index a22c872..997e24b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ClusterStatusHistoryDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java index 2abc6ff..dc17c21 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ConnectionStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java index bd2eca6..7afc7bc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeConnectionStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeConnectionStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeConnectionStatusDTO.java index 39fb5ce..bcc4045 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeConnectionStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeConnectionStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodePortStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodePortStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodePortStatusDTO.java index 91a6d01..3b37e9d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodePortStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodePortStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessGroupStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessGroupStatusDTO.java index 5f965b2..96c59fa 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessGroupStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessorStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessorStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessorStatusDTO.java index 86d13d5..8c8f604 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessorStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeProcessorStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeRemoteProcessGroupStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeRemoteProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeRemoteProcessGroupStatusDTO.java index 12a0ca0..512b4c2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeRemoteProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeRemoteProcessGroupStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusDTO.java index b770015..3f07f3d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusHistoryDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusHistoryDTO.java index 9a7cb16..5cf9f41 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusHistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/NodeStatusHistoryDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java index e4cbd34..c1d95d0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java index 6aa445a..3ebae8f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java index 21c3d44..1899418 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java @@ -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; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/b281d121/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemotePortStatusDTO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemotePortStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemotePortStatusDTO.java index 58f6161..6778b0d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemotePortStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemotePortStatusDTO.java @@ -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; }
