Interface SimulationJobRequest.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SimulationJobRequest.Builder,
,SimulationJobRequest> SdkBuilder<SimulationJobRequest.Builder,
,SimulationJobRequest> SdkPojo
- Enclosing class:
SimulationJobRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault SimulationJobRequest.Builder
compute
(Consumer<Compute.Builder> compute) Compute information for the simulation jobCompute information for the simulation jobdataSources
(Collection<DataSourceConfig> dataSources) Specify data sources to mount read-only files from S3 into your simulation.dataSources
(Consumer<DataSourceConfig.Builder>... dataSources) Specify data sources to mount read-only files from S3 into your simulation.dataSources
(DataSourceConfig... dataSources) Specify data sources to mount read-only files from S3 into your simulation.failureBehavior
(String failureBehavior) The failure behavior the simulation job.failureBehavior
(FailureBehavior failureBehavior) The failure behavior the simulation job.The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.default SimulationJobRequest.Builder
loggingConfig
(Consumer<LoggingConfig.Builder> loggingConfig) Sets the value of the LoggingConfig property for this object.loggingConfig
(LoggingConfig loggingConfig) Sets the value of the LoggingConfig property for this object.maxJobDurationInSeconds
(Long maxJobDurationInSeconds) The maximum simulation job duration in seconds.default SimulationJobRequest.Builder
outputLocation
(Consumer<OutputLocation.Builder> outputLocation) Sets the value of the OutputLocation property for this object.outputLocation
(OutputLocation outputLocation) Sets the value of the OutputLocation property for this object.robotApplications
(Collection<RobotApplicationConfig> robotApplications) The robot applications to use in the simulation job.robotApplications
(Consumer<RobotApplicationConfig.Builder>... robotApplications) The robot applications to use in the simulation job.robotApplications
(RobotApplicationConfig... robotApplications) The robot applications to use in the simulation job.simulationApplications
(Collection<SimulationApplicationConfig> simulationApplications) The simulation applications to use in the simulation job.simulationApplications
(Consumer<SimulationApplicationConfig.Builder>... simulationApplications) The simulation applications to use in the simulation job.simulationApplications
(SimulationApplicationConfig... simulationApplications) The simulation applications to use in the simulation job.A map that contains tag keys and tag values that are attached to the simulation job request.useDefaultApplications
(Boolean useDefaultApplications) A Boolean indicating whether to use default applications in the simulation job.default SimulationJobRequest.Builder
vpcConfig
(Consumer<VPCConfig.Builder> vpcConfig) Sets the value of the VpcConfig property for this object.Sets the value of the VpcConfig property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
outputLocation
Sets the value of the OutputLocation property for this object.- Parameters:
outputLocation
- The new value for the OutputLocation property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputLocation
default SimulationJobRequest.Builder outputLocation(Consumer<OutputLocation.Builder> outputLocation) Sets the value of the OutputLocation property for this object. This is a convenience method that creates an instance of theOutputLocation.Builder
avoiding the need to create one manually viaOutputLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputLocation(OutputLocation)
.- Parameters:
outputLocation
- a consumer that will call methods onOutputLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
loggingConfig
Sets the value of the LoggingConfig property for this object.- Parameters:
loggingConfig
- The new value for the LoggingConfig property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loggingConfig
Sets the value of the LoggingConfig property for this object. This is a convenience method that creates an instance of theLoggingConfig.Builder
avoiding the need to create one manually viaLoggingConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologgingConfig(LoggingConfig)
.- Parameters:
loggingConfig
- a consumer that will call methods onLoggingConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
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
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:
-
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.
-
robotApplications
SimulationJobRequest.Builder robotApplications(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.
-
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.
-
robotApplications
SimulationJobRequest.Builder robotApplications(Consumer<RobotApplicationConfig.Builder>... robotApplications) The robot applications to use in the simulation job.
This is a convenience method that creates an instance of theRobotApplicationConfig.Builder
avoiding the need to create one manually viaRobotApplicationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torobotApplications(List<RobotApplicationConfig>)
.- Parameters:
robotApplications
- a consumer that will call methods onRobotApplicationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
simulationApplications
SimulationJobRequest.Builder simulationApplications(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.
-
simulationApplications
SimulationJobRequest.Builder simulationApplications(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.
-
simulationApplications
SimulationJobRequest.Builder simulationApplications(Consumer<SimulationApplicationConfig.Builder>... simulationApplications) The simulation applications to use in the simulation job.
This is a convenience method that creates an instance of theSimulationApplicationConfig.Builder
avoiding the need to create one manually viaSimulationApplicationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosimulationApplications(List<SimulationApplicationConfig>)
.- Parameters:
simulationApplications
- a consumer that will call methods onSimulationApplicationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
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.DataSourceConfig.Builder
avoiding the need to create one manually viaDataSourceConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataSources(List<DataSourceConfig>)
.- Parameters:
dataSources
- a consumer that will call methods onDataSourceConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
vpcConfig
Sets the value of the VpcConfig property for this object.- Parameters:
vpcConfig
- The new value for the VpcConfig property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfig
Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of theVPCConfig.Builder
avoiding the need to create one manually viaVPCConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfig(VPCConfig)
.- Parameters:
vpcConfig
- a consumer that will call methods onVPCConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
compute
Compute information for the simulation job
This is a convenience method that creates an instance of theCompute.Builder
avoiding the need to create one manually viaCompute.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocompute(Compute)
.- Parameters:
compute
- a consumer that will call methods onCompute.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-