Class SimulationJobBatchSummary

java.lang.Object

software.amazon.awssdk.services.robomaker.model.SimulationJobBatchSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SimulationJobBatchSummary.Builder,SimulationJobBatchSummary>

@Generated("software.amazon.awssdk:codegen")
public final class SimulationJobBatchSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SimulationJobBatchSummary.Builder,SimulationJobBatchSummary>

Information about a simulation job batch.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SimulationJobBatchSummary.Builder

Method Summary

Modifier and Type	Method	Description
final String	arn()	The Amazon Resource Name (ARN) of the batch.
static SimulationJobBatchSummary.Builder	builder()
final Instant	createdAt()	The time, in milliseconds since the epoch, when the simulation job batch was created.
final Integer	createdRequestCount()	The number of created simulation job requests.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final Integer	failedRequestCount()	The number of failed simulation job requests.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Instant	lastUpdatedAt()	The time, in milliseconds since the epoch, when the simulation job batch was last updated.
final Integer	pendingRequestCount()	The number of pending simulation job requests.
final List<SdkField<?>>	sdkFields()
static Class<? extends SimulationJobBatchSummary.Builder>	serializableBuilderClass()
final SimulationJobBatchStatus	status()	The status of the simulation job batch.
final String	statusAsString()	The status of the simulation job batch.
SimulationJobBatchSummary.Builder	toBuilder()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

arn

public final String arn()

The Amazon Resource Name (ARN) of the batch.

Returns:

The Amazon Resource Name (ARN) of the batch.

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.

status

public final SimulationJobBatchStatus 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). 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 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). 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:

• SimulationJobBatchStatus

statusAsString

public final String 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). 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 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). 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:

• SimulationJobBatchStatus

failedRequestCount

public final Integer failedRequestCount()

The number of failed simulation job requests.

Returns:

The number of failed simulation job requests.

pendingRequestCount

public final Integer pendingRequestCount()

The number of pending simulation job requests.

Returns:

The number of pending simulation job requests.

createdRequestCount

public final Integer createdRequestCount()

The number of created simulation job requests.

Returns:

The number of created simulation job requests.

toBuilder

public SimulationJobBatchSummary.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<SimulationJobBatchSummary.Builder,SimulationJobBatchSummary>

Returns:

a builder for type T

builder

public static SimulationJobBatchSummary.Builder builder()

serializableBuilderClass

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