Class BuildBatchPhase
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BuildBatchPhase.Builder,
BuildBatchPhase>
Contains information about a stage for a batch build.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BuildBatchPhase.Builder
builder()
final List
<PhaseContext> contexts()
Additional information about the batch build phase.final Long
How long, in seconds, between the starting and ending times of the batch build's phase.final Instant
endTime()
When the batch 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 batch build phase.final String
The current status of the batch build phase.final BuildBatchPhaseType
The name of the batch build phase.final String
The name of the batch build phase.static Class
<? extends BuildBatchPhase.Builder> final Instant
When the batch 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 batch build phase. Valid values include:
- COMBINE_ARTIFACTS
-
Build output artifacts are being combined and uploaded to the output location.
- DOWNLOAD_BATCHSPEC
-
The batch build specification is being downloaded.
- FAILED
-
One or more of the builds failed.
- IN_PROGRESS
-
The batch build is in progress.
- STOPPED
-
The batch build was stopped.
- SUBMITTED
-
The btach build has been submitted.
- SUCCEEDED
-
The batch build succeeded.
If the service returns an enum value that is not available in the current SDK version,
phaseType
will returnBuildBatchPhaseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphaseTypeAsString()
.- Returns:
- The name of the batch build phase. Valid values include:
- COMBINE_ARTIFACTS
-
Build output artifacts are being combined and uploaded to the output location.
- DOWNLOAD_BATCHSPEC
-
The batch build specification is being downloaded.
- FAILED
-
One or more of the builds failed.
- IN_PROGRESS
-
The batch build is in progress.
- STOPPED
-
The batch build was stopped.
- SUBMITTED
-
The btach build has been submitted.
- SUCCEEDED
-
The batch build succeeded.
- See Also:
-
phaseTypeAsString
The name of the batch build phase. Valid values include:
- COMBINE_ARTIFACTS
-
Build output artifacts are being combined and uploaded to the output location.
- DOWNLOAD_BATCHSPEC
-
The batch build specification is being downloaded.
- FAILED
-
One or more of the builds failed.
- IN_PROGRESS
-
The batch build is in progress.
- STOPPED
-
The batch build was stopped.
- SUBMITTED
-
The btach build has been submitted.
- SUCCEEDED
-
The batch build succeeded.
If the service returns an enum value that is not available in the current SDK version,
phaseType
will returnBuildBatchPhaseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromphaseTypeAsString()
.- Returns:
- The name of the batch build phase. Valid values include:
- COMBINE_ARTIFACTS
-
Build output artifacts are being combined and uploaded to the output location.
- DOWNLOAD_BATCHSPEC
-
The batch build specification is being downloaded.
- FAILED
-
One or more of the builds failed.
- IN_PROGRESS
-
The batch build is in progress.
- STOPPED
-
The batch build was stopped.
- SUBMITTED
-
The btach build has been submitted.
- SUCCEEDED
-
The batch build succeeded.
- See Also:
-
phaseStatus
The current status of the batch 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 batch 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 batch 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 batch 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 batch build phase started, expressed in Unix time format.
- Returns:
- When the batch build phase started, expressed in Unix time format.
-
endTime
When the batch build phase ended, expressed in Unix time format.
- Returns:
- When the batch build phase ended, expressed in Unix time format.
-
durationInSeconds
How long, in seconds, between the starting and ending times of the batch build's phase.
- Returns:
- How long, in seconds, between the starting and ending times of the batch 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 the batch build phase. Especially to help troubleshoot a failed batch 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 the batch build phase. Especially to help troubleshoot a failed batch 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<BuildBatchPhase.Builder,
BuildBatchPhase> - 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
-