Class BuildSummary

java.lang.Object
software.amazon.awssdk.services.codebuild.model.BuildSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BuildSummary.Builder,BuildSummary>
@Generated("software.amazon.awssdk:codegen") public final class BuildSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BuildSummary.Builder,BuildSummary>

Contains summary information about a batch build group.

See Also:

  • Method Details

    • arn

      public final String arn()

      The batch build ARN.

      Returns:
      The batch build ARN.

    • requestedOn

      public final Instant requestedOn()

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

      Returns:
      When the build was started, expressed in Unix time format.

    • buildStatus

      public final StatusType buildStatus()

      The status of the build group.

      FAILED

      The build group failed.

      FAULT

      The build group faulted.

      IN_PROGRESS

      The build group is still in progress.

      STOPPED

      The build group stopped.

      SUCCEEDED

      The build group succeeded.

      TIMED_OUT

      The build group timed out.

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

      Returns:
      The status of the build group.

      FAILED

      The build group failed.

      FAULT

      The build group faulted.

      IN_PROGRESS

      The build group is still in progress.

      STOPPED

      The build group stopped.

      SUCCEEDED

      The build group succeeded.

      TIMED_OUT

      The build group timed out.

      See Also:

    • buildStatusAsString

      public final String buildStatusAsString()

      The status of the build group.

      FAILED

      The build group failed.

      FAULT

      The build group faulted.

      IN_PROGRESS

      The build group is still in progress.

      STOPPED

      The build group stopped.

      SUCCEEDED

      The build group succeeded.

      TIMED_OUT

      The build group timed out.

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

      Returns:
      The status of the build group.

      FAILED

      The build group failed.

      FAULT

      The build group faulted.

      IN_PROGRESS

      The build group is still in progress.

      STOPPED

      The build group stopped.

      SUCCEEDED

      The build group succeeded.

      TIMED_OUT

      The build group timed out.

      See Also:

    • primaryArtifact

      public final ResolvedArtifact primaryArtifact()

      A ResolvedArtifact object that represents the primary build artifacts for the build group.

      Returns:
      A ResolvedArtifact object that represents the primary build artifacts for the build group.

    • hasSecondaryArtifacts

      public final boolean hasSecondaryArtifacts()
      For responses, this returns true if the service returned a value for the SecondaryArtifacts 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.

    • secondaryArtifacts

      public final List<ResolvedArtifact> secondaryArtifacts()

      An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.

      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 hasSecondaryArtifacts() method.

      Returns:
      An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.

    • toBuilder

      public BuildSummary.Builder 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 interface ToCopyableBuilder<BuildSummary.Builder,BuildSummary>
      Returns:
      a builder for type T

    • builder

      public static BuildSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BuildSummary.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.