#[non_exhaustive]pub struct EndpointResponseBuilder { /* private fields */ }Expand description
A builder for EndpointResponse.
Implementations§
Source§impl EndpointResponseBuilder
impl EndpointResponseBuilder
Sourcepub fn address(self, input: impl Into<String>) -> Self
pub fn address(self, input: impl Into<String>) -> Self
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
Sourcepub fn set_address(self, input: Option<String>) -> Self
pub fn set_address(self, input: Option<String>) -> Self
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
Sourcepub fn get_address(&self) -> &Option<String>
pub fn get_address(&self) -> &Option<String>
The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
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's associated with the endpoint.
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's associated with the endpoint.
Sourcepub fn get_application_id(&self) -> &Option<String>
pub fn get_application_id(&self) -> &Option<String>
The unique identifier for the application that's associated with the endpoint.
Sourcepub fn attributes(self, k: impl Into<String>, v: Vec<String>) -> Self
pub fn attributes(self, k: impl Into<String>, v: Vec<String>) -> Self
Adds a key-value pair to attributes.
To override the contents of this collection use set_attributes.
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: \["Science", "Music", "Travel"\]. You can use these attributes as filter criteria when you create segments.
Sourcepub fn set_attributes(self, input: Option<HashMap<String, Vec<String>>>) -> Self
pub fn set_attributes(self, input: Option<HashMap<String, Vec<String>>>) -> Self
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: \["Science", "Music", "Travel"\]. You can use these attributes as filter criteria when you create segments.
Sourcepub fn get_attributes(&self) -> &Option<HashMap<String, Vec<String>>>
pub fn get_attributes(&self) -> &Option<HashMap<String, Vec<String>>>
One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: \["Science", "Music", "Travel"\]. You can use these attributes as filter criteria when you create segments.
Sourcepub fn channel_type(self, input: ChannelType) -> Self
pub fn channel_type(self, input: ChannelType) -> Self
The channel that's used when sending messages or push notifications to the endpoint.
Sourcepub fn set_channel_type(self, input: Option<ChannelType>) -> Self
pub fn set_channel_type(self, input: Option<ChannelType>) -> Self
The channel that's used when sending messages or push notifications to the endpoint.
Sourcepub fn get_channel_type(&self) -> &Option<ChannelType>
pub fn get_channel_type(&self) -> &Option<ChannelType>
The channel that's used when sending messages or push notifications to the endpoint.
Sourcepub fn cohort_id(self, input: impl Into<String>) -> Self
pub fn cohort_id(self, input: impl Into<String>) -> Self
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
Sourcepub fn set_cohort_id(self, input: Option<String>) -> Self
pub fn set_cohort_id(self, input: Option<String>) -> Self
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
Sourcepub fn get_cohort_id(&self) -> &Option<String>
pub fn get_cohort_id(&self) -> &Option<String>
A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
Sourcepub fn creation_date(self, input: impl Into<String>) -> Self
pub fn creation_date(self, input: impl Into<String>) -> Self
The date and time, in ISO 8601 format, when the endpoint was created.
Sourcepub fn set_creation_date(self, input: Option<String>) -> Self
pub fn set_creation_date(self, input: Option<String>) -> Self
The date and time, in ISO 8601 format, when the endpoint was created.
Sourcepub fn get_creation_date(&self) -> &Option<String>
pub fn get_creation_date(&self) -> &Option<String>
The date and time, in ISO 8601 format, when the endpoint was created.
Sourcepub fn demographic(self, input: EndpointDemographic) -> Self
pub fn demographic(self, input: EndpointDemographic) -> Self
The demographic information for the endpoint, such as the time zone and platform.
Sourcepub fn set_demographic(self, input: Option<EndpointDemographic>) -> Self
pub fn set_demographic(self, input: Option<EndpointDemographic>) -> Self
The demographic information for the endpoint, such as the time zone and platform.
Sourcepub fn get_demographic(&self) -> &Option<EndpointDemographic>
pub fn get_demographic(&self) -> &Option<EndpointDemographic>
The demographic information for the endpoint, such as the time zone and platform.
Sourcepub fn effective_date(self, input: impl Into<String>) -> Self
pub fn effective_date(self, input: impl Into<String>) -> Self
The date and time, in ISO 8601 format, when the endpoint was last updated.
Sourcepub fn set_effective_date(self, input: Option<String>) -> Self
pub fn set_effective_date(self, input: Option<String>) -> Self
The date and time, in ISO 8601 format, when the endpoint was last updated.
Sourcepub fn get_effective_date(&self) -> &Option<String>
pub fn get_effective_date(&self) -> &Option<String>
The date and time, in ISO 8601 format, when the endpoint was last updated.
Sourcepub fn endpoint_status(self, input: impl Into<String>) -> Self
pub fn endpoint_status(self, input: impl Into<String>) -> Self
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Sourcepub fn set_endpoint_status(self, input: Option<String>) -> Self
pub fn set_endpoint_status(self, input: Option<String>) -> Self
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Sourcepub fn get_endpoint_status(&self) -> &Option<String>
pub fn get_endpoint_status(&self) -> &Option<String>
Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.
Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Sourcepub fn get_id(&self) -> &Option<String>
pub fn get_id(&self) -> &Option<String>
The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
Sourcepub fn location(self, input: EndpointLocation) -> Self
pub fn location(self, input: EndpointLocation) -> Self
The geographic information for the endpoint.
Sourcepub fn set_location(self, input: Option<EndpointLocation>) -> Self
pub fn set_location(self, input: Option<EndpointLocation>) -> Self
The geographic information for the endpoint.
Sourcepub fn get_location(&self) -> &Option<EndpointLocation>
pub fn get_location(&self) -> &Option<EndpointLocation>
The geographic information for the endpoint.
Sourcepub fn metrics(self, k: impl Into<String>, v: f64) -> Self
pub fn metrics(self, k: impl Into<String>, v: f64) -> Self
Adds a key-value pair to metrics.
To override the contents of this collection use set_metrics.
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Sourcepub fn set_metrics(self, input: Option<HashMap<String, f64>>) -> Self
pub fn set_metrics(self, input: Option<HashMap<String, f64>>) -> Self
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Sourcepub fn get_metrics(&self) -> &Option<HashMap<String, f64>>
pub fn get_metrics(&self) -> &Option<HashMap<String, f64>>
One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
Sourcepub fn opt_out(self, input: impl Into<String>) -> Self
pub fn opt_out(self, input: impl Into<String>) -> Self
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
Sourcepub fn set_opt_out(self, input: Option<String>) -> Self
pub fn set_opt_out(self, input: Option<String>) -> Self
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
Sourcepub fn get_opt_out(&self) -> &Option<String>
pub fn get_opt_out(&self) -> &Option<String>
Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
Sourcepub fn request_id(self, input: impl Into<String>) -> Self
pub fn request_id(self, input: impl Into<String>) -> Self
The unique identifier for the most recent request to update the endpoint.
Sourcepub fn set_request_id(self, input: Option<String>) -> Self
pub fn set_request_id(self, input: Option<String>) -> Self
The unique identifier for the most recent request to update the endpoint.
Sourcepub fn get_request_id(&self) -> &Option<String>
pub fn get_request_id(&self) -> &Option<String>
The unique identifier for the most recent request to update the endpoint.
Sourcepub fn user(self, input: EndpointUser) -> Self
pub fn user(self, input: EndpointUser) -> Self
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
Sourcepub fn set_user(self, input: Option<EndpointUser>) -> Self
pub fn set_user(self, input: Option<EndpointUser>) -> Self
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
Sourcepub fn get_user(&self) -> &Option<EndpointUser>
pub fn get_user(&self) -> &Option<EndpointUser>
One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
Sourcepub fn build(self) -> EndpointResponse
pub fn build(self) -> EndpointResponse
Consumes the builder and constructs a EndpointResponse.
Trait Implementations§
Source§impl Clone for EndpointResponseBuilder
impl Clone for EndpointResponseBuilder
Source§fn clone(&self) -> EndpointResponseBuilder
fn clone(&self) -> EndpointResponseBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for EndpointResponseBuilder
impl Debug for EndpointResponseBuilder
Source§impl Default for EndpointResponseBuilder
impl Default for EndpointResponseBuilder
Source§fn default() -> EndpointResponseBuilder
fn default() -> EndpointResponseBuilder
Source§impl PartialEq for EndpointResponseBuilder
impl PartialEq for EndpointResponseBuilder
impl StructuralPartialEq for EndpointResponseBuilder
Auto Trait Implementations§
impl Freeze for EndpointResponseBuilder
impl RefUnwindSafe for EndpointResponseBuilder
impl Send for EndpointResponseBuilder
impl Sync for EndpointResponseBuilder
impl Unpin for EndpointResponseBuilder
impl UnwindSafe for EndpointResponseBuilder
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);