Struct aws_sdk_pinpoint::model::PublicEndpoint

#[non_exhaustive]
pub struct PublicEndpoint {
    pub address: Option<String>,
    pub attributes: Option<HashMap<String, Vec<String>>>,
    pub channel_type: Option<ChannelType>,
    pub demographic: Option<EndpointDemographic>,
    pub effective_date: Option<String>,
    pub endpoint_status: Option<String>,
    pub location: Option<EndpointLocation>,
    pub metrics: Option<HashMap<String, f64>>,
    pub opt_out: Option<String>,
    pub request_id: Option<String>,
    pub user: Option<EndpointUser>,
}

Specifies the properties and attributes of an endpoint that's associated with an event.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: Option<String>

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

attributes: Option<HashMap<String, Vec<String>>>

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.

channel_type: Option<ChannelType>

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

demographic: Option<EndpointDemographic>

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

effective_date: Option<String>

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

endpoint_status: 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.

location: Option<EndpointLocation>

The geographic information for the endpoint.

metrics: Option<HashMap<String, f64>>

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

opt_out: 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.

request_id: Option<String>

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

user: Option<EndpointUser>

One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

Implementations

impl PublicEndpoint

pub fn address(&self) -> Option<&str>

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

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

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

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

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

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

pub fn effective_date(&self) -> Option<&str>

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

pub fn endpoint_status(&self) -> Option<&str>

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) -> Option<&EndpointLocation>

The geographic information for the endpoint.

pub fn 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) -> Option<&str>

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) -> Option<&str>

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

pub fn 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.

impl PublicEndpoint

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PublicEndpoint

Trait Implementations

impl Clone for PublicEndpoint

fn clone(&self) -> PublicEndpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PublicEndpoint

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

Formats the value using the given formatter.

impl PartialEq<PublicEndpoint> for PublicEndpoint

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

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

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

This method tests for !=.

impl StructuralPartialEq for PublicEndpoint