Struct aws_sdk_iotfleetwise::types::builders::CampaignSummaryBuilder

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

A builder for CampaignSummary.

Implementations

impl CampaignSummaryBuilder

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

The Amazon Resource Name (ARN) of a campaign.

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

The Amazon Resource Name (ARN) of a campaign.

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

The Amazon Resource Name (ARN) of a campaign.

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

The name of a campaign.

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

The name of a campaign.

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

The name of a 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 the signal catalog associated with the campaign.

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

The ARN of the signal catalog associated with the campaign.

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

The ARN of the signal catalog associated with the campaign.

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

The ARN of a vehicle or fleet to which the campaign is deployed.

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

The ARN of a vehicle or fleet to which the campaign is deployed.

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

The ARN of a vehicle or fleet to which the campaign is deployed.

pub fn status(self, input: CampaignStatus) -> Self

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

pub fn set_status(self, input: Option<CampaignStatus>) -> Self

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

pub fn get_status(&self) -> &Option<CampaignStatus>

The state of a campaign. The status can be one of the following:

• CREATING - Amazon Web Services IoT FleetWise is processing your request to create the campaign.

• WAITING_FOR_APPROVAL - After a campaign is created, it enters the WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.

• RUNNING - The campaign is active.

• SUSPENDED - The campaign is suspended. To resume the campaign, use the API operation.

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

The time the campaign was created.

This field is required.

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

The time the campaign was created.

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

The time the campaign was created.

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

The last time the campaign was modified.

This field is required.

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 build(self) -> Result<CampaignSummary, BuildError>

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

• creation_time
• last_modification_time

Trait Implementations

impl Clone for CampaignSummaryBuilder

fn clone(&self) -> CampaignSummaryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignSummaryBuilder

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

Formats the value using the given formatter.

impl Default for CampaignSummaryBuilder

fn default() -> CampaignSummaryBuilder

Returns the “default value” for a type.

impl PartialEq for CampaignSummaryBuilder

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