Interface ThirdPartyJobData.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ThirdPartyJobData.Builder,
,ThirdPartyJobData> SdkBuilder<ThirdPartyJobData.Builder,
,ThirdPartyJobData> SdkPojo
- Enclosing class:
ThirdPartyJobData
-
Method Summary
Modifier and TypeMethodDescriptiondefault ThirdPartyJobData.Builder
actionConfiguration
(Consumer<ActionConfiguration.Builder> actionConfiguration) Represents information about an action configuration.actionConfiguration
(ActionConfiguration actionConfiguration) Represents information about an action configuration.default ThirdPartyJobData.Builder
actionTypeId
(Consumer<ActionTypeId.Builder> actionTypeId) Represents information about an action type.actionTypeId
(ActionTypeId actionTypeId) Represents information about an action type.default ThirdPartyJobData.Builder
artifactCredentials
(Consumer<AWSSessionCredentials.Builder> artifactCredentials) Represents an Amazon Web Services session credentials object.artifactCredentials
(AWSSessionCredentials artifactCredentials) Represents an Amazon Web Services session credentials object.continuationToken
(String continuationToken) A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.default ThirdPartyJobData.Builder
encryptionKey
(Consumer<EncryptionKey.Builder> encryptionKey) The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key.encryptionKey
(EncryptionKey encryptionKey) The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key.inputArtifacts
(Collection<Artifact> inputArtifacts) The name of the artifact that is worked on by the action, if any.inputArtifacts
(Consumer<Artifact.Builder>... inputArtifacts) The name of the artifact that is worked on by the action, if any.inputArtifacts
(Artifact... inputArtifacts) The name of the artifact that is worked on by the action, if any.outputArtifacts
(Collection<Artifact> outputArtifacts) The name of the artifact that is the result of the action, if any.outputArtifacts
(Consumer<Artifact.Builder>... outputArtifacts) The name of the artifact that is the result of the action, if any.outputArtifacts
(Artifact... outputArtifacts) The name of the artifact that is the result of the action, if any.default ThirdPartyJobData.Builder
pipelineContext
(Consumer<PipelineContext.Builder> pipelineContext) Represents information about a pipeline to a job worker.pipelineContext
(PipelineContext pipelineContext) Represents information about a pipeline to a job worker.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, sdkFields
-
Method Details
-
actionTypeId
Represents information about an action type.
- Parameters:
actionTypeId
- Represents information about an action type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionTypeId
Represents information about an action type.
This is a convenience method that creates an instance of theActionTypeId.Builder
avoiding the need to create one manually viaActionTypeId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactionTypeId(ActionTypeId)
.- Parameters:
actionTypeId
- a consumer that will call methods onActionTypeId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
actionConfiguration
Represents information about an action configuration.
- Parameters:
actionConfiguration
- Represents information about an action configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actionConfiguration
default ThirdPartyJobData.Builder actionConfiguration(Consumer<ActionConfiguration.Builder> actionConfiguration) Represents information about an action configuration.
This is a convenience method that creates an instance of theActionConfiguration.Builder
avoiding the need to create one manually viaActionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactionConfiguration(ActionConfiguration)
.- Parameters:
actionConfiguration
- a consumer that will call methods onActionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
pipelineContext
Represents information about a pipeline to a job worker.
Does not include
pipelineArn
andpipelineExecutionId
for ThirdParty jobs.- Parameters:
pipelineContext
- Represents information about a pipeline to a job worker.Does not include
pipelineArn
andpipelineExecutionId
for ThirdParty jobs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pipelineContext
default ThirdPartyJobData.Builder pipelineContext(Consumer<PipelineContext.Builder> pipelineContext) Represents information about a pipeline to a job worker.
Does not include
pipelineArn
andpipelineExecutionId
for ThirdParty jobs.PipelineContext.Builder
avoiding the need to create one manually viaPipelineContext.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topipelineContext(PipelineContext)
.- Parameters:
pipelineContext
- a consumer that will call methods onPipelineContext.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
inputArtifacts
The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
- Parameters:
inputArtifacts
- The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputArtifacts
The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
- Parameters:
inputArtifacts
- The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputArtifacts
The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
This is a convenience method that creates an instance of theArtifact.Builder
avoiding the need to create one manually viaArtifact.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputArtifacts(List<Artifact>)
.- Parameters:
inputArtifacts
- a consumer that will call methods onArtifact.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputArtifacts
The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
- Parameters:
outputArtifacts
- The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputArtifacts
The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
- Parameters:
outputArtifacts
- The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputArtifacts
The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
This is a convenience method that creates an instance of theArtifact.Builder
avoiding the need to create one manually viaArtifact.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputArtifacts(List<Artifact>)
.- Parameters:
outputArtifacts
- a consumer that will call methods onArtifact.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
artifactCredentials
Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.
- Parameters:
artifactCredentials
- Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
artifactCredentials
default ThirdPartyJobData.Builder artifactCredentials(Consumer<AWSSessionCredentials.Builder> artifactCredentials) Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.
This is a convenience method that creates an instance of theAWSSessionCredentials.Builder
avoiding the need to create one manually viaAWSSessionCredentials.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toartifactCredentials(AWSSessionCredentials)
.- Parameters:
artifactCredentials
- a consumer that will call methods onAWSSessionCredentials.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
continuationToken
A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
- Parameters:
continuationToken
- A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionKey
The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.
- Parameters:
encryptionKey
- The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
encryptionKey
The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.
This is a convenience method that creates an instance of theEncryptionKey.Builder
avoiding the need to create one manually viaEncryptionKey.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toencryptionKey(EncryptionKey)
.- Parameters:
encryptionKey
- a consumer that will call methods onEncryptionKey.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-