SimulationJob (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SimulationJob.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`ComputeResponse`	`compute()` Compute information for the simulation job
`List<DataSource>`	`dataSources()` The data sources for the simulation job.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(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.
`String`	`failureReason()` The reason why the simulation job failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDataSources()` Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRobotApplications()` Returns true if the RobotApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSimulationApplications()` Returns true if the SimulationApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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`	`lastStartedAt()` The time, in milliseconds since the epoch, when the simulation job was last started.
`Instant`	`lastUpdatedAt()` The time, in milliseconds since the epoch, when the simulation job was last updated.
`LoggingConfig`	`loggingConfig()` The logging configuration.
`Long`	`maxJobDurationInSeconds()` The maximum simulation job duration in seconds.
`String`	`name()` The name of the simulation job.
`NetworkInterface`	`networkInterface()` Information about a network interface.
`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.
`Map<String,String>`	`tags()` A map that contains tag keys and tag values that are attached to the simulation job.
`SimulationJob.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VPCConfigResponse`	`vpcConfig()` VPC configuration information.

Methods inherited from class java.lang.Object
clone, finalize, 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
  - lastStartedAt
```
public Instant lastStartedAt()
```
    The time, in milliseconds since the epoch, when the simulation job was last started.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the simulation job was last started.
  - 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
  - failureReason
```
public String failureReason()
```
    The reason why the simulation job failed.
    
    Returns:
    
    The reason why the simulation job failed.
  - 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.
  - loggingConfig
```
public LoggingConfig loggingConfig()
```
    The logging configuration.
    
    Returns:
    
    The logging configuration.
  - 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.
    
    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.
  - hasRobotApplications
```
public boolean hasRobotApplications()
```
    Returns true if the RobotApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - robotApplications
```
public List<RobotApplicationConfig> robotApplications()
```
    A list of robot applications.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRobotApplications() to see if a value was sent in this field.
    
    Returns:
    
    A list of robot applications.
  - hasSimulationApplications
```
public boolean hasSimulationApplications()
```
    Returns true if the SimulationApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - simulationApplications
```
public List<SimulationApplicationConfig> simulationApplications()
```
    A list of simulation applications.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSimulationApplications() to see if a value was sent in this field.
    
    Returns:
    
    A list of simulation applications.
  - hasDataSources
```
public boolean hasDataSources()
```
    Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - dataSources
```
public List<DataSource> dataSources()
```
    The data sources for the simulation job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDataSources() to see if a value was sent in this field.
    
    Returns:
    
    The data sources for the simulation job.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    A map that contains tag keys and tag values that are attached to the simulation job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A map that contains tag keys and tag values that are attached to the simulation job.
  - vpcConfig
```
public VPCConfigResponse vpcConfig()
```
    VPC configuration information.
    
    Returns:
    
    VPC configuration information.
  - networkInterface
```
public NetworkInterface networkInterface()
```
    Information about a network interface.
    
    Returns:
    
    Information about a network interface.
  - compute
```
public ComputeResponse compute()
```
    Compute information for the simulation job
    
    Returns:
    
    Compute information for the simulation job
  - toBuilder
```
public SimulationJob.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SimulationJob.Builder,SimulationJob>
  - 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
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SimulationJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

status

statusAsString

lastStartedAt

lastUpdatedAt

failureBehavior

failureBehaviorAsString

failureCode

failureCodeAsString

failureReason

clientRequestToken

outputLocation

loggingConfig

maxJobDurationInSeconds

simulationTimeMillis

iamRole

hasRobotApplications

robotApplications

hasSimulationApplications

simulationApplications

hasDataSources

dataSources

hasTags

tags

vpcConfig

networkInterface

compute

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields