Package software.amazon.awssdk.services.robomaker.model

Class WorldGenerationJobSummary

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

Information about a world generator job.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the world generator job.

      Returns:
      The Amazon Resource Name (ARN) of the world generator job.

    • template

      public final String template()

      The Amazon Resource Name (arn) of the world template.

      Returns:
      The Amazon Resource Name (arn) of the world template.

    • createdAt

      public final Instant createdAt()

      The time, in milliseconds since the epoch, when the world generator job was created.

      Returns:
      The time, in milliseconds since the epoch, when the world generator job was created.

    • status

      public final WorldGenerationJobStatus status()

      The status of the world generator job:

      Pending

      The world generator job request is pending.

      Running

      The world generator job is running.

      Completed

      The world generator job completed.

      Failed

      The world generator job failed. See failureCode for more information.

      PartialFailed

      Some worlds did not generate.

      Canceled

      The world generator job was cancelled.

      Canceling

      The world generator job is being cancelled.

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

      Returns:
      The status of the world generator job:

      Pending

      The world generator job request is pending.

      Running

      The world generator job is running.

      Completed

      The world generator job completed.

      Failed

      The world generator job failed. See failureCode for more information.

      PartialFailed

      Some worlds did not generate.

      Canceled

      The world generator job was cancelled.

      Canceling

      The world generator job is being cancelled.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the world generator job:

      Pending

      The world generator job request is pending.

      Running

      The world generator job is running.

      Completed

      The world generator job completed.

      Failed

      The world generator job failed. See failureCode for more information.

      PartialFailed

      Some worlds did not generate.

      Canceled

      The world generator job was cancelled.

      Canceling

      The world generator job is being cancelled.

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

      Returns:
      The status of the world generator job:

      Pending

      The world generator job request is pending.

      Running

      The world generator job is running.

      Completed

      The world generator job completed.

      Failed

      The world generator job failed. See failureCode for more information.

      PartialFailed

      Some worlds did not generate.

      Canceled

      The world generator job was cancelled.

      Canceling

      The world generator job is being cancelled.

      See Also:

    • worldCount

      public final WorldCount worldCount()

      Information about the world count.

      Returns:
      Information about the world count.

    • succeededWorldCount

      public final Integer succeededWorldCount()

      The number of worlds that were generated.

      Returns:
      The number of worlds that were generated.

    • failedWorldCount

      public final Integer failedWorldCount()

      The number of worlds that failed.

      Returns:
      The number of worlds that failed.

    • toBuilder

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

    • builder

      public static WorldGenerationJobSummary.Builder builder()

    • serializableBuilderClass

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