Package software.amazon.awssdk.services.robomaker.model

Interface Tool.Builder

    • Method Detail

      • streamUI

        Tool.Builder streamUI​(Boolean streamUI)

        Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

        Parameters:
        streamUI - Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        Tool.Builder name​(String name)

        The name of the tool.

        Parameters:
        name - The name of the tool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • command

        Tool.Builder command​(String command)

        Command-line arguments for the tool. It must include the tool executable name.

        Parameters:
        command - Command-line arguments for the tool. It must include the tool executable name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • streamOutputToCloudWatch

        Tool.Builder streamOutputToCloudWatch​(Boolean streamOutputToCloudWatch)

        Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

        Parameters:
        streamOutputToCloudWatch - Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exitBehavior

        Tool.Builder exitBehavior​(String exitBehavior)

        Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

        Parameters:
        exitBehavior - Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExitBehavior, ExitBehavior

      • exitBehavior

        Tool.Builder exitBehavior​(ExitBehavior exitBehavior)

        Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

        Parameters:
        exitBehavior - Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExitBehavior, ExitBehavior