SimulationJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.robomaker.model.SimulationJobRequest

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SimulationJobRequest
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about a simulation job request.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SimulationJobRequest()

Constructors
Constructor and Description
`SimulationJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SimulationJobRequest`	`addTagsEntry(String key, String value)` Add a single Tags entry
`SimulationJobRequest`	`clearTagsEntries()` Removes all the entries added into Tags.
`SimulationJobRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Compute`	`getCompute()` Compute information for the simulation job
`List<DataSourceConfig>`	`getDataSources()` Specify data sources to mount read-only files from S3 into your simulation.
`String`	`getFailureBehavior()` The failure behavior the simulation job.
`String`	`getIamRole()` 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`	`getLoggingConfig()`
`Long`	`getMaxJobDurationInSeconds()` The maximum simulation job duration in seconds.
`OutputLocation`	`getOutputLocation()`
`List<RobotApplicationConfig>`	`getRobotApplications()` The robot applications to use in the simulation job.
`List<SimulationApplicationConfig>`	`getSimulationApplications()` The simulation applications to use in the simulation job.
`Map<String,String>`	`getTags()` A map that contains tag keys and tag values that are attached to the simulation job request.
`Boolean`	`getUseDefaultApplications()` A Boolean indicating whether to use default applications in the simulation job.
`VPCConfig`	`getVpcConfig()`
`int`	`hashCode()`
`Boolean`	`isUseDefaultApplications()` A Boolean indicating whether to use default applications in the simulation job.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCompute(Compute compute)` Compute information for the simulation job
`void`	`setDataSources(Collection<DataSourceConfig> dataSources)` Specify data sources to mount read-only files from S3 into your simulation.
`void`	`setFailureBehavior(String failureBehavior)` The failure behavior the simulation job.
`void`	`setIamRole(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.
`void`	`setLoggingConfig(LoggingConfig loggingConfig)`
`void`	`setMaxJobDurationInSeconds(Long maxJobDurationInSeconds)` The maximum simulation job duration in seconds.
`void`	`setOutputLocation(OutputLocation outputLocation)`
`void`	`setRobotApplications(Collection<RobotApplicationConfig> robotApplications)` The robot applications to use in the simulation job.
`void`	`setSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications)` The simulation applications to use in the simulation job.
`void`	`setTags(Map<String,String> tags)` A map that contains tag keys and tag values that are attached to the simulation job request.
`void`	`setUseDefaultApplications(Boolean useDefaultApplications)` A Boolean indicating whether to use default applications in the simulation job.
`void`	`setVpcConfig(VPCConfig vpcConfig)`
`String`	`toString()` Returns a string representation of this object.
`SimulationJobRequest`	`withCompute(Compute compute)` Compute information for the simulation job
`SimulationJobRequest`	`withDataSources(Collection<DataSourceConfig> dataSources)` Specify data sources to mount read-only files from S3 into your simulation.
`SimulationJobRequest`	`withDataSources(DataSourceConfig... dataSources)` Specify data sources to mount read-only files from S3 into your simulation.
`SimulationJobRequest`	`withFailureBehavior(FailureBehavior failureBehavior)` The failure behavior the simulation job.
`SimulationJobRequest`	`withFailureBehavior(String failureBehavior)` The failure behavior the simulation job.
`SimulationJobRequest`	`withIamRole(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.
`SimulationJobRequest`	`withLoggingConfig(LoggingConfig loggingConfig)`
`SimulationJobRequest`	`withMaxJobDurationInSeconds(Long maxJobDurationInSeconds)` The maximum simulation job duration in seconds.
`SimulationJobRequest`	`withOutputLocation(OutputLocation outputLocation)`
`SimulationJobRequest`	`withRobotApplications(Collection<RobotApplicationConfig> robotApplications)` The robot applications to use in the simulation job.
`SimulationJobRequest`	`withRobotApplications(RobotApplicationConfig... robotApplications)` The robot applications to use in the simulation job.
`SimulationJobRequest`	`withSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications)` The simulation applications to use in the simulation job.
`SimulationJobRequest`	`withSimulationApplications(SimulationApplicationConfig... simulationApplications)` The simulation applications to use in the simulation job.
`SimulationJobRequest`	`withTags(Map<String,String> tags)` A map that contains tag keys and tag values that are attached to the simulation job request.
`SimulationJobRequest`	`withUseDefaultApplications(Boolean useDefaultApplications)` A Boolean indicating whether to use default applications in the simulation job.
`SimulationJobRequest`	`withVpcConfig(VPCConfig vpcConfig)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimulationJobRequest
```
public SimulationJobRequest()
```
- Method Detail
  - setOutputLocation
```
public void setOutputLocation(OutputLocation outputLocation)
```
    Parameters:
    
    outputLocation -
  - getOutputLocation
```
public OutputLocation getOutputLocation()
```
    Returns:
  - withOutputLocation
```
public SimulationJobRequest withOutputLocation(OutputLocation outputLocation)
```
    Parameters:
    
    outputLocation -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoggingConfig
```
public void setLoggingConfig(LoggingConfig loggingConfig)
```
    Parameters:
    
    loggingConfig -
  - getLoggingConfig
```
public LoggingConfig getLoggingConfig()
```
    Returns:
  - withLoggingConfig
```
public SimulationJobRequest withLoggingConfig(LoggingConfig loggingConfig)
```
    Parameters:
    
    loggingConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxJobDurationInSeconds
```
public void setMaxJobDurationInSeconds(Long maxJobDurationInSeconds)
```
    The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
    
    Parameters:
    
    maxJobDurationInSeconds - The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
  - getMaxJobDurationInSeconds
```
public Long getMaxJobDurationInSeconds()
```
    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.
  - withMaxJobDurationInSeconds
```
public SimulationJobRequest withMaxJobDurationInSeconds(Long maxJobDurationInSeconds)
```
    The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
    
    Parameters:
    
    maxJobDurationInSeconds - The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRole
```
public void setIamRole(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.
    
    Parameters:
    
    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.
  - getIamRole
```
public String getIamRole()
```
    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.
  - withIamRole
```
public SimulationJobRequest withIamRole(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureBehavior
```
public void setFailureBehavior(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    FailureBehavior
  - getFailureBehavior
```
public String getFailureBehavior()
```
    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.
    
    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
  - withFailureBehavior
```
public SimulationJobRequest withFailureBehavior(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FailureBehavior
  - withFailureBehavior
```
public SimulationJobRequest withFailureBehavior(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FailureBehavior
  - setUseDefaultApplications
```
public void setUseDefaultApplications(Boolean useDefaultApplications)
```
    A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
    
    Parameters:
    
    useDefaultApplications - A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
  - getUseDefaultApplications
```
public Boolean getUseDefaultApplications()
```
    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.
  - withUseDefaultApplications
```
public SimulationJobRequest withUseDefaultApplications(Boolean useDefaultApplications)
```
    A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
    
    Parameters:
    
    useDefaultApplications - A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseDefaultApplications
```
public Boolean isUseDefaultApplications()
```
    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.
  - getRobotApplications
```
public List<RobotApplicationConfig> getRobotApplications()
```
    The robot applications to use in the simulation job.
    
    Returns:
    
    The robot applications to use in the simulation job.
  - setRobotApplications
```
public void setRobotApplications(Collection<RobotApplicationConfig> robotApplications)
```
    The robot applications to use in the simulation job.
    
    Parameters:
    
    robotApplications - The robot applications to use in the simulation job.
  - withRobotApplications
```
public SimulationJobRequest withRobotApplications(RobotApplicationConfig... robotApplications)
```
    The robot applications to use in the simulation job.
    
    NOTE: This method appends the values to the existing list (if any). Use setRobotApplications(java.util.Collection) or withRobotApplications(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    robotApplications - The robot applications to use in the simulation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRobotApplications
```
public SimulationJobRequest withRobotApplications(Collection<RobotApplicationConfig> robotApplications)
```
    The robot applications to use in the simulation job.
    
    Parameters:
    
    robotApplications - The robot applications to use in the simulation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSimulationApplications
```
public List<SimulationApplicationConfig> getSimulationApplications()
```
    The simulation applications to use in the simulation job.
    
    Returns:
    
    The simulation applications to use in the simulation job.
  - setSimulationApplications
```
public void setSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications)
```
    The simulation applications to use in the simulation job.
    
    Parameters:
    
    simulationApplications - The simulation applications to use in the simulation job.
  - withSimulationApplications
```
public SimulationJobRequest withSimulationApplications(SimulationApplicationConfig... simulationApplications)
```
    The simulation applications to use in the simulation job.
    
    NOTE: This method appends the values to the existing list (if any). Use setSimulationApplications(java.util.Collection) or withSimulationApplications(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    simulationApplications - The simulation applications to use in the simulation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSimulationApplications
```
public SimulationJobRequest withSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications)
```
    The simulation applications to use in the simulation job.
    
    Parameters:
    
    simulationApplications - The simulation applications to use in the simulation job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDataSources
```
public List<DataSourceConfig> getDataSources()
```
    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.
    
    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.
  - setDataSources
```
public void setDataSources(Collection<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.
    
    Parameters:
    
    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.
  - withDataSources
```
public SimulationJobRequest withDataSources(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDataSources(java.util.Collection) or withDataSources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDataSources
```
public SimulationJobRequest withDataSources(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfig
```
public void setVpcConfig(VPCConfig vpcConfig)
```
    Parameters:
    
    vpcConfig -
  - getVpcConfig
```
public VPCConfig getVpcConfig()
```
    Returns:
  - withVpcConfig
```
public SimulationJobRequest withVpcConfig(VPCConfig vpcConfig)
```
    Parameters:
    
    vpcConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompute
```
public void setCompute(Compute compute)
```
    Compute information for the simulation job
    
    Parameters:
    
    compute - Compute information for the simulation job
  - getCompute
```
public Compute getCompute()
```
    Compute information for the simulation job
    
    Returns:
    
    Compute information for the simulation job
  - withCompute
```
public SimulationJobRequest withCompute(Compute compute)
```
    Compute information for the simulation job
    
    Parameters:
    
    compute - Compute information for the simulation job
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    A map that contains tag keys and tag values that are attached to the simulation job request.
    
    Returns:
    
    A map that contains tag keys and tag values that are attached to the simulation job request.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    A map that contains tag keys and tag values that are attached to the simulation job request.
    
    Parameters:
    
    tags - A map that contains tag keys and tag values that are attached to the simulation job request.
  - withTags
```
public SimulationJobRequest withTags(Map<String,String> tags)
```
    A map that contains tag keys and tag values that are attached to the simulation job request.
    
    Parameters:
    
    tags - A map that contains tag keys and tag values that are attached to the simulation job request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public SimulationJobRequest addTagsEntry(String key,
                                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public SimulationJobRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SimulationJobRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class SimulationJobRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimulationJobRequest

Method Detail

setOutputLocation

getOutputLocation

withOutputLocation

setLoggingConfig

getLoggingConfig

withLoggingConfig

setMaxJobDurationInSeconds

getMaxJobDurationInSeconds

withMaxJobDurationInSeconds

setIamRole

getIamRole

withIamRole

setFailureBehavior

getFailureBehavior

withFailureBehavior

withFailureBehavior

setUseDefaultApplications

getUseDefaultApplications

withUseDefaultApplications

isUseDefaultApplications

getRobotApplications

setRobotApplications

withRobotApplications

withRobotApplications

getSimulationApplications

setSimulationApplications

withSimulationApplications

withSimulationApplications

getDataSources

setDataSources

withDataSources

withDataSources

setVpcConfig

getVpcConfig

withVpcConfig

setCompute

getCompute

withCompute

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall