Class WorldExportJobSummary

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

Information about a world export job.

See Also:

  • Method Details

    • arn

      public final String arn()

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

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

    • status

      public final WorldExportJobStatus status()

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

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

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

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

      Returns:
      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

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

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

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

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

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

      Returns:
      The status of the world export job.

      Pending

      The world export job request is pending.

      Running

      The world export job is running.

      Completed

      The world export job completed.

      Failed

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

      Canceled

      The world export job was cancelled.

      Canceling

      The world export job is being cancelled.

      See Also:

    • createdAt

      public final Instant createdAt()

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

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

    • hasWorlds

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

    • worlds

      public final List<String> worlds()

      A list of worlds.

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

      Returns:
      A list of worlds.

    • outputLocation

      public final OutputLocation outputLocation()
      Returns the value of the OutputLocation property for this object.
      Returns:
      The value of the OutputLocation property for this object.

    • toBuilder

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

    • builder

      public static WorldExportJobSummary.Builder builder()

    • serializableBuilderClass

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