Package software.amazon.awssdk.services.codebuild.model

Class BuildPhase

java.lang.Object

software.amazon.awssdk.services.codebuild.model.BuildPhase

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BuildPhase.Builder,BuildPhase>

@Generated("software.amazon.awssdk:codegen")
public final class BuildPhase
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BuildPhase.Builder,BuildPhase>

Information about a stage for a build.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BuildPhase.Builder

Method Summary

Modifier and Type	Method	Description
static BuildPhase.Builder	builder()
List<PhaseContext>	contexts()	Additional information about a build phase, especially to help troubleshoot a failed build.
Long	durationInSeconds()	How long, in seconds, between the starting and ending times of the build's phase.
Instant	endTime()	When the build phase ended, expressed in Unix time format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContexts()	For responses, this returns true if the service returned a value for the Contexts property.
int	hashCode()
StatusType	phaseStatus()	The current status of the build phase.
String	phaseStatusAsString()	The current status of the build phase.
BuildPhaseType	phaseType()	The name of the build phase.
String	phaseTypeAsString()	The name of the build phase.
List<SdkField<?>>	sdkFields()
static Class<? extends BuildPhase.Builder>	serializableBuilderClass()
Instant	startTime()	When the build phase started, expressed in Unix time format.
BuildPhase.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

phaseType

public final BuildPhaseType phaseType()

The name of the build phase. Valid values include:

BUILD

Core build activities typically occur in this build phase.

COMPLETED

The build has been completed.

DOWNLOAD_SOURCE

Source code is being downloaded in this build phase.

FINALIZING

The build process is completing in this build phase.

INSTALL

Installation activities typically occur in this build phase.

POST_BUILD

Post-build activities typically occur in this build phase.

PRE_BUILD

Pre-build activities typically occur in this build phase.

PROVISIONING

The build environment is being set up.

QUEUED

The build has been submitted and is queued behind other submitted builds.

SUBMITTED

The build has been submitted.

UPLOAD_ARTIFACTS

Build output artifacts are being uploaded to the output location.

If the service returns an enum value that is not available in the current SDK version, phaseType will return BuildPhaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseTypeAsString().

Returns:

The name of the build phase. Valid values include:

BUILD

Core build activities typically occur in this build phase.

COMPLETED

The build has been completed.

DOWNLOAD_SOURCE

Source code is being downloaded in this build phase.

FINALIZING

The build process is completing in this build phase.

INSTALL

Installation activities typically occur in this build phase.

POST_BUILD

Post-build activities typically occur in this build phase.

PRE_BUILD

Pre-build activities typically occur in this build phase.

PROVISIONING

The build environment is being set up.

QUEUED

The build has been submitted and is queued behind other submitted builds.

SUBMITTED

The build has been submitted.

UPLOAD_ARTIFACTS

Build output artifacts are being uploaded to the output location.

See Also:

BuildPhaseType

phaseTypeAsString

public final String phaseTypeAsString()

The name of the build phase. Valid values include:

BUILD

Core build activities typically occur in this build phase.

COMPLETED

The build has been completed.

DOWNLOAD_SOURCE

Source code is being downloaded in this build phase.

FINALIZING

The build process is completing in this build phase.

INSTALL

Installation activities typically occur in this build phase.

POST_BUILD

Post-build activities typically occur in this build phase.

PRE_BUILD

Pre-build activities typically occur in this build phase.

PROVISIONING

The build environment is being set up.

QUEUED

The build has been submitted and is queued behind other submitted builds.

SUBMITTED

The build has been submitted.

UPLOAD_ARTIFACTS

Build output artifacts are being uploaded to the output location.

If the service returns an enum value that is not available in the current SDK version, phaseType will return BuildPhaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseTypeAsString().

Returns:

The name of the build phase. Valid values include:

BUILD

Core build activities typically occur in this build phase.

COMPLETED

The build has been completed.

DOWNLOAD_SOURCE

Source code is being downloaded in this build phase.

FINALIZING

The build process is completing in this build phase.

INSTALL

Installation activities typically occur in this build phase.

POST_BUILD

Post-build activities typically occur in this build phase.

PRE_BUILD

Pre-build activities typically occur in this build phase.

PROVISIONING

The build environment is being set up.

QUEUED

The build has been submitted and is queued behind other submitted builds.

SUBMITTED

The build has been submitted.

UPLOAD_ARTIFACTS

Build output artifacts are being uploaded to the output location.

See Also:

BuildPhaseType

phaseStatus

public final StatusType phaseStatus()

The current status of the build phase. Valid values include:

FAILED

The build phase failed.

FAULT

The build phase faulted.

IN_PROGRESS

The build phase is still in progress.

STOPPED

The build phase stopped.

SUCCEEDED

The build phase succeeded.

TIMED_OUT

The build phase timed out.

If the service returns an enum value that is not available in the current SDK version, phaseStatus will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseStatusAsString().

Returns:

The current status of the build phase. Valid values include:

FAILED

The build phase failed.

FAULT

The build phase faulted.

IN_PROGRESS

The build phase is still in progress.

STOPPED

The build phase stopped.

SUCCEEDED

The build phase succeeded.

TIMED_OUT

The build phase timed out.

See Also:

StatusType

phaseStatusAsString

public final String phaseStatusAsString()

The current status of the build phase. Valid values include:

FAILED

The build phase failed.

FAULT

The build phase faulted.

IN_PROGRESS

The build phase is still in progress.

STOPPED

The build phase stopped.

SUCCEEDED

The build phase succeeded.

TIMED_OUT

The build phase timed out.

If the service returns an enum value that is not available in the current SDK version, phaseStatus will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseStatusAsString().

Returns:

The current status of the build phase. Valid values include:

FAILED

The build phase failed.

FAULT

The build phase faulted.

IN_PROGRESS

The build phase is still in progress.

STOPPED

The build phase stopped.

SUCCEEDED

The build phase succeeded.

TIMED_OUT

The build phase timed out.

See Also:

StatusType

startTime

public final Instant startTime()

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

Returns:

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

endTime

public final Instant endTime()

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

Returns:

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

durationInSeconds

public final Long durationInSeconds()

How long, in seconds, between the starting and ending times of the build's phase.

Returns:

How long, in seconds, between the starting and ending times of the build's phase.

hasContexts

public final boolean hasContexts()

For responses, this returns true if the service returned a value for the Contexts property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

contexts

public final List<PhaseContext> contexts()

Additional information about a build phase, especially to help troubleshoot a failed build.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContexts() method.

Returns:

Additional information about a build phase, especially to help troubleshoot a failed build.

toBuilder

public BuildPhase.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BuildPhase.Builder,BuildPhase>

builder

public static BuildPhase.Builder builder()

serializableBuilderClass

public static Class<? extends BuildPhase.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo