software.amazon.awssdk.services.codepipeline.model

Interface ThirdPartyJobData.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ThirdPartyJobData.Builder,ThirdPartyJobData>, SdkBuilder<ThirdPartyJobData.Builder,ThirdPartyJobData>, SdkPojo

Enclosing class:

ThirdPartyJobData

public static interface ThirdPartyJobData.Builder
extends SdkPojo, CopyableBuilder<ThirdPartyJobData.Builder,ThirdPartyJobData>

Method Summary

Modifier and Type	Method and Description
ThirdPartyJobData.Builder	actionConfiguration(ActionConfiguration actionConfiguration) Represents information about an action configuration.
default ThirdPartyJobData.Builder	actionConfiguration(Consumer<ActionConfiguration.Builder> actionConfiguration) Represents information about an action configuration.
ThirdPartyJobData.Builder	actionTypeId(ActionTypeId actionTypeId) Represents information about an action type.
default ThirdPartyJobData.Builder	actionTypeId(Consumer<ActionTypeId.Builder> actionTypeId) Represents information about an action type.
ThirdPartyJobData.Builder	artifactCredentials(AWSSessionCredentials artifactCredentials) Represents an AWS session credentials object.
default ThirdPartyJobData.Builder	artifactCredentials(Consumer<AWSSessionCredentials.Builder> artifactCredentials) Represents an AWS session credentials object.
ThirdPartyJobData.Builder	continuationToken(String continuationToken) A system-generated token, such as a AWS 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 AWS Key Management Service (AWS KMS) key.
ThirdPartyJobData.Builder	encryptionKey(EncryptionKey encryptionKey) The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key.
ThirdPartyJobData.Builder	inputArtifacts(Artifact... inputArtifacts) The name of the artifact that is worked on by the action, if any.
ThirdPartyJobData.Builder	inputArtifacts(Collection<Artifact> inputArtifacts) The name of the artifact that is worked on by the action, if any.
ThirdPartyJobData.Builder	inputArtifacts(Consumer<Artifact.Builder>... inputArtifacts) The name of the artifact that is worked on by the action, if any.
ThirdPartyJobData.Builder	outputArtifacts(Artifact... outputArtifacts) The name of the artifact that is the result of the action, if any.
ThirdPartyJobData.Builder	outputArtifacts(Collection<Artifact> outputArtifacts) The name of the artifact that is the result of the action, if any.
ThirdPartyJobData.Builder	outputArtifacts(Consumer<Artifact.Builder>... 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.
ThirdPartyJobData.Builder	pipelineContext(PipelineContext pipelineContext) Represents information about a pipeline to a job worker.

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

actionTypeId

ThirdPartyJobData.Builder actionTypeId(ActionTypeId 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

default ThirdPartyJobData.Builder actionTypeId(Consumer<ActionTypeId.Builder> actionTypeId)

Represents information about an action type.

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

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

Parameters:

actionTypeId - a consumer that will call methods on ActionTypeId.Builder

Returns:

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

See Also:

actionTypeId(ActionTypeId)

actionConfiguration

ThirdPartyJobData.Builder actionConfiguration(ActionConfiguration 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 the ActionConfiguration.Builder avoiding the need to create one manually via ActionConfiguration.builder().

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

Parameters:

actionConfiguration - a consumer that will call methods on ActionConfiguration.Builder

Returns:

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

See Also:

actionConfiguration(ActionConfiguration)

pipelineContext

ThirdPartyJobData.Builder pipelineContext(PipelineContext pipelineContext)

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

Parameters:

pipelineContext - Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId 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 and pipelineExecutionId for ThirdParty jobs.

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

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

Parameters:

pipelineContext - a consumer that will call methods on PipelineContext.Builder

Returns:

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

See Also:

pipelineContext(PipelineContext)

inputArtifacts

ThirdPartyJobData.Builder inputArtifacts(Collection<Artifact> 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

ThirdPartyJobData.Builder inputArtifacts(Artifact... 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

ThirdPartyJobData.Builder inputArtifacts(Consumer<Artifact.Builder>... 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 the Artifact.Builder avoiding the need to create one manually via Artifact.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #inputArtifacts(List).

Parameters:

inputArtifacts - a consumer that will call methods on Artifact.Builder

Returns:

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

See Also:

#inputArtifacts(java.util.Collection)

outputArtifacts

ThirdPartyJobData.Builder outputArtifacts(Collection<Artifact> 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

ThirdPartyJobData.Builder outputArtifacts(Artifact... 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

ThirdPartyJobData.Builder outputArtifacts(Consumer<Artifact.Builder>... 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 the Artifact.Builder avoiding the need to create one manually via Artifact.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #outputArtifacts(List).

Parameters:

outputArtifacts - a consumer that will call methods on Artifact.Builder

Returns:

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

See Also:

#outputArtifacts(java.util.Collection)

artifactCredentials

ThirdPartyJobData.Builder artifactCredentials(AWSSessionCredentials artifactCredentials)

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS CodePipeline.

Parameters:

artifactCredentials - Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS 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 AWS session credentials object. These credentials are temporary credentials that are issued by AWS 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 AWS CodePipeline.

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

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

Parameters:

artifactCredentials - a consumer that will call methods on AWSSessionCredentials.Builder

Returns:

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

See Also:

artifactCredentials(AWSSessionCredentials)

continuationToken

ThirdPartyJobData.Builder continuationToken(String continuationToken)

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.

Parameters:

continuationToken - A system-generated token, such as a AWS 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

ThirdPartyJobData.Builder encryptionKey(EncryptionKey encryptionKey)

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS 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 AWS Key Management Service (AWS 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

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 AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

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

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

Parameters:

encryptionKey - a consumer that will call methods on EncryptionKey.Builder

Returns:

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

See Also:

encryptionKey(EncryptionKey)