Struct aws_sdk_iotfleetwise::operation::get_campaign::builders::GetCampaignOutputBuilder

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

A builder for GetCampaignOutput.

Implementations

impl GetCampaignOutputBuilder

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

The name of the campaign.

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

The name of the campaign.

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

The name of the campaign.

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

The Amazon Resource Name (ARN) of the campaign.

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

The Amazon Resource Name (ARN) of the campaign.

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

The Amazon Resource Name (ARN) of the campaign.

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

The description of the campaign.

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

The description of the campaign.

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

The description of the campaign.

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

The ARN of a signal catalog.

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

The ARN of a signal catalog.

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

The ARN of a signal catalog.

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

The ARN of the vehicle or the fleet targeted by the campaign.

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

The ARN of the vehicle or the fleet targeted by the campaign.

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

The ARN of the vehicle or the fleet targeted by the campaign.

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.

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.

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.

pub fn start_time(self, input: DateTime) -> Self

The time, in milliseconds, to deliver a campaign after it was approved.

pub fn set_start_time(self, input: Option<DateTime>) -> Self

The time, in milliseconds, to deliver a campaign after it was approved.

pub fn get_start_time(&self) -> &Option<DateTime>

The time, in milliseconds, to deliver a campaign after it was approved.

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.

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.

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.

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.

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.

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.

pub fn diagnostics_mode(self, input: DiagnosticsMode) -> Self

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

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.

pub fn get_diagnostics_mode(&self) -> &Option<DiagnosticsMode>

Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn set_signals_to_collect( self, input: Option<Vec<SignalInformation>> ) -> Self

Information about a list of signals to collect data on.

pub fn get_signals_to_collect(&self) -> &Option<Vec<SignalInformation>>

Information about a list of signals to collect data on.

pub fn collection_scheme(self, input: CollectionScheme) -> Self

Information about the data collection scheme associated with the campaign.

pub fn set_collection_scheme(self, input: Option<CollectionScheme>) -> Self

Information about the data collection scheme associated with the campaign.

pub fn get_collection_scheme(&self) -> &Option<CollectionScheme>

Information about the data collection scheme associated with the campaign.

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.

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

A list of vehicle attributes associated with the campaign.

pub fn get_data_extra_dimensions(&self) -> &Option<Vec<String>>

A list of vehicle attributes associated with the campaign.

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).

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).

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).

pub fn last_modification_time(self, input: DateTime) -> Self

The last time the campaign was modified.

pub fn set_last_modification_time(self, input: Option<DateTime>) -> Self

The last time the campaign was modified.

pub fn get_last_modification_time(&self) -> &Option<DateTime>

The last time the campaign was modified.

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 choose to send data to be stored in Amazon S3 or Amazon Timestream.

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.

pub fn set_data_destination_configs( self, input: Option<Vec<DataDestinationConfig>> ) -> Self

The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

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.

pub fn get_data_destination_configs( &self ) -> &Option<Vec<DataDestinationConfig>>

The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.

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.

pub fn build(self) -> GetCampaignOutput

Consumes the builder and constructs a GetCampaignOutput.

Trait Implementations

impl Clone for GetCampaignOutputBuilder

fn clone(&self) -> GetCampaignOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCampaignOutputBuilder

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

Formats the value using the given formatter.

impl Default for GetCampaignOutputBuilder

fn default() -> GetCampaignOutputBuilder

Returns the “default value” for a type.

impl PartialEq for GetCampaignOutputBuilder

fn eq(&self, other: &GetCampaignOutputBuilder) -> 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 GetCampaignOutputBuilder