java.lang.Object
- software.amazon.awssdk.services.codebuild.model.BuildBatchPhase

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<BuildBatchPhase.Builder,BuildBatchPhase>

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

Contains information about a stage for a batch build.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface BuildBatchPhase.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BuildBatchPhase.Builder`	`builder()`
`List<PhaseContext>`	`contexts()`	Additional information about the batch build phase.
`Long`	`durationInSeconds()`	How long, in seconds, between the starting and ending times of the batch build's phase.
`Instant`	`endTime()`	When the batch 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 batch build phase.
`String`	`phaseStatusAsString()`	The current status of the batch build phase.
`BuildBatchPhaseType`	`phaseType()`	The name of the batch build phase.
`String`	`phaseTypeAsString()`	The name of the batch build phase.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends BuildBatchPhase.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	When the batch build phase started, expressed in Unix time format.
`BuildBatchPhase.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 BuildBatchPhaseType 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 return BuildBatchPhaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseTypeAsString().
    
    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:
    
    BuildBatchPhaseType
  - phaseTypeAsString
```
public final String 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 return BuildBatchPhaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseTypeAsString().
    
    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:
    
    BuildBatchPhaseType
  - phaseStatus
```
public final StatusType 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 return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseStatusAsString().
    
    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:
    
    StatusType
  - phaseStatusAsString
```
public final String 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 return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from phaseStatusAsString().
    
    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:
    
    StatusType
  - startTime
```
public final Instant 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
```
public final Instant 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
```
public final Long 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 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 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
```
public BuildBatchPhase.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<BuildBatchPhase.Builder,BuildBatchPhase>
  - builder
```
public static BuildBatchPhase.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends BuildBatchPhase.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

Class BuildBatchPhase

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

phaseType

phaseTypeAsString

phaseStatus

phaseStatusAsString

startTime

endTime

durationInSeconds

hasContexts

contexts

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields