@Generated(value="software.amazon.awssdk:codegen") public final class BuildPhase extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BuildPhase.Builder,BuildPhase>
Information about a stage for a build.
| Modifier and Type | Class and Description |
|---|---|
static interface |
BuildPhase.Builder |
| Modifier and Type | Method and 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.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final BuildPhaseType phaseType()
The name of the build phase. Valid values include:
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
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().
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
Build output artifacts are being uploaded to the output location.
BuildPhaseTypepublic final String phaseTypeAsString()
The name of the build phase. Valid values include:
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
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().
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
Build output artifacts are being uploaded to the output location.
BuildPhaseTypepublic final StatusType phaseStatus()
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
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().
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
StatusTypepublic final String phaseStatusAsString()
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
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().
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
StatusTypepublic final Instant startTime()
When the build phase started, expressed in Unix time format.
public final Instant endTime()
When the build phase ended, expressed in Unix time format.
public final Long durationInSeconds()
How long, in seconds, between the starting and ending times of the build's phase.
public final boolean hasContexts()
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.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.
public BuildPhase.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<BuildPhase.Builder,BuildPhase>public static BuildPhase.Builder builder()
public static Class<? extends BuildPhase.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.