Class BuildPhase
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BuildPhase.Builder,
BuildPhase>
Information about a stage for a build.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BuildPhase.Builder
builder()
final List
<PhaseContext> contexts()
Additional information about a build phase, especially to help troubleshoot a failed build.final Long
How long, in seconds, between the starting and ending times of the build's phase.final Instant
endTime()
When the build phase ended, expressed in Unix time format.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Contexts property.final int
hashCode()
final StatusType
The current status of the build phase.final String
The current status of the build phase.final BuildPhaseType
The name of the build phase.final String
The name of the build phase.static Class
<? extends BuildPhase.Builder> final Instant
When the build phase started, expressed in Unix time format.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnBuildPhaseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphaseTypeAsString()
.- 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:
-
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 returnBuildPhaseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphaseTypeAsString()
.- 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:
-
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 returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphaseStatusAsString()
.- 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:
-
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 returnStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphaseStatusAsString()
.- 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:
-
startTime
When the build phase started, expressed in Unix time format.
- Returns:
- When the build phase started, expressed in Unix time format.
-
endTime
When the build phase ended, expressed in Unix time format.
- Returns:
- When the build phase ended, expressed in Unix time format.
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<BuildPhase.Builder,
BuildPhase> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-