#[non_exhaustive]pub struct CampaignResponseBuilder { /* private fields */ }Expand description
A builder for CampaignResponse.
Implementations§
Source§impl CampaignResponseBuilder
impl CampaignResponseBuilder
Sourcepub fn additional_treatments(self, input: TreatmentResource) -> Self
pub fn additional_treatments(self, input: TreatmentResource) -> Self
Appends an item to additional_treatments.
To override the contents of this collection use set_additional_treatments.
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
Sourcepub fn set_additional_treatments(
self,
input: Option<Vec<TreatmentResource>>,
) -> Self
pub fn set_additional_treatments( self, input: Option<Vec<TreatmentResource>>, ) -> Self
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
Sourcepub fn get_additional_treatments(&self) -> &Option<Vec<TreatmentResource>>
pub fn get_additional_treatments(&self) -> &Option<Vec<TreatmentResource>>
An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
Sourcepub fn application_id(self, input: impl Into<String>) -> Self
pub fn application_id(self, input: impl Into<String>) -> Self
The unique identifier for the application that the campaign applies to.
This field is required.Sourcepub fn set_application_id(self, input: Option<String>) -> Self
pub fn set_application_id(self, input: Option<String>) -> Self
The unique identifier for the application that the campaign applies to.
Sourcepub fn get_application_id(&self) -> &Option<String>
pub fn get_application_id(&self) -> &Option<String>
The unique identifier for the application that the campaign applies to.
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.
This field is required.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 creation_date(self, input: impl Into<String>) -> Self
pub fn creation_date(self, input: impl Into<String>) -> Self
The date, in ISO 8601 format, when the campaign was created.
This field is required.Sourcepub fn set_creation_date(self, input: Option<String>) -> Self
pub fn set_creation_date(self, input: Option<String>) -> Self
The date, in ISO 8601 format, when the campaign was created.
Sourcepub fn get_creation_date(&self) -> &Option<String>
pub fn get_creation_date(&self) -> &Option<String>
The date, in ISO 8601 format, when the campaign was created.
Sourcepub fn custom_delivery_configuration(
self,
input: CustomDeliveryConfiguration,
) -> Self
pub fn custom_delivery_configuration( self, input: CustomDeliveryConfiguration, ) -> Self
The delivery configuration settings for sending the campaign through a custom channel.
Sourcepub fn set_custom_delivery_configuration(
self,
input: Option<CustomDeliveryConfiguration>,
) -> Self
pub fn set_custom_delivery_configuration( self, input: Option<CustomDeliveryConfiguration>, ) -> Self
The delivery configuration settings for sending the campaign through a custom channel.
Sourcepub fn get_custom_delivery_configuration(
&self,
) -> &Option<CustomDeliveryConfiguration>
pub fn get_custom_delivery_configuration( &self, ) -> &Option<CustomDeliveryConfiguration>
The delivery configuration settings for sending the campaign through a custom channel.
Sourcepub fn default_state(self, input: CampaignState) -> Self
pub fn default_state(self, input: CampaignState) -> Self
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
Sourcepub fn set_default_state(self, input: Option<CampaignState>) -> Self
pub fn set_default_state(self, input: Option<CampaignState>) -> Self
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
Sourcepub fn get_default_state(&self) -> &Option<CampaignState>
pub fn get_default_state(&self) -> &Option<CampaignState>
The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The custom description of the campaign.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The custom description of the campaign.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The custom description of the campaign.
Sourcepub fn holdout_percent(self, input: i32) -> Self
pub fn holdout_percent(self, input: i32) -> Self
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Sourcepub fn set_holdout_percent(self, input: Option<i32>) -> Self
pub fn set_holdout_percent(self, input: Option<i32>) -> Self
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Sourcepub fn get_holdout_percent(&self) -> &Option<i32>
pub fn get_holdout_percent(&self) -> &Option<i32>
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
Sourcepub fn hook(self, input: CampaignHook) -> Self
pub fn hook(self, input: CampaignHook) -> Self
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
Sourcepub fn set_hook(self, input: Option<CampaignHook>) -> Self
pub fn set_hook(self, input: Option<CampaignHook>) -> Self
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
Sourcepub fn get_hook(&self) -> &Option<CampaignHook>
pub fn get_hook(&self) -> &Option<CampaignHook>
The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The unique identifier for the campaign.
This field is required.Sourcepub fn is_paused(self, input: bool) -> Self
pub fn is_paused(self, input: bool) -> Self
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
Sourcepub fn set_is_paused(self, input: Option<bool>) -> Self
pub fn set_is_paused(self, input: Option<bool>) -> Self
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
Sourcepub fn get_is_paused(&self) -> &Option<bool>
pub fn get_is_paused(&self) -> &Option<bool>
Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
Sourcepub fn last_modified_date(self, input: impl Into<String>) -> Self
pub fn last_modified_date(self, input: impl Into<String>) -> Self
The date, in ISO 8601 format, when the campaign was last modified.
This field is required.Sourcepub fn set_last_modified_date(self, input: Option<String>) -> Self
pub fn set_last_modified_date(self, input: Option<String>) -> Self
The date, in ISO 8601 format, when the campaign was last modified.
Sourcepub fn get_last_modified_date(&self) -> &Option<String>
pub fn get_last_modified_date(&self) -> &Option<String>
The date, in ISO 8601 format, when the campaign was last modified.
Sourcepub fn limits(self, input: CampaignLimits) -> Self
pub fn limits(self, input: CampaignLimits) -> Self
The messaging limits for the campaign.
Sourcepub fn set_limits(self, input: Option<CampaignLimits>) -> Self
pub fn set_limits(self, input: Option<CampaignLimits>) -> Self
The messaging limits for the campaign.
Sourcepub fn get_limits(&self) -> &Option<CampaignLimits>
pub fn get_limits(&self) -> &Option<CampaignLimits>
The messaging limits for the campaign.
Sourcepub fn message_configuration(self, input: MessageConfiguration) -> Self
pub fn message_configuration(self, input: MessageConfiguration) -> Self
The message configuration settings for the campaign.
Sourcepub fn set_message_configuration(
self,
input: Option<MessageConfiguration>,
) -> Self
pub fn set_message_configuration( self, input: Option<MessageConfiguration>, ) -> Self
The message configuration settings for the campaign.
Sourcepub fn get_message_configuration(&self) -> &Option<MessageConfiguration>
pub fn get_message_configuration(&self) -> &Option<MessageConfiguration>
The message configuration settings for the campaign.
Sourcepub fn set_schedule(self, input: Option<Schedule>) -> Self
pub fn set_schedule(self, input: Option<Schedule>) -> Self
The schedule settings for the campaign.
Sourcepub fn get_schedule(&self) -> &Option<Schedule>
pub fn get_schedule(&self) -> &Option<Schedule>
The schedule settings for the campaign.
Sourcepub fn segment_id(self, input: impl Into<String>) -> Self
pub fn segment_id(self, input: impl Into<String>) -> Self
The unique identifier for the segment that's associated with the campaign.
This field is required.Sourcepub fn set_segment_id(self, input: Option<String>) -> Self
pub fn set_segment_id(self, input: Option<String>) -> Self
The unique identifier for the segment that's associated with the campaign.
Sourcepub fn get_segment_id(&self) -> &Option<String>
pub fn get_segment_id(&self) -> &Option<String>
The unique identifier for the segment that's associated with the campaign.
Sourcepub fn segment_version(self, input: i32) -> Self
pub fn segment_version(self, input: i32) -> Self
The version number of the segment that's associated with the campaign.
This field is required.Sourcepub fn set_segment_version(self, input: Option<i32>) -> Self
pub fn set_segment_version(self, input: Option<i32>) -> Self
The version number of the segment that's associated with the campaign.
Sourcepub fn get_segment_version(&self) -> &Option<i32>
pub fn get_segment_version(&self) -> &Option<i32>
The version number of the segment that's associated with the campaign.
Sourcepub fn state(self, input: CampaignState) -> Self
pub fn state(self, input: CampaignState) -> Self
The current status of the campaign.
Sourcepub fn set_state(self, input: Option<CampaignState>) -> Self
pub fn set_state(self, input: Option<CampaignState>) -> Self
The current status of the campaign.
Sourcepub fn get_state(&self) -> &Option<CampaignState>
pub fn get_state(&self) -> &Option<CampaignState>
The current status of the campaign.
Adds a key-value pair to tags.
To override the contents of this collection use set_tags.
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
Sourcepub fn template_configuration(self, input: TemplateConfiguration) -> Self
pub fn template_configuration(self, input: TemplateConfiguration) -> Self
The message template that’s used for the campaign.
Sourcepub fn set_template_configuration(
self,
input: Option<TemplateConfiguration>,
) -> Self
pub fn set_template_configuration( self, input: Option<TemplateConfiguration>, ) -> Self
The message template that’s used for the campaign.
Sourcepub fn get_template_configuration(&self) -> &Option<TemplateConfiguration>
pub fn get_template_configuration(&self) -> &Option<TemplateConfiguration>
The message template that’s used for the campaign.
Sourcepub fn treatment_description(self, input: impl Into<String>) -> Self
pub fn treatment_description(self, input: impl Into<String>) -> Self
The custom description of the default treatment for the campaign.
Sourcepub fn set_treatment_description(self, input: Option<String>) -> Self
pub fn set_treatment_description(self, input: Option<String>) -> Self
The custom description of the default treatment for the campaign.
Sourcepub fn get_treatment_description(&self) -> &Option<String>
pub fn get_treatment_description(&self) -> &Option<String>
The custom description of the default treatment for the campaign.
Sourcepub fn treatment_name(self, input: impl Into<String>) -> Self
pub fn treatment_name(self, input: impl Into<String>) -> Self
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Sourcepub fn set_treatment_name(self, input: Option<String>) -> Self
pub fn set_treatment_name(self, input: Option<String>) -> Self
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Sourcepub fn get_treatment_name(&self) -> &Option<String>
pub fn get_treatment_name(&self) -> &Option<String>
The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
Sourcepub fn set_version(self, input: Option<i32>) -> Self
pub fn set_version(self, input: Option<i32>) -> Self
The version number of the campaign.
Sourcepub fn get_version(&self) -> &Option<i32>
pub fn get_version(&self) -> &Option<i32>
The version number of the campaign.
Sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.
Sourcepub fn build(self) -> CampaignResponse
pub fn build(self) -> CampaignResponse
Consumes the builder and constructs a CampaignResponse.
Trait Implementations§
Source§impl Clone for CampaignResponseBuilder
impl Clone for CampaignResponseBuilder
Source§fn clone(&self) -> CampaignResponseBuilder
fn clone(&self) -> CampaignResponseBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CampaignResponseBuilder
impl Debug for CampaignResponseBuilder
Source§impl Default for CampaignResponseBuilder
impl Default for CampaignResponseBuilder
Source§fn default() -> CampaignResponseBuilder
fn default() -> CampaignResponseBuilder
Source§impl PartialEq for CampaignResponseBuilder
impl PartialEq for CampaignResponseBuilder
impl StructuralPartialEq for CampaignResponseBuilder
Auto Trait Implementations§
impl Freeze for CampaignResponseBuilder
impl RefUnwindSafe for CampaignResponseBuilder
impl Send for CampaignResponseBuilder
impl Sync for CampaignResponseBuilder
impl Unpin for CampaignResponseBuilder
impl UnwindSafe for CampaignResponseBuilder
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);