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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PutJobSuccessResultRequest.BuildercontinuationToken(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.default PutJobSuccessResultRequest.BuildercurrentRevision(Consumer<CurrentRevision.Builder> currentRevision)The ID of the current revision of the artifact successfully worked on by the job.PutJobSuccessResultRequest.BuildercurrentRevision(CurrentRevision currentRevision)The ID of the current revision of the artifact successfully worked on by the job.default PutJobSuccessResultRequest.BuilderexecutionDetails(Consumer<ExecutionDetails.Builder> executionDetails)The execution details of the successful job, such as the actions taken by the job worker.PutJobSuccessResultRequest.BuilderexecutionDetails(ExecutionDetails executionDetails)The execution details of the successful job, such as the actions taken by the job worker.PutJobSuccessResultRequest.BuilderjobId(String jobId)The unique system-generated ID of the job that succeeded.PutJobSuccessResultRequest.BuilderoutputVariables(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.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)PutJobSuccessResultRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.codepipeline.model.CodePipelineRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
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 fromPollForJobs.- 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 theCurrentRevision.Builderavoiding the need to create one manually viaCurrentRevision.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocurrentRevision(CurrentRevision).- Parameters:
currentRevision- a consumer that will call methods onCurrentRevision.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 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.
- Parameters:
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:
- 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 theExecutionDetails.Builderavoiding the need to create one manually viaExecutionDetails.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toexecutionDetails(ExecutionDetails).- Parameters:
executionDetails- a consumer that will call methods onExecutionDetails.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.
outputVariablescan 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.outputVariablescan 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:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
PutJobSuccessResultRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-