software.amazon.awssdk.services.codepipeline.model

Interface PutJobSuccessResultRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodePipelineRequest.Builder, CopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>, SdkBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutJobSuccessResultRequest

public static interface PutJobSuccessResultRequest.Builder
extends CodePipelineRequest.Builder, SdkPojo, CopyableBuilder<PutJobSuccessResultRequest.Builder,PutJobSuccessResultRequest>

Method Summary

Modifier and Type	Method and Description
PutJobSuccessResultRequest.Builder	continuationToken(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.
default PutJobSuccessResultRequest.Builder	currentRevision(Consumer<CurrentRevision.Builder> currentRevision) The ID of the current revision of the artifact successfully worked on by the job.
PutJobSuccessResultRequest.Builder	currentRevision(CurrentRevision currentRevision) The ID of the current revision of the artifact successfully worked on by the job.
default PutJobSuccessResultRequest.Builder	executionDetails(Consumer<ExecutionDetails.Builder> executionDetails) The execution details of the successful job, such as the actions taken by the job worker.
PutJobSuccessResultRequest.Builder	executionDetails(ExecutionDetails executionDetails) The execution details of the successful job, such as the actions taken by the job worker.
PutJobSuccessResultRequest.Builder	jobId(String jobId) The unique system-generated ID of the job that succeeded.
PutJobSuccessResultRequest.Builder	outputVariables(Map<String,String> outputVariables) Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration.
PutJobSuccessResultRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutJobSuccessResultRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

jobId

PutJobSuccessResultRequest.Builder jobId(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.

currentRevision

PutJobSuccessResultRequest.Builder currentRevision(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.

currentRevision

default PutJobSuccessResultRequest.Builder currentRevision(Consumer<CurrentRevision.Builder> currentRevision)

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

This is a convenience method that creates an instance of the CurrentRevision.Builder avoiding the need to create one manually via CurrentRevision.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to currentRevision(CurrentRevision).

Parameters:

currentRevision - a consumer that will call methods on CurrentRevision.Builder

Returns:

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

See Also:

currentRevision(CurrentRevision)

continuationToken

PutJobSuccessResultRequest.Builder continuationToken(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.

executionDetails

PutJobSuccessResultRequest.Builder executionDetails(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.

executionDetails

default PutJobSuccessResultRequest.Builder executionDetails(Consumer<ExecutionDetails.Builder> executionDetails)

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

This is a convenience method that creates an instance of the ExecutionDetails.Builder avoiding the need to create one manually via ExecutionDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to executionDetails(ExecutionDetails).

Parameters:

executionDetails - a consumer that will call methods on ExecutionDetails.Builder

Returns:

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

See Also:

executionDetails(ExecutionDetails)

outputVariables

PutJobSuccessResultRequest.Builder outputVariables(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.

overrideConfiguration

PutJobSuccessResultRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutJobSuccessResultRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder