[incubator-streampipes] branch edge-extensions updated: add javadoc to migrate and reconfigure method

[wiener]

This is an automated email from the ASF dual-hosted git repository.

wiener pushed a commit to branch edge-extensions
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes.git


The following commit(s) were added to refs/heads/edge-extensions by this push:
     new 4421dc5  add javadoc to migrate and reconfigure method
4421dc5 is described below

commit 4421dc532d05915af8450ee8ab06a6fe76ccf1bb
Author: Patrick Wiener <wie...@fzi.de>
AuthorDate: Fri May 21 14:20:21 2021 +0200

    add javadoc to migrate and reconfigure method
---
 .../apache/streampipes/client/api/PipelineApi.java   | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git 
a/streampipes-client/src/main/java/org/apache/streampipes/client/api/PipelineApi.java
 
b/streampipes-client/src/main/java/org/apache/streampipes/client/api/PipelineApi.java
index f6d5dba..321a149 100644
--- 
a/streampipes-client/src/main/java/org/apache/streampipes/client/api/PipelineApi.java
+++ 
b/streampipes-client/src/main/java/org/apache/streampipes/client/api/PipelineApi.java
@@ -100,19 +100,39 @@ public class PipelineApi extends 
AbstractClientApi<Pipeline> implements CRUDApi<
     return 
getSingle(getBaseResourcePath().addToPath(pipelineId).addToPath("stop"), 
PipelineOperationStatus.class);
   }
 
+  /**
+   * Migrates pipeline elements at run-time
+   * @param pipeline The pipeline
+   * @return {@link 
org.apache.streampipes.model.pipeline.PipelineOperationStatus} the status 
message after migration
+   */
   public PipelineOperationStatus migrate(Pipeline pipeline) {
     return migrate(pipeline.getPipelineId(), pipeline);
   }
 
+  /**
+   * Migrates pipeline elements at run-time
+   * @param pipeline The pipeline
+   * @return {@link 
org.apache.streampipes.model.pipeline.PipelineOperationStatus} the status 
message after migration
+   */
   private PipelineOperationStatus migrate(String pipelineId, Pipeline 
pipeline) {
     return  
post(getBaseResourcePath().addToPath("migrate").addToPath(pipelineId),
             pipeline, PipelineOperationStatus.class);
   }
 
+  /**
+   * Reconfigures individual pipeline elements at run-time
+   * @param pipeline The pipeline
+   * @return {@link 
org.apache.streampipes.model.pipeline.PipelineOperationStatus} the status 
message after migration
+   */
   public PipelineOperationStatus reconfigure(Pipeline pipeline) {
     return reconfigure(pipeline.getPipelineId(), pipeline);
   }
 
+  /**
+   * Reconfigures individual pipeline elements at run-time
+   * @param pipeline The pipeline
+   * @return {@link 
org.apache.streampipes.model.pipeline.PipelineOperationStatus} the status 
message after migration
+   */
   private PipelineOperationStatus reconfigure(String pipelineId, Pipeline 
pipeline) {
     return 
put(getBaseResourcePath().addToPath("reconfigure").addToPath(pipelineId),
             pipeline, PipelineOperationStatus.class);