com.amazonaws.services.codepipeline.model.PutJobSuccessResultRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codepipeline Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codepipeline.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input of a PutJobSuccessResult action.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutJobSuccessResultRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
*
*/
private String jobId;
/**
*
* The ID of the current revision of the artifact successfully worked on by the job.
*
*/
private CurrentRevision currentRevision;
/**
*
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify
* a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be
* reused to return more information about the progress of the custom action. When the action is complete, no
* continuation token should be supplied.
*
*/
private String continuationToken;
/**
*
* The execution details of the successful job, such as the actions taken by the job worker.
*
*/
private ExecutionDetails executionDetails;
/**
*
* Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on the
* request.
*
*/
private java.util.Map outputVariables;
/**
*
* The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
*
*
* @param jobId
* The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
*
*
* @return The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
*
*
* @param jobId
* The unique system-generated ID of the job that succeeded. This is the same ID returned from
* PollForJobs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The ID of the current revision of the artifact successfully worked on by the job.
*
*
* @param currentRevision
* The ID of the current revision of the artifact successfully worked on by the job.
*/
public void setCurrentRevision(CurrentRevision currentRevision) {
this.currentRevision = currentRevision;
}
/**
*
* The ID of the current revision of the artifact successfully worked on by the job.
*
*
* @return The ID of the current revision of the artifact successfully worked on by the job.
*/
public CurrentRevision getCurrentRevision() {
return this.currentRevision;
}
/**
*
* The ID of the current revision of the artifact successfully worked on by the job.
*
*
* @param currentRevision
* The ID of the current revision of the artifact successfully worked on by the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest withCurrentRevision(CurrentRevision currentRevision) {
setCurrentRevision(currentRevision);
return this;
}
/**
*
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify
* a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be
* reused to return more information about the progress of the custom action. When the action is complete, no
* continuation token should be supplied.
*
*
* @param continuationToken
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to
* identify a custom action in progress. Future jobs use this token to identify the running instance of the
* action. It can be reused to return more information about the progress of the custom action. When the
* action is complete, no continuation token should be supplied.
*/
public void setContinuationToken(String continuationToken) {
this.continuationToken = continuationToken;
}
/**
*
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify
* a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be
* reused to return more information about the progress of the custom action. When the action is complete, no
* continuation token should be supplied.
*
*
* @return A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to
* identify a custom action in progress. Future jobs use this token to identify the running instance of the
* action. It can be reused to return more information about the progress of the custom action. When the
* action is complete, no continuation token should be supplied.
*/
public String getContinuationToken() {
return this.continuationToken;
}
/**
*
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify
* a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be
* reused to return more information about the progress of the custom action. When the action is complete, no
* continuation token should be supplied.
*
*
* @param continuationToken
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to
* identify a custom action in progress. Future jobs use this token to identify the running instance of the
* action. It can be reused to return more information about the progress of the custom action. When the
* action is complete, no continuation token should be supplied.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest withContinuationToken(String continuationToken) {
setContinuationToken(continuationToken);
return this;
}
/**
*
* The execution details of the successful job, such as the actions taken by the job worker.
*
*
* @param executionDetails
* The execution details of the successful job, such as the actions taken by the job worker.
*/
public void setExecutionDetails(ExecutionDetails executionDetails) {
this.executionDetails = executionDetails;
}
/**
*
* The execution details of the successful job, such as the actions taken by the job worker.
*
*
* @return The execution details of the successful job, such as the actions taken by the job worker.
*/
public ExecutionDetails getExecutionDetails() {
return this.executionDetails;
}
/**
*
* The execution details of the successful job, such as the actions taken by the job worker.
*
*
* @param executionDetails
* The execution details of the successful job, such as the actions taken by the job worker.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest withExecutionDetails(ExecutionDetails executionDetails) {
setExecutionDetails(executionDetails);
return this;
}
/**
*
* Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on the
* request.
*
*
* @return Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on
* the request.
*/
public java.util.Map getOutputVariables() {
return outputVariables;
}
/**
*
* Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on the
* request.
*
*
* @param outputVariables
* Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on
* the request.
*/
public void setOutputVariables(java.util.Map outputVariables) {
this.outputVariables = outputVariables;
}
/**
*
* Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on the
* request.
*
*
* @param outputVariables
* Key-value pairs produced as output by a job worker that can be made available to a downstream action
* configuration. outputVariables can be included only when there is no continuation token on
* the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest withOutputVariables(java.util.Map outputVariables) {
setOutputVariables(outputVariables);
return this;
}
/**
* Add a single OutputVariables entry
*
* @see PutJobSuccessResultRequest#withOutputVariables
* @returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest addOutputVariablesEntry(String key, String value) {
if (null == this.outputVariables) {
this.outputVariables = new java.util.HashMap();
}
if (this.outputVariables.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.outputVariables.put(key, value);
return this;
}
/**
* Removes all the entries added into OutputVariables.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutJobSuccessResultRequest clearOutputVariablesEntries() {
this.outputVariables = null;
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getCurrentRevision() != null)
sb.append("CurrentRevision: ").append(getCurrentRevision()).append(",");
if (getContinuationToken() != null)
sb.append("ContinuationToken: ").append(getContinuationToken()).append(",");
if (getExecutionDetails() != null)
sb.append("ExecutionDetails: ").append(getExecutionDetails()).append(",");
if (getOutputVariables() != null)
sb.append("OutputVariables: ").append(getOutputVariables());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutJobSuccessResultRequest == false)
return false;
PutJobSuccessResultRequest other = (PutJobSuccessResultRequest) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getCurrentRevision() == null ^ this.getCurrentRevision() == null)
return false;
if (other.getCurrentRevision() != null && other.getCurrentRevision().equals(this.getCurrentRevision()) == false)
return false;
if (other.getContinuationToken() == null ^ this.getContinuationToken() == null)
return false;
if (other.getContinuationToken() != null && other.getContinuationToken().equals(this.getContinuationToken()) == false)
return false;
if (other.getExecutionDetails() == null ^ this.getExecutionDetails() == null)
return false;
if (other.getExecutionDetails() != null && other.getExecutionDetails().equals(this.getExecutionDetails()) == false)
return false;
if (other.getOutputVariables() == null ^ this.getOutputVariables() == null)
return false;
if (other.getOutputVariables() != null && other.getOutputVariables().equals(this.getOutputVariables()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getCurrentRevision() == null) ? 0 : getCurrentRevision().hashCode());
hashCode = prime * hashCode + ((getContinuationToken() == null) ? 0 : getContinuationToken().hashCode());
hashCode = prime * hashCode + ((getExecutionDetails() == null) ? 0 : getExecutionDetails().hashCode());
hashCode = prime * hashCode + ((getOutputVariables() == null) ? 0 : getOutputVariables().hashCode());
return hashCode;
}
@Override
public PutJobSuccessResultRequest clone() {
return (PutJobSuccessResultRequest) super.clone();
}
}