Skip to content

Clarify Javadoc to make clear that certain operations fail if there is #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bstopp merged 1 commit into from
Dec 9, 2020
Merged

Clarify Javadoc to make clear that certain operations fail if there is #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/main/java/io/adobe/cloudmanager/CloudManagerApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,25 +95,25 @@ public interface CloudManagerApi {
* @param programId the program id context of the pipeline
* @param pipelineId the pipeline id of to find the execution
* @return the execution details of the pipeline
* @throws CloudManagerApiException when any error occurs
* @throws CloudManagerApiException when any error occurs or if no current execution exists
*/
PipelineExecution getCurrentExecution(String programId, String pipelineId) throws CloudManagerApiException;

/**
* Cancels the current execution of the specified pipeline, if any execution exists.
* Cancels the current execution of the specified pipeline.
*
* @param programId the program id context of the pipeline
* @param pipelineId the id of the pipeline to cancel
* @throws CloudManagerApiException when any error occurs
* @throws CloudManagerApiException when any error occurs or if no current execution exists
*/
void cancelCurrentExecution(String programId, String pipelineId) throws CloudManagerApiException;

/**
* Advances the current execution of the specified pipeline, if in an appropriate state.
* Advances the current execution of the specified pipeline.
*
* @param programId the program id context of the pipeline
* @param pipelineId the id of the pipeline to cancel
* @throws CloudManagerApiException when any error occurs
* @throws CloudManagerApiException when any error occurs or if no current execution exists
*/
void advanceCurrentExecution(String programId, String pipelineId) throws CloudManagerApiException;

Expand Down