Struct aws_sdk_pinpoint::types::builders::EndpointRequestBuilder

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

A builder for EndpointRequest.

Implementations

impl EndpointRequestBuilder

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 a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

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 a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

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 a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

pub fn channel_type(self, input: ChannelType) -> Self

The channel to use when sending messages or push notifications to the endpoint.

pub fn set_channel_type(self, input: Option<ChannelType>) -> Self

The channel to use when sending messages or push notifications to the endpoint.

pub fn get_channel_type(&self) -> &Option<ChannelType>

The channel to use when sending messages or push notifications to the endpoint.

pub fn demographic(self, input: EndpointDemographic) -> Self

The demographic information for the endpoint, such as the time zone and platform.

pub fn set_demographic(self, input: Option<EndpointDemographic>) -> Self

The demographic information for the endpoint, such as the time zone and platform.

pub fn get_demographic(&self) -> &Option<EndpointDemographic>

The demographic information for the endpoint, such as the time zone and platform.

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

The date and time, in ISO 8601 format, when the endpoint is updated.

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

The date and time, in ISO 8601 format, when the endpoint is updated.

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

The date and time, in ISO 8601 format, when the endpoint is updated.

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

Specifies whether to send messages or push notifications to the endpoint. Valid 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.

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

Specifies whether to send messages or push notifications to the endpoint. Valid 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.

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

Specifies whether to send messages or push notifications to the endpoint. Valid 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.

pub fn location(self, input: EndpointLocation) -> Self

The geographic information for the endpoint.

pub fn set_location(self, input: Option<EndpointLocation>) -> Self

The geographic information for the endpoint.

pub fn get_location(&self) -> &Option<EndpointLocation>

The geographic information for the endpoint.

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.

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.

pub fn get_metrics(&self) -> &Option<HashMap<String, f64>>

One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

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.

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.

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.

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

The unique identifier for the most recent request to update the endpoint.

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

The unique identifier for the most recent request to update the endpoint.

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

The unique identifier for the most recent request to update the endpoint.

pub fn user(self, input: EndpointUser) -> Self

One or more custom attributes that describe the user who's associated with the endpoint.

pub fn set_user(self, input: Option<EndpointUser>) -> Self

One or more custom attributes that describe the user who's associated with the endpoint.

pub fn get_user(&self) -> &Option<EndpointUser>

One or more custom attributes that describe the user who's associated with the endpoint.

pub fn build(self) -> EndpointRequest

Consumes the builder and constructs a EndpointRequest.

Trait Implementations

impl Clone for EndpointRequestBuilder

fn clone(&self) -> EndpointRequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointRequestBuilder

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

Formats the value using the given formatter.

impl Default for EndpointRequestBuilder

fn default() -> EndpointRequestBuilder

Returns the “default value” for a type.

impl PartialEq for EndpointRequestBuilder

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