@Generated(value="software.amazon.awssdk:codegen") public final class DescribeSimulationJobBatchResponse extends RoboMakerResponse implements ToCopyableBuilder<DescribeSimulationJobBatchResponse.Builder,DescribeSimulationJobBatchResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeSimulationJobBatchResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The Amazon Resource Name (ARN) of the batch.
|
BatchPolicy |
batchPolicy()
The batch policy.
|
static DescribeSimulationJobBatchResponse.Builder |
builder() |
String |
clientRequestToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
|
Instant |
createdAt()
The time, in milliseconds since the epoch, when the simulation job batch was created.
|
List<SimulationJobSummary> |
createdRequests()
A list of created simulation job summaries.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<FailedCreateSimulationJobRequest> |
failedRequests()
A list of failed create simulation job requests.
|
SimulationJobBatchErrorCode |
failureCode()
The failure code of the simulation job batch.
|
String |
failureCodeAsString()
The failure code of the simulation job batch.
|
String |
failureReason()
The reason the simulation job batch failed.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCreatedRequests()
For responses, this returns true if the service returned a value for the CreatedRequests property.
|
boolean |
hasFailedRequests()
For responses, this returns true if the service returned a value for the FailedRequests property.
|
int |
hashCode() |
boolean |
hasPendingRequests()
For responses, this returns true if the service returned a value for the PendingRequests property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
Instant |
lastUpdatedAt()
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
|
List<SimulationJobRequest> |
pendingRequests()
A list of pending simulation job requests.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeSimulationJobBatchResponse.Builder> |
serializableBuilderClass() |
SimulationJobBatchStatus |
status()
The status of the batch.
|
String |
statusAsString()
The status of the batch.
|
Map<String,String> |
tags()
A map that contains tag keys and tag values that are attached to the simulation job batch.
|
DescribeSimulationJobBatchResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String arn()
The Amazon Resource Name (ARN) of the batch.
public final SimulationJobBatchStatus status()
The status of the batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
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().
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
The simulation batch job timed out.
SimulationJobBatchStatuspublic final String statusAsString()
The status of the batch.
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
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().
The simulation job batch request is pending.
The simulation job batch is in progress.
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.
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).
The simulation batch job was cancelled.
The simulation batch job is being cancelled.
The simulation batch job is completing.
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.
The simulation batch job timed out.
SimulationJobBatchStatuspublic final Instant lastUpdatedAt()
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
public final Instant createdAt()
The time, in milliseconds since the epoch, when the simulation job batch was created.
public final String clientRequestToken()
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
public final BatchPolicy batchPolicy()
The batch policy.
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().
SimulationJobBatchErrorCodepublic 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().
SimulationJobBatchErrorCodepublic final String failureReason()
The reason the simulation job batch failed.
public final boolean hasFailedRequests()
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.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.
public final boolean hasPendingRequests()
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.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.
public final boolean hasCreatedRequests()
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.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.
public final boolean hasTags()
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.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.
public DescribeSimulationJobBatchResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeSimulationJobBatchResponse.Builder,DescribeSimulationJobBatchResponse>toBuilder in class AwsResponsepublic static DescribeSimulationJobBatchResponse.Builder builder()
public static Class<? extends DescribeSimulationJobBatchResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.