Package software.amazon.awssdk.services.codepipeline.model

Class PutJobSuccessResultRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest

software.amazon.awssdk.services.codepipeline.model.PutJobSuccessResultRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutJobSuccessResultRequest
extends CodePipelineRequest
implements ToCopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>

Represents the input of a PutJobSuccessResult action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutJobSuccessResultRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutJobSuccessResultRequest.Builder	builder()
String	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.
CurrentRevision	currentRevision()	The ID of the current revision of the artifact successfully worked on by the job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExecutionDetails	executionDetails()	The execution details of the successful job, such as the actions taken by the job worker.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOutputVariables()	For responses, this returns true if the service returned a value for the OutputVariables property.
String	jobId()	The unique system-generated ID of the job that succeeded.
Map<String,String>	outputVariables()	Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PutJobSuccessResultRequest.Builder>	serializableBuilderClass()
PutJobSuccessResultRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobId

public final String jobId()

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.

currentRevision

public final CurrentRevision currentRevision()

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.

continuationToken

public final String 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.

Returns:

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.

executionDetails

public final ExecutionDetails executionDetails()

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.

hasOutputVariables

public final boolean hasOutputVariables()

For responses, this returns true if the service returned a value for the OutputVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

outputVariables

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputVariables() method.

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.

toBuilder

public PutJobSuccessResultRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>

Specified by:

toBuilder in class CodePipelineRequest

builder

public static PutJobSuccessResultRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutJobSuccessResultRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo