software.amazon.awssdk.services.codebuild.model

Interface Build.Builder

All Superinterfaces:

CopyableBuilder<Build.Builder,Build>, SdkBuilder<Build.Builder,Build>

Enclosing class:

Build

public static interface Build.Builder
extends CopyableBuilder<Build.Builder,Build>

Method Summary

Modifier and Type	Method and Description
Build.Builder	arn(String arn) The Amazon Resource Name (ARN) of the build.
Build.Builder	artifacts(BuildArtifacts artifacts) Information about the output artifacts for the build.
default Build.Builder	artifacts(Consumer<BuildArtifacts.Builder> artifacts) Information about the output artifacts for the build.
Build.Builder	buildComplete(Boolean buildComplete) Whether the build has finished.
Build.Builder	buildStatus(StatusType buildStatus) The current status of the build.
Build.Builder	buildStatus(String buildStatus) The current status of the build.
Build.Builder	currentPhase(String currentPhase) The current build phase.
Build.Builder	endTime(Instant endTime) When the build process ended, expressed in Unix time format.
default Build.Builder	environment(Consumer<ProjectEnvironment.Builder> environment) Information about the build environment for this build.
Build.Builder	environment(ProjectEnvironment environment) Information about the build environment for this build.
Build.Builder	id(String id) The unique ID for the build.
Build.Builder	initiator(String initiator) The entity that started the build.
default Build.Builder	logs(Consumer<LogsLocation.Builder> logs) Information about the build's logs in Amazon CloudWatch Logs.
Build.Builder	logs(LogsLocation logs) Information about the build's logs in Amazon CloudWatch Logs.
Build.Builder	phases(BuildPhase... phases) Information about all previous build phases that are completed and information about any current build phase that is not yet complete.
Build.Builder	phases(Collection<BuildPhase> phases) Information about all previous build phases that are completed and information about any current build phase that is not yet complete.
Build.Builder	phases(Consumer<BuildPhase.Builder>... phases) Information about all previous build phases that are completed and information about any current build phase that is not yet complete.
Build.Builder	projectName(String projectName) The name of the build project.
default Build.Builder	source(Consumer<ProjectSource.Builder> source) Information about the source code to be built.
Build.Builder	source(ProjectSource source) Information about the source code to be built.
Build.Builder	sourceVersion(String sourceVersion) Any version identifier for the version of the source code to be built.
Build.Builder	startTime(Instant startTime) When the build process started, expressed in Unix time format.
Build.Builder	timeoutInMinutes(Integer timeoutInMinutes) How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

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

id

Build.Builder id(String id)

The unique ID for the build.

Parameters:

id - The unique ID for the build.

Returns:

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

arn

Build.Builder arn(String arn)

The Amazon Resource Name (ARN) of the build.

Parameters:

arn - The Amazon Resource Name (ARN) of the build.

Returns:

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

startTime

Build.Builder startTime(Instant startTime)

When the build process started, expressed in Unix time format.

Parameters:

startTime - When the build process started, expressed in Unix time format.

Returns:

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

endTime

Build.Builder endTime(Instant endTime)

When the build process ended, expressed in Unix time format.

Parameters:

endTime - When the build process ended, expressed in Unix time format.

Returns:

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

currentPhase

Build.Builder currentPhase(String currentPhase)

The current build phase.

Parameters:

currentPhase - The current build phase.

Returns:

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

buildStatus

Build.Builder buildStatus(String buildStatus)

The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

Parameters:

buildStatus - The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

Returns:

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

See Also:

StatusType, StatusType

buildStatus

Build.Builder buildStatus(StatusType buildStatus)

The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

Parameters:

buildStatus - The current status of the build. Valid values include:

• FAILED: The build failed.

• FAULT: The build faulted.

• IN_PROGRESS: The build is still in progress.

• STOPPED: The build stopped.

• SUCCEEDED: The build succeeded.

• TIMED_OUT: The build timed out.

Returns:

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

See Also:

StatusType, StatusType

sourceVersion

Build.Builder sourceVersion(String sourceVersion)

Any version identifier for the version of the source code to be built.

Parameters:

sourceVersion - Any version identifier for the version of the source code to be built.

Returns:

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

projectName

Build.Builder projectName(String projectName)

The name of the build project.

Parameters:

projectName - The name of the build project.

Returns:

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

phases

Build.Builder phases(Collection<BuildPhase> phases)

Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

Parameters:

phases - Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

Returns:

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

phases

Build.Builder phases(BuildPhase... phases)

Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

Parameters:

phases - Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

Returns:

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

phases

Build.Builder phases(Consumer<BuildPhase.Builder>... phases)

Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #phases(List).

Parameters:

phases - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#phases(List)

source

Build.Builder source(ProjectSource source)

Information about the source code to be built.

Parameters:

source - Information about the source code to be built.

Returns:

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

source

default Build.Builder source(Consumer<ProjectSource.Builder> source)

Information about the source code to be built.

This is a convenience that creates an instance of the ProjectSource.Builder avoiding the need to create one manually via ProjectSource.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to source(ProjectSource).

Parameters:

source - a consumer that will call methods on ProjectSource.Builder

Returns:

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

See Also:

source(ProjectSource)

artifacts

Build.Builder artifacts(BuildArtifacts artifacts)

Information about the output artifacts for the build.

Parameters:

artifacts - Information about the output artifacts for the build.

Returns:

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

artifacts

default Build.Builder artifacts(Consumer<BuildArtifacts.Builder> artifacts)

Information about the output artifacts for the build.

This is a convenience that creates an instance of the BuildArtifacts.Builder avoiding the need to create one manually via BuildArtifacts.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to artifacts(BuildArtifacts).

Parameters:

artifacts - a consumer that will call methods on BuildArtifacts.Builder

Returns:

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

See Also:

artifacts(BuildArtifacts)

environment

Build.Builder environment(ProjectEnvironment environment)

Information about the build environment for this build.

Parameters:

environment - Information about the build environment for this build.

Returns:

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

environment

default Build.Builder environment(Consumer<ProjectEnvironment.Builder> environment)

Information about the build environment for this build.

This is a convenience that creates an instance of the ProjectEnvironment.Builder avoiding the need to create one manually via ProjectEnvironment.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to environment(ProjectEnvironment).

Parameters:

environment - a consumer that will call methods on ProjectEnvironment.Builder

Returns:

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

See Also:

environment(ProjectEnvironment)

logs

Build.Builder logs(LogsLocation logs)

Information about the build's logs in Amazon CloudWatch Logs.

Parameters:

logs - Information about the build's logs in Amazon CloudWatch Logs.

Returns:

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

logs

default Build.Builder logs(Consumer<LogsLocation.Builder> logs)

Information about the build's logs in Amazon CloudWatch Logs.

This is a convenience that creates an instance of the LogsLocation.Builder avoiding the need to create one manually via LogsLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logs(LogsLocation).

Parameters:

logs - a consumer that will call methods on LogsLocation.Builder

Returns:

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

See Also:

logs(LogsLocation)

timeoutInMinutes

Build.Builder timeoutInMinutes(Integer timeoutInMinutes)

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

Parameters:

timeoutInMinutes - How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

Returns:

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

buildComplete

Build.Builder buildComplete(Boolean buildComplete)

Whether the build has finished. True if completed; otherwise, false.

Parameters:

buildComplete - Whether the build has finished. True if completed; otherwise, false.

Returns:

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

initiator

Build.Builder initiator(String initiator)

The entity that started the build. Valid values include:

• If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example MyUserName).

• If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Parameters:

initiator - The entity that started the build. Valid values include:

• If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

• If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example MyUserName).

• If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Returns:

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