SimulationJobRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.robomaker.model.SimulationJobRequest

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SimulationJobRequest.Builder,SimulationJobRequest>

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

Information about a simulation job request.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SimulationJobRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SimulationJobRequest.Builder`	`builder()`
`Compute`	`compute()` Compute information for the simulation job
`List<DataSourceConfig>`	`dataSources()` Specify data sources to mount read-only files from S3 into your simulation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FailureBehavior`	`failureBehavior()` The failure behavior the simulation job.
`String`	`failureBehaviorAsString()` The failure behavior the simulation job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDataSources()` For responses, this returns true if the service returned a value for the DataSources property.
`int`	`hashCode()`
`boolean`	`hasRobotApplications()` For responses, this returns true if the service returned a value for the RobotApplications property.
`boolean`	`hasSimulationApplications()` For responses, this returns true if the service returned a value for the SimulationApplications property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`iamRole()` The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
`LoggingConfig`	`loggingConfig()` Returns the value of the LoggingConfig property for this object.
`Long`	`maxJobDurationInSeconds()` The maximum simulation job duration in seconds.
`OutputLocation`	`outputLocation()` Returns the value of the OutputLocation property for this object.
`List<RobotApplicationConfig>`	`robotApplications()` The robot applications to use in the simulation job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SimulationJobRequest.Builder>`	`serializableBuilderClass()`
`List<SimulationApplicationConfig>`	`simulationApplications()` The simulation applications to use in the simulation job.
`Map<String,String>`	`tags()` A map that contains tag keys and tag values that are attached to the simulation job request.
`SimulationJobRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`useDefaultApplications()` A Boolean indicating whether to use default applications in the simulation job.
`VPCConfig`	`vpcConfig()` Returns the value of the VpcConfig property for this object.

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
  - outputLocation
```
public final OutputLocation outputLocation()
```
    Returns the value of the OutputLocation property for this object.
    
    Returns:
    
    The value of the OutputLocation property for this object.
  - loggingConfig
```
public final LoggingConfig loggingConfig()
```
    Returns the value of the LoggingConfig property for this object.
    
    Returns:
    
    The value of the LoggingConfig property for this object.
  - maxJobDurationInSeconds
```
public final 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.
  - iamRole
```
public final String iamRole()
```
    The IAM role name 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 name 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.
  - failureBehavior
```
public final FailureBehavior failureBehavior()
```
    The failure behavior the simulation job.
    
    Continue
    
    Leaves the host running for its maximum timeout duration after a 4XX error code.
    
    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
    
    Leaves the host running for its maximum timeout duration after a 4XX error code.
    
    Fail
    
    Stop the simulation job and terminate the instance.
    
    See Also:
    
    FailureBehavior
  - failureBehaviorAsString
```
public final String failureBehaviorAsString()
```
    The failure behavior the simulation job.
    
    Continue
    
    Leaves the host running for its maximum timeout duration after a 4XX error code.
    
    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
    
    Leaves the host running for its maximum timeout duration after a 4XX error code.
    
    Fail
    
    Stop the simulation job and terminate the instance.
    
    See Also:
    
    FailureBehavior
  - useDefaultApplications
```
public final Boolean useDefaultApplications()
```
    A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
    
    Returns:
    
    A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
  - hasRobotApplications
```
public final boolean hasRobotApplications()
```
    For responses, this returns true if the service returned a value for the RobotApplications property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - robotApplications
```
public final List<RobotApplicationConfig> robotApplications()
```
    The robot applications to use in the simulation job.
    
    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 hasRobotApplications() method.
    
    Returns:
    
    The robot applications to use in the simulation job.
  - hasSimulationApplications
```
public final boolean hasSimulationApplications()
```
    For responses, this returns true if the service returned a value for the SimulationApplications property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - simulationApplications
```
public final List<SimulationApplicationConfig> simulationApplications()
```
    The simulation applications to use in the simulation job.
    
    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 hasSimulationApplications() method.
    
    Returns:
    
    The simulation applications to use in the simulation job.
  - hasDataSources
```
public final boolean hasDataSources()
```
    For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - dataSources
```
public final List<DataSourceConfig> dataSources()
```
    Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.
    
    There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
    
    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 hasDataSources() method.
    
    Returns:
    
    Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.
    
    There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.
  - vpcConfig
```
public final VPCConfig vpcConfig()
```
    Returns the value of the VpcConfig property for this object.
    
    Returns:
    
    The value of the VpcConfig property for this object.
  - compute
```
public final Compute compute()
```
    Compute information for the simulation job
    
    Returns:
    
    Compute information for the simulation job
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - tags
```
public final Map<String,String> tags()
```
    A map that contains tag keys and tag values that are attached to the simulation job request.
    
    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.
    
    Returns:
    
    A map that contains tag keys and tag values that are attached to the simulation job request.
  - toBuilder
```
public SimulationJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SimulationJobRequest.Builder,SimulationJobRequest>
  - builder
```
public static SimulationJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SimulationJobRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class SimulationJobRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

outputLocation

loggingConfig

maxJobDurationInSeconds

iamRole

failureBehavior

failureBehaviorAsString

useDefaultApplications

hasRobotApplications

robotApplications

hasSimulationApplications

simulationApplications

hasDataSources

dataSources

vpcConfig

compute

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields