Struct aws_sdk_pinpoint::model::public_endpoint::Builder

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

A builder for PublicEndpoint

Implementations

impl Builder

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

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

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

The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

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. You can use these attributes as filter criteria when you create segments.

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. You can use these attributes as filter criteria when you create segments.

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

The channel that's used when sending messages or push notifications to the endpoint.

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

The channel that's used 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 effective_date(self, input: impl Into<String>) -> Self

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

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

The date and time, in ISO 8601 format, when the endpoint was last 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 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 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 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 request_id(self, input: impl Into<String>) -> Self

A unique identifier that's generated each time the endpoint is updated.

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

A unique identifier that's generated each time the endpoint is updated.

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.

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.

pub fn build(self) -> PublicEndpoint

Consumes the builder and constructs a PublicEndpoint

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder