1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct UpdateCampaignOutput {
/// <p> The Amazon Resource Name (ARN) of the campaign. </p>
pub arn: ::std::option::Option<::std::string::String>,
/// <p>The name of the updated campaign.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The state of a campaign. The status can be one of:</p>
/// <ul>
/// <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign. </p> </li>
/// <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> 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. </p> </li>
/// <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li>
/// <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li>
/// </ul>
pub status: ::std::option::Option<crate::types::CampaignStatus>,
_request_id: Option<String>,
}
impl UpdateCampaignOutput {
/// <p> The Amazon Resource Name (ARN) of the campaign. </p>
pub fn arn(&self) -> ::std::option::Option<&str> {
self.arn.as_deref()
}
/// <p>The name of the updated campaign.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The state of a campaign. The status can be one of:</p>
/// <ul>
/// <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign. </p> </li>
/// <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> 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. </p> </li>
/// <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li>
/// <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li>
/// </ul>
pub fn status(&self) -> ::std::option::Option<&crate::types::CampaignStatus> {
self.status.as_ref()
}
}
impl ::aws_types::request_id::RequestId for UpdateCampaignOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl UpdateCampaignOutput {
/// Creates a new builder-style object to manufacture [`UpdateCampaignOutput`](crate::operation::update_campaign::UpdateCampaignOutput).
pub fn builder() -> crate::operation::update_campaign::builders::UpdateCampaignOutputBuilder {
crate::operation::update_campaign::builders::UpdateCampaignOutputBuilder::default()
}
}
/// A builder for [`UpdateCampaignOutput`](crate::operation::update_campaign::UpdateCampaignOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateCampaignOutputBuilder {
pub(crate) arn: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) status: ::std::option::Option<crate::types::CampaignStatus>,
_request_id: Option<String>,
}
impl UpdateCampaignOutputBuilder {
/// <p> The Amazon Resource Name (ARN) of the campaign. </p>
pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.arn = ::std::option::Option::Some(input.into());
self
}
/// <p> The Amazon Resource Name (ARN) of the campaign. </p>
pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.arn = input;
self
}
/// <p> The Amazon Resource Name (ARN) of the campaign. </p>
pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.arn
}
/// <p>The name of the updated campaign.</p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the updated campaign.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the updated campaign.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The state of a campaign. The status can be one of:</p>
/// <ul>
/// <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign. </p> </li>
/// <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> 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. </p> </li>
/// <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li>
/// <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li>
/// </ul>
pub fn status(mut self, input: crate::types::CampaignStatus) -> Self {
self.status = ::std::option::Option::Some(input);
self
}
/// <p>The state of a campaign. The status can be one of:</p>
/// <ul>
/// <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign. </p> </li>
/// <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> 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. </p> </li>
/// <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li>
/// <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li>
/// </ul>
pub fn set_status(mut self, input: ::std::option::Option<crate::types::CampaignStatus>) -> Self {
self.status = input;
self
}
/// <p>The state of a campaign. The status can be one of:</p>
/// <ul>
/// <li> <p> <code>CREATING</code> - Amazon Web Services IoT FleetWise is processing your request to create the campaign. </p> </li>
/// <li> <p> <code>WAITING_FOR_APPROVAL</code> - After a campaign is created, it enters the <code>WAITING_FOR_APPROVAL</code> 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. </p> </li>
/// <li> <p> <code>RUNNING</code> - The campaign is active. </p> </li>
/// <li> <p> <code>SUSPENDED</code> - The campaign is suspended. To resume the campaign, use the API operation. </p> </li>
/// </ul>
pub fn get_status(&self) -> &::std::option::Option<crate::types::CampaignStatus> {
&self.status
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`UpdateCampaignOutput`](crate::operation::update_campaign::UpdateCampaignOutput).
pub fn build(self) -> crate::operation::update_campaign::UpdateCampaignOutput {
crate::operation::update_campaign::UpdateCampaignOutput {
arn: self.arn,
name: self.name,
status: self.status,
_request_id: self._request_id,
}
}
}