Struct aws_sdk_robomaker::types::builders::ToolBuilder

#[non_exhaustive]
pub struct ToolBuilder { /* private fields */ }

A builder for Tool.

Implementations

impl ToolBuilder

pub fn stream_ui(self, input: bool) -> Self

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.

pub fn set_stream_ui(self, input: Option<bool>) -> Self

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.

pub fn get_stream_ui(&self) -> &Option<bool>

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.

pub fn name(self, input: impl Into<String>) -> Self

The name of the tool.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the tool.

pub fn get_name(&self) -> &Option<String>

The name of the tool.

pub fn command(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_command(self, input: Option<String>) -> Self

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

pub fn get_command(&self) -> &Option<String>

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

pub fn stream_output_to_cloud_watch(self, input: bool) -> Self

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

pub fn set_stream_output_to_cloud_watch(self, input: Option<bool>) -> Self

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

pub fn get_stream_output_to_cloud_watch(&self) -> &Option<bool>

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

pub fn exit_behavior(self, input: ExitBehavior) -> Self

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.

pub fn set_exit_behavior(self, input: Option<ExitBehavior>) -> Self

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.

pub fn get_exit_behavior(&self) -> &Option<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.

pub fn build(self) -> Result<Tool, BuildError>

Consumes the builder and constructs a Tool. This method will fail if any of the following fields are not set:

• name
• command

Trait Implementations

impl Clone for ToolBuilder

fn clone(&self) -> ToolBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ToolBuilder

fn default() -> ToolBuilder

Returns the “default value” for a type.

impl PartialEq for ToolBuilder

fn eq(&self, other: &ToolBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ToolBuilder