#[non_exhaustive]pub struct SimulationJobRequestBuilder { /* private fields */ }
Expand description
A builder for SimulationJobRequest
.
Implementations§
Source§impl SimulationJobRequestBuilder
impl SimulationJobRequestBuilder
Sourcepub fn output_location(self, input: OutputLocation) -> Self
pub fn output_location(self, input: OutputLocation) -> Self
The output location.
Sourcepub fn set_output_location(self, input: Option<OutputLocation>) -> Self
pub fn set_output_location(self, input: Option<OutputLocation>) -> Self
The output location.
Sourcepub fn get_output_location(&self) -> &Option<OutputLocation>
pub fn get_output_location(&self) -> &Option<OutputLocation>
The output location.
Sourcepub fn logging_config(self, input: LoggingConfig) -> Self
pub fn logging_config(self, input: LoggingConfig) -> Self
The logging configuration.
Sourcepub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self
pub fn set_logging_config(self, input: Option<LoggingConfig>) -> Self
The logging configuration.
Sourcepub fn get_logging_config(&self) -> &Option<LoggingConfig>
pub fn get_logging_config(&self) -> &Option<LoggingConfig>
The logging configuration.
Sourcepub fn max_job_duration_in_seconds(self, input: i64) -> Self
pub fn max_job_duration_in_seconds(self, input: i64) -> Self
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
This field is required.Sourcepub fn set_max_job_duration_in_seconds(self, input: Option<i64>) -> Self
pub fn set_max_job_duration_in_seconds(self, input: Option<i64>) -> Self
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
Sourcepub fn get_max_job_duration_in_seconds(&self) -> &Option<i64>
pub fn get_max_job_duration_in_seconds(&self) -> &Option<i64>
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
Sourcepub fn iam_role(self, input: impl Into<String>) -> Self
pub fn iam_role(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_iam_role(self, input: Option<String>) -> Self
pub fn set_iam_role(self, input: Option<String>) -> Self
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.
Sourcepub fn get_iam_role(&self) -> &Option<String>
pub fn get_iam_role(&self) -> &Option<String>
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.
Sourcepub fn failure_behavior(self, input: FailureBehavior) -> Self
pub fn failure_behavior(self, input: FailureBehavior) -> Self
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.
Sourcepub fn set_failure_behavior(self, input: Option<FailureBehavior>) -> Self
pub fn set_failure_behavior(self, input: Option<FailureBehavior>) -> Self
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.
Sourcepub fn get_failure_behavior(&self) -> &Option<FailureBehavior>
pub fn get_failure_behavior(&self) -> &Option<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.
Sourcepub fn use_default_applications(self, input: bool) -> Self
pub fn use_default_applications(self, input: bool) -> Self
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
Sourcepub fn set_use_default_applications(self, input: Option<bool>) -> Self
pub fn set_use_default_applications(self, input: Option<bool>) -> Self
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
Sourcepub fn get_use_default_applications(&self) -> &Option<bool>
pub fn get_use_default_applications(&self) -> &Option<bool>
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
Sourcepub fn robot_applications(self, input: RobotApplicationConfig) -> Self
pub fn robot_applications(self, input: RobotApplicationConfig) -> Self
Appends an item to robot_applications
.
To override the contents of this collection use set_robot_applications
.
The robot applications to use in the simulation job.
Sourcepub fn set_robot_applications(
self,
input: Option<Vec<RobotApplicationConfig>>,
) -> Self
pub fn set_robot_applications( self, input: Option<Vec<RobotApplicationConfig>>, ) -> Self
The robot applications to use in the simulation job.
Sourcepub fn get_robot_applications(&self) -> &Option<Vec<RobotApplicationConfig>>
pub fn get_robot_applications(&self) -> &Option<Vec<RobotApplicationConfig>>
The robot applications to use in the simulation job.
Sourcepub fn simulation_applications(self, input: SimulationApplicationConfig) -> Self
pub fn simulation_applications(self, input: SimulationApplicationConfig) -> Self
Appends an item to simulation_applications
.
To override the contents of this collection use set_simulation_applications
.
The simulation applications to use in the simulation job.
Sourcepub fn set_simulation_applications(
self,
input: Option<Vec<SimulationApplicationConfig>>,
) -> Self
pub fn set_simulation_applications( self, input: Option<Vec<SimulationApplicationConfig>>, ) -> Self
The simulation applications to use in the simulation job.
Sourcepub fn get_simulation_applications(
&self,
) -> &Option<Vec<SimulationApplicationConfig>>
pub fn get_simulation_applications( &self, ) -> &Option<Vec<SimulationApplicationConfig>>
The simulation applications to use in the simulation job.
Sourcepub fn data_sources(self, input: DataSourceConfig) -> Self
pub fn data_sources(self, input: DataSourceConfig) -> Self
Appends an item to data_sources
.
To override the contents of this collection use set_data_sources
.
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.
Sourcepub fn set_data_sources(self, input: Option<Vec<DataSourceConfig>>) -> Self
pub fn set_data_sources(self, input: Option<Vec<DataSourceConfig>>) -> Self
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.
Sourcepub fn get_data_sources(&self) -> &Option<Vec<DataSourceConfig>>
pub fn get_data_sources(&self) -> &Option<Vec<DataSourceConfig>>
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.
Sourcepub fn vpc_config(self, input: VpcConfig) -> Self
pub fn vpc_config(self, input: VpcConfig) -> Self
If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.
Sourcepub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self
pub fn set_vpc_config(self, input: Option<VpcConfig>) -> Self
If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.
Sourcepub fn get_vpc_config(&self) -> &Option<VpcConfig>
pub fn get_vpc_config(&self) -> &Option<VpcConfig>
If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.
Sourcepub fn set_compute(self, input: Option<Compute>) -> Self
pub fn set_compute(self, input: Option<Compute>) -> Self
Compute information for the simulation job
Sourcepub fn get_compute(&self) -> &Option<Compute>
pub fn get_compute(&self) -> &Option<Compute>
Compute information for the simulation job
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
A map that contains tag keys and tag values that are attached to the simulation job request.
A map that contains tag keys and tag values that are attached to the simulation job request.
A map that contains tag keys and tag values that are attached to the simulation job request.
Sourcepub fn build(self) -> SimulationJobRequest
pub fn build(self) -> SimulationJobRequest
Consumes the builder and constructs a SimulationJobRequest
.
Trait Implementations§
Source§impl Clone for SimulationJobRequestBuilder
impl Clone for SimulationJobRequestBuilder
Source§fn clone(&self) -> SimulationJobRequestBuilder
fn clone(&self) -> SimulationJobRequestBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SimulationJobRequestBuilder
impl Debug for SimulationJobRequestBuilder
Source§impl Default for SimulationJobRequestBuilder
impl Default for SimulationJobRequestBuilder
Source§fn default() -> SimulationJobRequestBuilder
fn default() -> SimulationJobRequestBuilder
Source§impl PartialEq for SimulationJobRequestBuilder
impl PartialEq for SimulationJobRequestBuilder
Source§fn eq(&self, other: &SimulationJobRequestBuilder) -> bool
fn eq(&self, other: &SimulationJobRequestBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for SimulationJobRequestBuilder
Auto Trait Implementations§
impl Freeze for SimulationJobRequestBuilder
impl RefUnwindSafe for SimulationJobRequestBuilder
impl Send for SimulationJobRequestBuilder
impl Sync for SimulationJobRequestBuilder
impl Unpin for SimulationJobRequestBuilder
impl UnwindSafe for SimulationJobRequestBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);