#[non_exhaustive]pub struct GetCampaignOutputBuilder { /* private fields */ }
Expand description
A builder for GetCampaignOutput
.
Implementations§
Source§impl GetCampaignOutputBuilder
impl GetCampaignOutputBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the campaign.
Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the campaign.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the campaign.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the campaign.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the campaign.
Sourcepub fn signal_catalog_arn(self, input: impl Into<String>) -> Self
pub fn signal_catalog_arn(self, input: impl Into<String>) -> Self
The ARN of a signal catalog.
Sourcepub fn set_signal_catalog_arn(self, input: Option<String>) -> Self
pub fn set_signal_catalog_arn(self, input: Option<String>) -> Self
The ARN of a signal catalog.
Sourcepub fn get_signal_catalog_arn(&self) -> &Option<String>
pub fn get_signal_catalog_arn(&self) -> &Option<String>
The ARN of a signal catalog.
Sourcepub fn target_arn(self, input: impl Into<String>) -> Self
pub fn target_arn(self, input: impl Into<String>) -> Self
The ARN of the vehicle or the fleet targeted by the campaign.
Sourcepub fn set_target_arn(self, input: Option<String>) -> Self
pub fn set_target_arn(self, input: Option<String>) -> Self
The ARN of the vehicle or the fleet targeted by the campaign.
Sourcepub fn get_target_arn(&self) -> &Option<String>
pub fn get_target_arn(&self) -> &Option<String>
The ARN of the vehicle or the fleet targeted by the campaign.
Sourcepub fn status(self, input: CampaignStatus) -> Self
pub fn status(self, input: CampaignStatus) -> Self
The state of the campaign. The status can be one of: CREATING
, WAITING_FOR_APPROVAL
, RUNNING
, and SUSPENDED
.
Sourcepub fn set_status(self, input: Option<CampaignStatus>) -> Self
pub fn set_status(self, input: Option<CampaignStatus>) -> Self
The state of the campaign. The status can be one of: CREATING
, WAITING_FOR_APPROVAL
, RUNNING
, and SUSPENDED
.
Sourcepub fn get_status(&self) -> &Option<CampaignStatus>
pub fn get_status(&self) -> &Option<CampaignStatus>
The state of the campaign. The status can be one of: CREATING
, WAITING_FOR_APPROVAL
, RUNNING
, and SUSPENDED
.
Sourcepub fn start_time(self, input: DateTime) -> Self
pub fn start_time(self, input: DateTime) -> Self
The time, in milliseconds, to deliver a campaign after it was approved.
Sourcepub fn set_start_time(self, input: Option<DateTime>) -> Self
pub fn set_start_time(self, input: Option<DateTime>) -> Self
The time, in milliseconds, to deliver a campaign after it was approved.
Sourcepub fn get_start_time(&self) -> &Option<DateTime>
pub fn get_start_time(&self) -> &Option<DateTime>
The time, in milliseconds, to deliver a campaign after it was approved.
Sourcepub fn expiry_time(self, input: DateTime) -> Self
pub fn expiry_time(self, input: DateTime) -> Self
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
Sourcepub fn set_expiry_time(self, input: Option<DateTime>) -> Self
pub fn set_expiry_time(self, input: Option<DateTime>) -> Self
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
Sourcepub fn get_expiry_time(&self) -> &Option<DateTime>
pub fn get_expiry_time(&self) -> &Option<DateTime>
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.
Sourcepub fn post_trigger_collection_duration(self, input: i64) -> Self
pub fn post_trigger_collection_duration(self, input: i64) -> Self
How long (in seconds) to collect raw data after a triggering event initiates the collection.
Sourcepub fn set_post_trigger_collection_duration(self, input: Option<i64>) -> Self
pub fn set_post_trigger_collection_duration(self, input: Option<i64>) -> Self
How long (in seconds) to collect raw data after a triggering event initiates the collection.
Sourcepub fn get_post_trigger_collection_duration(&self) -> &Option<i64>
pub fn get_post_trigger_collection_duration(&self) -> &Option<i64>
How long (in seconds) to collect raw data after a triggering event initiates the collection.
Sourcepub fn diagnostics_mode(self, input: DiagnosticsMode) -> Self
pub fn diagnostics_mode(self, input: DiagnosticsMode) -> Self
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
Sourcepub fn set_diagnostics_mode(self, input: Option<DiagnosticsMode>) -> Self
pub fn set_diagnostics_mode(self, input: Option<DiagnosticsMode>) -> Self
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
Sourcepub fn get_diagnostics_mode(&self) -> &Option<DiagnosticsMode>
pub fn get_diagnostics_mode(&self) -> &Option<DiagnosticsMode>
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
Sourcepub fn spooling_mode(self, input: SpoolingMode) -> Self
pub fn spooling_mode(self, input: SpoolingMode) -> Self
Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
Sourcepub fn set_spooling_mode(self, input: Option<SpoolingMode>) -> Self
pub fn set_spooling_mode(self, input: Option<SpoolingMode>) -> Self
Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
Sourcepub fn get_spooling_mode(&self) -> &Option<SpoolingMode>
pub fn get_spooling_mode(&self) -> &Option<SpoolingMode>
Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
Sourcepub fn compression(self, input: Compression) -> Self
pub fn compression(self, input: Compression) -> Self
Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF
is specified, the signals aren't compressed. If it's not specified, SNAPPY
is used.
Sourcepub fn set_compression(self, input: Option<Compression>) -> Self
pub fn set_compression(self, input: Option<Compression>) -> Self
Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF
is specified, the signals aren't compressed. If it's not specified, SNAPPY
is used.
Sourcepub fn get_compression(&self) -> &Option<Compression>
pub fn get_compression(&self) -> &Option<Compression>
Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF
is specified, the signals aren't compressed. If it's not specified, SNAPPY
is used.
Sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
Sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
Sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns.
Sourcepub fn signals_to_collect(self, input: SignalInformation) -> Self
pub fn signals_to_collect(self, input: SignalInformation) -> Self
Appends an item to signals_to_collect
.
To override the contents of this collection use set_signals_to_collect
.
Information about a list of signals to collect data on.
Sourcepub fn set_signals_to_collect(
self,
input: Option<Vec<SignalInformation>>,
) -> Self
pub fn set_signals_to_collect( self, input: Option<Vec<SignalInformation>>, ) -> Self
Information about a list of signals to collect data on.
Sourcepub fn get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>
pub fn get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>
Information about a list of signals to collect data on.
Sourcepub fn collection_scheme(self, input: CollectionScheme) -> Self
pub fn collection_scheme(self, input: CollectionScheme) -> Self
Information about the data collection scheme associated with the campaign.
Sourcepub fn set_collection_scheme(self, input: Option<CollectionScheme>) -> Self
pub fn set_collection_scheme(self, input: Option<CollectionScheme>) -> Self
Information about the data collection scheme associated with the campaign.
Sourcepub fn get_collection_scheme(&self) -> &Option<CollectionScheme>
pub fn get_collection_scheme(&self) -> &Option<CollectionScheme>
Information about the data collection scheme associated with the campaign.
Sourcepub fn data_extra_dimensions(self, input: impl Into<String>) -> Self
pub fn data_extra_dimensions(self, input: impl Into<String>) -> Self
Appends an item to data_extra_dimensions
.
To override the contents of this collection use set_data_extra_dimensions
.
A list of vehicle attributes associated with the campaign.
Sourcepub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self
pub fn set_data_extra_dimensions(self, input: Option<Vec<String>>) -> Self
A list of vehicle attributes associated with the campaign.
Sourcepub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>
pub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>
A list of vehicle attributes associated with the campaign.
Sourcepub fn creation_time(self, input: DateTime) -> Self
pub fn creation_time(self, input: DateTime) -> Self
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Sourcepub fn set_creation_time(self, input: Option<DateTime>) -> Self
pub fn set_creation_time(self, input: Option<DateTime>) -> Self
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Sourcepub fn get_creation_time(&self) -> &Option<DateTime>
pub fn get_creation_time(&self) -> &Option<DateTime>
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
Sourcepub fn last_modification_time(self, input: DateTime) -> Self
pub fn last_modification_time(self, input: DateTime) -> Self
The last time the campaign was modified.
Sourcepub fn set_last_modification_time(self, input: Option<DateTime>) -> Self
pub fn set_last_modification_time(self, input: Option<DateTime>) -> Self
The last time the campaign was modified.
Sourcepub fn get_last_modification_time(&self) -> &Option<DateTime>
pub fn get_last_modification_time(&self) -> &Option<DateTime>
The last time the campaign was modified.
Sourcepub fn data_destination_configs(self, input: DataDestinationConfig) -> Self
pub fn data_destination_configs(self, input: DataDestinationConfig) -> Self
Appends an item to data_destination_configs
.
To override the contents of this collection use set_data_destination_configs
.
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Sourcepub fn set_data_destination_configs(
self,
input: Option<Vec<DataDestinationConfig>>,
) -> Self
pub fn set_data_destination_configs( self, input: Option<Vec<DataDestinationConfig>>, ) -> Self
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Sourcepub fn get_data_destination_configs(
&self,
) -> &Option<Vec<DataDestinationConfig>>
pub fn get_data_destination_configs( &self, ) -> &Option<Vec<DataDestinationConfig>>
The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.
MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Sourcepub fn data_partitions(self, input: DataPartition) -> Self
pub fn data_partitions(self, input: DataPartition) -> Self
Appends an item to data_partitions
.
To override the contents of this collection use set_data_partitions
.
The data partitions associated with the signals collected from the vehicle.
Sourcepub fn set_data_partitions(self, input: Option<Vec<DataPartition>>) -> Self
pub fn set_data_partitions(self, input: Option<Vec<DataPartition>>) -> Self
The data partitions associated with the signals collected from the vehicle.
Sourcepub fn get_data_partitions(&self) -> &Option<Vec<DataPartition>>
pub fn get_data_partitions(&self) -> &Option<Vec<DataPartition>>
The data partitions associated with the signals collected from the vehicle.
Sourcepub fn signals_to_fetch(self, input: SignalFetchInformation) -> Self
pub fn signals_to_fetch(self, input: SignalFetchInformation) -> Self
Appends an item to signals_to_fetch
.
To override the contents of this collection use set_signals_to_fetch
.
Information about a list of signals to fetch data from.
Sourcepub fn set_signals_to_fetch(
self,
input: Option<Vec<SignalFetchInformation>>,
) -> Self
pub fn set_signals_to_fetch( self, input: Option<Vec<SignalFetchInformation>>, ) -> Self
Information about a list of signals to fetch data from.
Sourcepub fn get_signals_to_fetch(&self) -> &Option<Vec<SignalFetchInformation>>
pub fn get_signals_to_fetch(&self) -> &Option<Vec<SignalFetchInformation>>
Information about a list of signals to fetch data from.
Sourcepub fn build(self) -> GetCampaignOutput
pub fn build(self) -> GetCampaignOutput
Consumes the builder and constructs a GetCampaignOutput
.
Trait Implementations§
Source§impl Clone for GetCampaignOutputBuilder
impl Clone for GetCampaignOutputBuilder
Source§fn clone(&self) -> GetCampaignOutputBuilder
fn clone(&self) -> GetCampaignOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetCampaignOutputBuilder
impl Debug for GetCampaignOutputBuilder
Source§impl Default for GetCampaignOutputBuilder
impl Default for GetCampaignOutputBuilder
Source§fn default() -> GetCampaignOutputBuilder
fn default() -> GetCampaignOutputBuilder
Source§impl PartialEq for GetCampaignOutputBuilder
impl PartialEq for GetCampaignOutputBuilder
impl StructuralPartialEq for GetCampaignOutputBuilder
Auto Trait Implementations§
impl Freeze for GetCampaignOutputBuilder
impl RefUnwindSafe for GetCampaignOutputBuilder
impl Send for GetCampaignOutputBuilder
impl Sync for GetCampaignOutputBuilder
impl Unpin for GetCampaignOutputBuilder
impl UnwindSafe for GetCampaignOutputBuilder
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);