Class SimulationJobBatchSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SimulationJobBatchSummary.Builder,
SimulationJobBatchSummary>
Information about a simulation job batch.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the batch.builder()
final Instant
The time, in milliseconds since the epoch, when the simulation job batch was created.final Integer
The number of created simulation job requests.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of failed simulation job requests.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
The time, in milliseconds since the epoch, when the simulation job batch was last updated.final Integer
The number of pending simulation job requests.static Class
<? extends SimulationJobBatchSummary.Builder> final SimulationJobBatchStatus
status()
The status of the simulation job batch.final String
The status of the simulation job batch.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the batch.
- Returns:
- The Amazon Resource Name (ARN) of the batch.
-
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
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.
-
status
The status of the simulation job 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
). SeefailureCode
andfailureReason
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
orFailed
). - 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 beFailed
. If there are no such failing request, the batch status will beTimedOut
. - 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 returnSimulationJobBatchStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the simulation job 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
). SeefailureCode
andfailureReason
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
orFailed
). - 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 beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
- See Also:
-
statusAsString
The status of the simulation job 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
). SeefailureCode
andfailureReason
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
orFailed
). - 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 beFailed
. If there are no such failing request, the batch status will beTimedOut
. - 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 returnSimulationJobBatchStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the simulation job 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
). SeefailureCode
andfailureReason
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
orFailed
). - 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 beFailed
. If there are no such failing request, the batch status will beTimedOut
. - TimedOut
-
The simulation batch job timed out.
- See Also:
-
failedRequestCount
The number of failed simulation job requests.
- Returns:
- The number of failed simulation job requests.
-
pendingRequestCount
The number of pending simulation job requests.
- Returns:
- The number of pending simulation job requests.
-
createdRequestCount
The number of created simulation job requests.
- Returns:
- The number of created simulation job requests.
-
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 interfaceToCopyableBuilder<SimulationJobBatchSummary.Builder,
SimulationJobBatchSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-