Class WorldFailure

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

Information about a failed world.

See Also:

  • Method Details

    • failureCode

      public final WorldGenerationJobErrorCode failureCode()

      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

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

      Returns:
      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

      See Also:

    • failureCodeAsString

      public final String failureCodeAsString()

      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

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

      Returns:
      The failure code of the world export job if it failed:

      InternalServiceError

      Internal service error.

      LimitExceeded

      The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

      ResourceNotFound

      The specified resource could not be found.

      RequestThrottled

      The request was throttled.

      InvalidInput

      An input parameter in the request is not valid.

      See Also:

    • sampleFailureReason

      public final String sampleFailureReason()

      The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.

      Returns:
      The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.

    • failureCount

      public final Integer failureCount()

      The number of failed worlds.

      Returns:
      The number of failed worlds.

    • toBuilder

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

    • builder

      public static WorldFailure.Builder builder()

    • serializableBuilderClass

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