Interface RobotApplicationConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RobotApplicationConfig.Builder,RobotApplicationConfig>, SdkBuilder<RobotApplicationConfig.Builder,RobotApplicationConfig>, SdkPojo
Enclosing class:
RobotApplicationConfig
@Mutable @NotThreadSafe public static interface RobotApplicationConfig.Builder extends SdkPojo, CopyableBuilder<RobotApplicationConfig.Builder,RobotApplicationConfig>

  • Method Details

    • application

      RobotApplicationConfig.Builder application(String application)

      The application information for the robot application.

      Parameters:
      application - The application information for the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationVersion

      RobotApplicationConfig.Builder applicationVersion(String applicationVersion)

      The version of the robot application.

      Parameters:
      applicationVersion - The version of the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchConfig

      RobotApplicationConfig.Builder launchConfig(LaunchConfig launchConfig)

      The launch configuration for the robot application.

      Parameters:
      launchConfig - The launch configuration for the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • launchConfig

      default RobotApplicationConfig.Builder launchConfig(Consumer<LaunchConfig.Builder> launchConfig)

      The launch configuration for the robot application.

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

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

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

    • uploadConfigurations

      RobotApplicationConfig.Builder uploadConfigurations(Collection<UploadConfiguration> uploadConfigurations)

      The upload configurations for the robot application.

      Parameters:
      uploadConfigurations - The upload configurations for the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uploadConfigurations

      RobotApplicationConfig.Builder uploadConfigurations(UploadConfiguration... uploadConfigurations)

      The upload configurations for the robot application.

      Parameters:
      uploadConfigurations - The upload configurations for the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uploadConfigurations

      RobotApplicationConfig.Builder uploadConfigurations(Consumer<UploadConfiguration.Builder>... uploadConfigurations)

      The upload configurations for the robot application.

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

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

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

    • useDefaultUploadConfigurations

      @Deprecated RobotApplicationConfig.Builder useDefaultUploadConfigurations(Boolean useDefaultUploadConfigurations)
      Deprecated.
      AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html.

      A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

      If you set this value, you must specify an outputLocation.

      This API is no longer supported and will throw an error if used.

      Parameters:
      useDefaultUploadConfigurations - A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

      If you set this value, you must specify an outputLocation.

      This API is no longer supported and will throw an error if used.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tools

      RobotApplicationConfig.Builder tools(Collection<Tool> tools)

      Information about tools configured for the robot application.

      Parameters:
      tools - Information about tools configured for the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tools

      RobotApplicationConfig.Builder tools(Tool... tools)

      Information about tools configured for the robot application.

      Parameters:
      tools - Information about tools configured for the robot application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tools

      RobotApplicationConfig.Builder tools(Consumer<Tool.Builder>... tools)

      Information about tools configured for the robot application.

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

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

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

    • useDefaultTools

      @Deprecated RobotApplicationConfig.Builder useDefaultTools(Boolean useDefaultTools)
      Deprecated.
      AWS RoboMaker is ending support for ROS software suite. For additional information, see https://docs.aws.amazon.com/robomaker/latest/dg/software-support-policy.html.

      A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

      This API is no longer supported and will throw an error if used.

      Parameters:
      useDefaultTools - A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

      This API is no longer supported and will throw an error if used.

      Returns:
      Returns a reference to this object so that method calls can be chained together.