Repository: incubator-nifi Updated Branches: refs/heads/NIFI-292 1da019d71 -> b281d1216
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/RemoteProcessGroupStatusDTO.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/RemoteProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java index 5f7c2c1..f556deb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.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; @@ -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; } 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/StatusDTO.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/StatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDTO.java index e922b70..39b9c06 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDTO.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; @@ -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; } 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/StatusDescriptorDTO.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/StatusDescriptorDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDescriptorDTO.java index 65823d5..0a3c418 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDescriptorDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusDescriptorDTO.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; /** @@ -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; } 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/StatusHistoryDTO.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/StatusHistoryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDTO.java index a996365..c0ef33b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDTO.java @@ -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; } 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/StatusHistoryDetailDTO.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/StatusHistoryDetailDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDetailDTO.java index 4ebb5e3..e78641e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDetailDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusHistoryDetailDTO.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; /** @@ -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; } 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/StatusSnapshotDTO.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/StatusSnapshotDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusSnapshotDTO.java index b39fd60..24d801f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusSnapshotDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/StatusSnapshotDTO.java @@ -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; }
