Class SandboxSessionPhase

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

Contains information about the sandbox phase.

See Also:

  • Method Details

    • phaseType

      public final String phaseType()

      The name of the sandbox phase.

      Returns:
      The name of the sandbox phase.

    • phaseStatus

      public final StatusType phaseStatus()

      The current status of the sandbox phase. Valid values include:

      FAILED

      The sandbox phase failed.

      FAULT

      The sandbox phase faulted.

      IN_PROGRESS

      The sandbox phase is still in progress.

      STOPPED

      The sandbox phase stopped.

      SUCCEEDED

      The sandbox phase succeeded.

      TIMED_OUT

      The sandbox 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 sandbox phase. Valid values include:

      FAILED

      The sandbox phase failed.

      FAULT

      The sandbox phase faulted.

      IN_PROGRESS

      The sandbox phase is still in progress.

      STOPPED

      The sandbox phase stopped.

      SUCCEEDED

      The sandbox phase succeeded.

      TIMED_OUT

      The sandbox phase timed out.

      See Also:

    • phaseStatusAsString

      public final String phaseStatusAsString()

      The current status of the sandbox phase. Valid values include:

      FAILED

      The sandbox phase failed.

      FAULT

      The sandbox phase faulted.

      IN_PROGRESS

      The sandbox phase is still in progress.

      STOPPED

      The sandbox phase stopped.

      SUCCEEDED

      The sandbox phase succeeded.

      TIMED_OUT

      The sandbox 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 sandbox phase. Valid values include:

      FAILED

      The sandbox phase failed.

      FAULT

      The sandbox phase faulted.

      IN_PROGRESS

      The sandbox phase is still in progress.

      STOPPED

      The sandbox phase stopped.

      SUCCEEDED

      The sandbox phase succeeded.

      TIMED_OUT

      The sandbox phase timed out.

      See Also:

    • startTime

      public final Instant startTime()

      When the sandbox phase started, expressed in Unix time format.

      Returns:
      When the sandbox phase started, expressed in Unix time format.

    • endTime

      public final Instant endTime()

      When the sandbox phase ended, expressed in Unix time format.

      Returns:
      When the sandbox phase ended, expressed in Unix time format.

    • durationInSeconds

      public final Long durationInSeconds()

      How long, in seconds, between the starting and ending times of the sandbox's phase.

      Returns:
      How long, in seconds, between the starting and ending times of the sandbox'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()

      An array of PhaseContext objects.

      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:
      An array of PhaseContext objects.

    • toBuilder

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

    • builder

      public static SandboxSessionPhase.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SandboxSessionPhase.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.