Class DescribeSimulationJobBatchResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
software.amazon.awssdk.services.robomaker.model.DescribeSimulationJobBatchResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeSimulationJobBatchResponse.Builder,DescribeSimulationJobBatchResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeSimulationJobBatchResponse extends RoboMakerResponse implements ToCopyableBuilder<DescribeSimulationJobBatchResponse.Builder,DescribeSimulationJobBatchResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the batch.

      Returns:
      The Amazon Resource Name (ARN) of the batch.

    • status

      public final SimulationJobBatchStatus status()

      The status of the batch.

      Pending

      The simulation job batch request is pending.

      InProgress

      The simulation job batch is in progress.

      Failed

      The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

      Completed

      The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

      Canceled

      The simulation batch job was cancelled.

      Canceling

      The simulation batch job is being cancelled.

      Completing

      The simulation batch job is completing.

      TimingOut

      The simulation job batch is timing out.

      If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

      TimedOut

      The simulation batch job timed out.

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

      Returns:
      The status of the batch.

      Pending

      The simulation job batch request is pending.

      InProgress

      The simulation job batch is in progress.

      Failed

      The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

      Completed

      The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

      Canceled

      The simulation batch job was cancelled.

      Canceling

      The simulation batch job is being cancelled.

      Completing

      The simulation batch job is completing.

      TimingOut

      The simulation job batch is timing out.

      If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

      TimedOut

      The simulation batch job timed out.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the batch.

      Pending

      The simulation job batch request is pending.

      InProgress

      The simulation job batch is in progress.

      Failed

      The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

      Completed

      The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

      Canceled

      The simulation batch job was cancelled.

      Canceling

      The simulation batch job is being cancelled.

      Completing

      The simulation batch job is completing.

      TimingOut

      The simulation job batch is timing out.

      If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

      TimedOut

      The simulation batch job timed out.

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

      Returns:
      The status of the batch.

      Pending

      The simulation job batch request is pending.

      InProgress

      The simulation job batch is in progress.

      Failed

      The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

      Completed

      The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

      Canceled

      The simulation batch job was cancelled.

      Canceling

      The simulation batch job is being cancelled.

      Completing

      The simulation batch job is completing.

      TimingOut

      The simulation job batch is timing out.

      If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

      TimedOut

      The simulation batch job timed out.

      See Also:

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The time, in milliseconds since the epoch, when the simulation job batch was last updated.

      Returns:
      The time, in milliseconds since the epoch, when the simulation job batch was last updated.

    • createdAt

      public final Instant createdAt()

      The time, in milliseconds since the epoch, when the simulation job batch was created.

      Returns:
      The time, in milliseconds since the epoch, when the simulation job batch was created.

    • clientRequestToken

      public final String clientRequestToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • batchPolicy

      public final BatchPolicy batchPolicy()

      The batch policy.

      Returns:
      The batch policy.

    • failureCode

      public final SimulationJobBatchErrorCode failureCode()

      The failure code of the simulation job batch.

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

      Returns:
      The failure code of the simulation job batch.
      See Also:

    • failureCodeAsString

      public final String failureCodeAsString()

      The failure code of the simulation job batch.

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

      Returns:
      The failure code of the simulation job batch.
      See Also:

    • failureReason

      public final String failureReason()

      The reason the simulation job batch failed.

      Returns:
      The reason the simulation job batch failed.

    • hasFailedRequests

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

    • failedRequests

      public final List<FailedCreateSimulationJobRequest> failedRequests()

      A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

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

      Returns:
      A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

    • hasPendingRequests

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

    • pendingRequests

      public final List<SimulationJobRequest> pendingRequests()

      A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

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

      Returns:
      A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

    • hasCreatedRequests

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

    • createdRequests

      public final List<SimulationJobSummary> createdRequests()

      A list of created simulation job summaries.

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

      Returns:
      A list of created simulation job summaries.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      A map that contains tag keys and tag values that are attached to the simulation job batch.

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

      Returns:
      A map that contains tag keys and tag values that are attached to the simulation job batch.

    • toBuilder

      public DescribeSimulationJobBatchResponse.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<DescribeSimulationJobBatchResponse.Builder,DescribeSimulationJobBatchResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeSimulationJobBatchResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeSimulationJobBatchResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.