com.amazonaws.services.codepipeline.model

Class PutJobSuccessResultRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codepipeline.model.PutJobSuccessResultRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutJobSuccessResultRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a PutJobSuccessResult action.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutJobSuccessResultRequest()

Method Summary

Modifier and Type	Method and Description
PutJobSuccessResultRequest	addOutputVariablesEntry(String key, String value) Add a single OutputVariables entry
PutJobSuccessResultRequest	clearOutputVariablesEntries() Removes all the entries added into OutputVariables.
PutJobSuccessResultRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getContinuationToken() A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress.
CurrentRevision	getCurrentRevision() The ID of the current revision of the artifact successfully worked on by the job.
ExecutionDetails	getExecutionDetails() The execution details of the successful job, such as the actions taken by the job worker.
String	getJobId() The unique system-generated ID of the job that succeeded.
Map<String,String>	getOutputVariables() Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration.
int	hashCode()
void	setContinuationToken(String continuationToken) A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress.
void	setCurrentRevision(CurrentRevision currentRevision) The ID of the current revision of the artifact successfully worked on by the job.
void	setExecutionDetails(ExecutionDetails executionDetails) The execution details of the successful job, such as the actions taken by the job worker.
void	setJobId(String jobId) The unique system-generated ID of the job that succeeded.
void	setOutputVariables(Map<String,String> outputVariables) Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration.
String	toString() Returns a string representation of this object.
PutJobSuccessResultRequest	withContinuationToken(String continuationToken) A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress.
PutJobSuccessResultRequest	withCurrentRevision(CurrentRevision currentRevision) The ID of the current revision of the artifact successfully worked on by the job.
PutJobSuccessResultRequest	withExecutionDetails(ExecutionDetails executionDetails) The execution details of the successful job, such as the actions taken by the job worker.
PutJobSuccessResultRequest	withJobId(String jobId) The unique system-generated ID of the job that succeeded.
PutJobSuccessResultRequest	withOutputVariables(Map<String,String> outputVariables) Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutJobSuccessResultRequest

public PutJobSuccessResultRequest()

Method Detail

setJobId

public void setJobId(String jobId)

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Parameters:

jobId - The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

getJobId

public String getJobId()

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Returns:

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

withJobId

public PutJobSuccessResultRequest withJobId(String jobId)

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Parameters:

jobId - The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCurrentRevision

public void setCurrentRevision(CurrentRevision currentRevision)

The ID of the current revision of the artifact successfully worked on by the job.

Parameters:

currentRevision - The ID of the current revision of the artifact successfully worked on by the job.

getCurrentRevision

public CurrentRevision getCurrentRevision()

The ID of the current revision of the artifact successfully worked on by the job.

Returns:

The ID of the current revision of the artifact successfully worked on by the job.

withCurrentRevision

public PutJobSuccessResultRequest withCurrentRevision(CurrentRevision currentRevision)

The ID of the current revision of the artifact successfully worked on by the job.

Parameters:

currentRevision - The ID of the current revision of the artifact successfully worked on by the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setContinuationToken

public void setContinuationToken(String continuationToken)

A token generated by a job worker, such as an AWS 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.

Parameters:

continuationToken - A token generated by a job worker, such as an AWS 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.

getContinuationToken

public String getContinuationToken()

A token generated by a job worker, such as an AWS 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.

Returns:

A token generated by a job worker, such as an AWS 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.

withContinuationToken

public PutJobSuccessResultRequest withContinuationToken(String continuationToken)

A token generated by a job worker, such as an AWS 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.

Parameters:

continuationToken - A token generated by a job worker, such as an AWS 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExecutionDetails

public void setExecutionDetails(ExecutionDetails executionDetails)

The execution details of the successful job, such as the actions taken by the job worker.

Parameters:

executionDetails - The execution details of the successful job, such as the actions taken by the job worker.

getExecutionDetails

public ExecutionDetails getExecutionDetails()

The execution details of the successful job, such as the actions taken by the job worker.

Returns:

The execution details of the successful job, such as the actions taken by the job worker.

withExecutionDetails

public PutJobSuccessResultRequest withExecutionDetails(ExecutionDetails executionDetails)

The execution details of the successful job, such as the actions taken by the job worker.

Parameters:

executionDetails - The execution details of the successful job, such as the actions taken by the job worker.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOutputVariables

public Map<String,String> getOutputVariables()

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.

Returns:

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.

setOutputVariables

public void setOutputVariables(Map<String,String> 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.

Parameters:

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.

withOutputVariables

public PutJobSuccessResultRequest withOutputVariables(Map<String,String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addOutputVariablesEntry

public PutJobSuccessResultRequest addOutputVariablesEntry(String key,
                                                          String value)

Add a single OutputVariables entry

See Also:

withOutputVariables(java.util.Map<java.lang.String, java.lang.String>)

clearOutputVariablesEntries

public PutJobSuccessResultRequest clearOutputVariablesEntries()

Removes all the entries added into OutputVariables.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutJobSuccessResultRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()