software.amazon.awssdk.services.robomaker.model

Class SimulationJob

java.lang.Object

software.amazon.awssdk.services.robomaker.model.SimulationJob

All Implemented Interfaces:

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

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

Information about a simulation job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimulationJob.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the simulation job.
static SimulationJob.Builder	builder()
String	clientRequestToken() A unique identifier for this SimulationJob request.
boolean	equals(Object obj)
FailureBehavior	failureBehavior() The failure behavior the simulation job.
String	failureBehaviorAsString() The failure behavior the simulation job.
SimulationJobErrorCode	failureCode() The failure code of the simulation job if it failed.
String	failureCodeAsString() The failure code of the simulation job if it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRole() The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
Instant	lastUpdatedAt() The time, in milliseconds since the epoch, when the simulation job was last updated.
Long	maxJobDurationInSeconds() The maximum simulation job duration in seconds.
String	name() The name of the simulation job.
OutputLocation	outputLocation() Location for output files generated by the simulation job.
List<RobotApplicationConfig>	robotApplications() A list of robot applications.
List<SdkField<?>>	sdkFields()
static Class<? extends SimulationJob.Builder>	serializableBuilderClass()
List<SimulationApplicationConfig>	simulationApplications() A list of simulation applications.
Long	simulationTimeMillis() The simulation job execution duration in milliseconds.
SimulationJobStatus	status() Status of the simulation job.
String	statusAsString() Status of the simulation job.
SimulationJob.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VPCConfigResponse	vpcConfig() VPC configuration information.

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 Detail

arn

public String arn()

The Amazon Resource Name (ARN) of the simulation job.

Returns:

The Amazon Resource Name (ARN) of the simulation job.

name

public String name()

The name of the simulation job.

Returns:

The name of the simulation job.

status

public SimulationJobStatus status()

Status of the simulation job.

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

Returns:

Status of the simulation job.

See Also:

SimulationJobStatus

statusAsString

public String statusAsString()

Status of the simulation job.

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

Returns:

Status of the simulation job.

See Also:

SimulationJobStatus

lastUpdatedAt

public Instant lastUpdatedAt()

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

Returns:

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

failureBehavior

public FailureBehavior failureBehavior()

The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

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

Returns:

The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

See Also:

FailureBehavior

failureBehaviorAsString

public String failureBehaviorAsString()

The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

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

Returns:

The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

See Also:

FailureBehavior

failureCode

public SimulationJobErrorCode failureCode()

The failure code of the simulation job if it failed.

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

Returns:

The failure code of the simulation job if it failed.

See Also:

SimulationJobErrorCode

failureCodeAsString

public String failureCodeAsString()

The failure code of the simulation job if it failed.

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

Returns:

The failure code of the simulation job if it failed.

See Also:

SimulationJobErrorCode

clientRequestToken

public String clientRequestToken()

A unique identifier for this SimulationJob request.

Returns:

A unique identifier for this SimulationJob request.

outputLocation

public OutputLocation outputLocation()

Location for output files generated by the simulation job.

Returns:

Location for output files generated by the simulation job.

maxJobDurationInSeconds

public Long maxJobDurationInSeconds()

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

Returns:

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

simulationTimeMillis

public Long simulationTimeMillis()

The simulation job execution duration in milliseconds.

Returns:

The simulation job execution duration in milliseconds.

iamRole

public String iamRole()

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. See how to specify AWS security credentials for your application.

Returns:

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job. See how to specify AWS security credentials for your application.

robotApplications

public List<RobotApplicationConfig> robotApplications()

A list of robot applications.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of robot applications.

simulationApplications

public List<SimulationApplicationConfig> simulationApplications()

A list of simulation applications.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of simulation applications.

vpcConfig

public VPCConfigResponse vpcConfig()

VPC configuration information.

Returns:

VPC configuration information.

toBuilder

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

Returns:

a builder for type T

builder

public static SimulationJob.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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