Interface SimulationJobRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SimulationJobRequest.Builder,SimulationJobRequest>, SdkBuilder<SimulationJobRequest.Builder,SimulationJobRequest>, SdkPojo
Enclosing class:
SimulationJobRequest
public static interface SimulationJobRequest.Builder extends SdkPojo, CopyableBuilder<SimulationJobRequest.Builder,SimulationJobRequest>

  • Method Details

    • outputLocation

      SimulationJobRequest.Builder outputLocation(OutputLocation 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 the OutputLocation.Builder avoiding the need to create one manually via OutputLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputLocation(OutputLocation).

      Parameters:
      outputLocation - a consumer that will call methods on OutputLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingConfig

      SimulationJobRequest.Builder loggingConfig(LoggingConfig 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

      default SimulationJobRequest.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)
      Sets the value of the LoggingConfig property for this object. This is a convenience method that creates an instance of the LoggingConfig.Builder avoiding the need to create one manually via LoggingConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfig(LoggingConfig).

      Parameters:
      loggingConfig - a consumer that will call methods on LoggingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxJobDurationInSeconds

      SimulationJobRequest.Builder maxJobDurationInSeconds(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.

    • iamRole

      SimulationJobRequest.Builder iamRole(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.

    • failureBehavior

      SimulationJobRequest.Builder failureBehavior(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

      SimulationJobRequest.Builder failureBehavior(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:

    • useDefaultApplications

      SimulationJobRequest.Builder useDefaultApplications(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.

    • 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

      SimulationJobRequest.Builder robotApplications(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

      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 the RobotApplicationConfig.Builder avoiding the need to create one manually via RobotApplicationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to robotApplications(List<RobotApplicationConfig>).

      Parameters:
      robotApplications - a consumer that will call methods on RobotApplicationConfig.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 the SimulationApplicationConfig.Builder avoiding the need to create one manually via SimulationApplicationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to simulationApplications(List<SimulationApplicationConfig>).

      Parameters:
      simulationApplications - a consumer that will call methods on SimulationApplicationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataSources

      SimulationJobRequest.Builder dataSources(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.

    • dataSources

      SimulationJobRequest.Builder dataSources(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.

    • dataSources

      SimulationJobRequest.Builder dataSources(Consumer<DataSourceConfig.Builder>... 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.

      This is a convenience method that creates an instance of the DataSourceConfig.Builder avoiding the need to create one manually via DataSourceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSources(List<DataSourceConfig>).

      Parameters:
      dataSources - a consumer that will call methods on DataSourceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      SimulationJobRequest.Builder vpcConfig(VPCConfig 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

      default SimulationJobRequest.Builder vpcConfig(Consumer<VPCConfig.Builder> vpcConfig)
      Sets the value of the VpcConfig property for this object. This is a convenience method that creates an instance of the VPCConfig.Builder avoiding the need to create one manually via VPCConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VPCConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VPCConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • compute

      SimulationJobRequest.Builder compute(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.

    • compute

      default SimulationJobRequest.Builder compute(Consumer<Compute.Builder> compute)

      Compute information for the simulation job

      This is a convenience method that creates an instance of the Compute.Builder avoiding the need to create one manually via Compute.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to compute(Compute).

      Parameters:
      compute - a consumer that will call methods on Compute.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      SimulationJobRequest.Builder tags(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.