/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Specifies the properties and attributes of an endpoint that's associated with
* an event.See Also:
AWS
* API Reference
The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline const Aws::String& GetAddress() const{ return m_address; } /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline bool AddressHasBeenSet() const { return m_addressHasBeenSet; } /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline void SetAddress(const Aws::String& value) { m_addressHasBeenSet = true; m_address = value; } /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline void SetAddress(Aws::String&& value) { m_addressHasBeenSet = true; m_address = std::move(value); } /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline void SetAddress(const char* value) { m_addressHasBeenSet = true; m_address.assign(value); } /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline PublicEndpoint& WithAddress(const Aws::String& value) { SetAddress(value); return *this;} /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline PublicEndpoint& WithAddress(Aws::String&& value) { SetAddress(std::move(value)); return *this;} /** *The unique identifier for the recipient, such as a device token, email * address, or mobile phone number.
*/ inline PublicEndpoint& WithAddress(const char* value) { SetAddress(value); return *this;} /** *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.
*/ inline const Aws::MapOne 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.
*/ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *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.
*/ inline void SetAttributes(const Aws::MapOne 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.
*/ inline void SetAttributes(Aws::MapOne 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.
*/ inline PublicEndpoint& WithAttributes(const Aws::MapOne 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.
*/ inline PublicEndpoint& WithAttributes(Aws::MapOne 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.
*/ inline PublicEndpoint& AddAttributes(const Aws::String& key, const Aws::VectorOne 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.
*/ inline PublicEndpoint& AddAttributes(Aws::String&& key, const Aws::VectorOne 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.
*/ inline PublicEndpoint& AddAttributes(const Aws::String& key, Aws::VectorOne 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.
*/ inline PublicEndpoint& AddAttributes(Aws::String&& key, Aws::VectorOne 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.
*/ inline PublicEndpoint& AddAttributes(const char* key, Aws::VectorOne 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.
*/ inline PublicEndpoint& AddAttributes(const char* key, const Aws::VectorThe channel that's used when sending messages or push notifications to the * endpoint.
*/ inline const ChannelType& GetChannelType() const{ return m_channelType; } /** *The channel that's used when sending messages or push notifications to the * endpoint.
*/ inline bool ChannelTypeHasBeenSet() const { return m_channelTypeHasBeenSet; } /** *The channel that's used when sending messages or push notifications to the * endpoint.
*/ inline void SetChannelType(const ChannelType& value) { m_channelTypeHasBeenSet = true; m_channelType = value; } /** *The channel that's used when sending messages or push notifications to the * endpoint.
*/ inline void SetChannelType(ChannelType&& value) { m_channelTypeHasBeenSet = true; m_channelType = std::move(value); } /** *The channel that's used when sending messages or push notifications to the * endpoint.
*/ inline PublicEndpoint& WithChannelType(const ChannelType& value) { SetChannelType(value); return *this;} /** *The channel that's used when sending messages or push notifications to the * endpoint.
*/ inline PublicEndpoint& WithChannelType(ChannelType&& value) { SetChannelType(std::move(value)); return *this;} /** *The demographic information for the endpoint, such as the time zone and * platform.
*/ inline const EndpointDemographic& GetDemographic() const{ return m_demographic; } /** *The demographic information for the endpoint, such as the time zone and * platform.
*/ inline bool DemographicHasBeenSet() const { return m_demographicHasBeenSet; } /** *The demographic information for the endpoint, such as the time zone and * platform.
*/ inline void SetDemographic(const EndpointDemographic& value) { m_demographicHasBeenSet = true; m_demographic = value; } /** *The demographic information for the endpoint, such as the time zone and * platform.
*/ inline void SetDemographic(EndpointDemographic&& value) { m_demographicHasBeenSet = true; m_demographic = std::move(value); } /** *The demographic information for the endpoint, such as the time zone and * platform.
*/ inline PublicEndpoint& WithDemographic(const EndpointDemographic& value) { SetDemographic(value); return *this;} /** *The demographic information for the endpoint, such as the time zone and * platform.
*/ inline PublicEndpoint& WithDemographic(EndpointDemographic&& value) { SetDemographic(std::move(value)); return *this;} /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline const Aws::String& GetEffectiveDate() const{ return m_effectiveDate; } /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline bool EffectiveDateHasBeenSet() const { return m_effectiveDateHasBeenSet; } /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline void SetEffectiveDate(const Aws::String& value) { m_effectiveDateHasBeenSet = true; m_effectiveDate = value; } /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline void SetEffectiveDate(Aws::String&& value) { m_effectiveDateHasBeenSet = true; m_effectiveDate = std::move(value); } /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline void SetEffectiveDate(const char* value) { m_effectiveDateHasBeenSet = true; m_effectiveDate.assign(value); } /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline PublicEndpoint& WithEffectiveDate(const Aws::String& value) { SetEffectiveDate(value); return *this;} /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline PublicEndpoint& WithEffectiveDate(Aws::String&& value) { SetEffectiveDate(std::move(value)); return *this;} /** *The date and time, in ISO 8601 format, when the endpoint was last * updated.
*/ inline PublicEndpoint& WithEffectiveDate(const char* value) { SetEffectiveDate(value); return *this;} /** *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.
*/ inline const Aws::String& GetEndpointStatus() const{ return m_endpointStatus; } /** *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.
*/ inline bool EndpointStatusHasBeenSet() const { return m_endpointStatusHasBeenSet; } /** *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.
*/ inline void SetEndpointStatus(const Aws::String& value) { m_endpointStatusHasBeenSet = true; m_endpointStatus = value; } /** *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.
*/ inline void SetEndpointStatus(Aws::String&& value) { m_endpointStatusHasBeenSet = true; m_endpointStatus = std::move(value); } /** *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.
*/ inline void SetEndpointStatus(const char* value) { m_endpointStatusHasBeenSet = true; m_endpointStatus.assign(value); } /** *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.
*/ inline PublicEndpoint& WithEndpointStatus(const Aws::String& value) { SetEndpointStatus(value); return *this;} /** *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.
*/ inline PublicEndpoint& WithEndpointStatus(Aws::String&& value) { SetEndpointStatus(std::move(value)); return *this;} /** *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.
*/ inline PublicEndpoint& WithEndpointStatus(const char* value) { SetEndpointStatus(value); return *this;} /** *The geographic information for the endpoint.
*/ inline const EndpointLocation& GetLocation() const{ return m_location; } /** *The geographic information for the endpoint.
*/ inline bool LocationHasBeenSet() const { return m_locationHasBeenSet; } /** *The geographic information for the endpoint.
*/ inline void SetLocation(const EndpointLocation& value) { m_locationHasBeenSet = true; m_location = value; } /** *The geographic information for the endpoint.
*/ inline void SetLocation(EndpointLocation&& value) { m_locationHasBeenSet = true; m_location = std::move(value); } /** *The geographic information for the endpoint.
*/ inline PublicEndpoint& WithLocation(const EndpointLocation& value) { SetLocation(value); return *this;} /** *The geographic information for the endpoint.
*/ inline PublicEndpoint& WithLocation(EndpointLocation&& value) { SetLocation(std::move(value)); return *this;} /** *One or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline const Aws::MapOne or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline bool MetricsHasBeenSet() const { return m_metricsHasBeenSet; } /** *One or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline void SetMetrics(const Aws::MapOne or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline void SetMetrics(Aws::MapOne or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline PublicEndpoint& WithMetrics(const Aws::MapOne or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline PublicEndpoint& WithMetrics(Aws::MapOne or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline PublicEndpoint& AddMetrics(const Aws::String& key, double value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } /** *One or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline PublicEndpoint& AddMetrics(Aws::String&& key, double value) { m_metricsHasBeenSet = true; m_metrics.emplace(std::move(key), value); return *this; } /** *One or more custom metrics that your app reports to Amazon Pinpoint for the * endpoint.
*/ inline PublicEndpoint& AddMetrics(const char* key, double value) { m_metricsHasBeenSet = true; m_metrics.emplace(key, value); return *this; } /** *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.
*/ inline const Aws::String& GetOptOut() const{ return m_optOut; } /** *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.
*/ inline bool OptOutHasBeenSet() const { return m_optOutHasBeenSet; } /** *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.
*/ inline void SetOptOut(const Aws::String& value) { m_optOutHasBeenSet = true; m_optOut = value; } /** *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.
*/ inline void SetOptOut(Aws::String&& value) { m_optOutHasBeenSet = true; m_optOut = std::move(value); } /** *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.
*/ inline void SetOptOut(const char* value) { m_optOutHasBeenSet = true; m_optOut.assign(value); } /** *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.
*/ inline PublicEndpoint& WithOptOut(const Aws::String& value) { SetOptOut(value); return *this;} /** *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.
*/ inline PublicEndpoint& WithOptOut(Aws::String&& value) { SetOptOut(std::move(value)); return *this;} /** *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.
*/ inline PublicEndpoint& WithOptOut(const char* value) { SetOptOut(value); return *this;} /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline const Aws::String& GetRequestId() const{ return m_requestId; } /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; } /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline void SetRequestId(const Aws::String& value) { m_requestIdHasBeenSet = true; m_requestId = value; } /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline void SetRequestId(Aws::String&& value) { m_requestIdHasBeenSet = true; m_requestId = std::move(value); } /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline void SetRequestId(const char* value) { m_requestIdHasBeenSet = true; m_requestId.assign(value); } /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline PublicEndpoint& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline PublicEndpoint& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} /** *A unique identifier that's generated each time the endpoint is updated.
*/ inline PublicEndpoint& WithRequestId(const char* value) { SetRequestId(value); return *this;} /** *One or more custom user attributes that your app reports to Amazon Pinpoint * for the user who's associated with the endpoint.
*/ inline const EndpointUser& GetUser() const{ return m_user; } /** *One or more custom user attributes that your app reports to Amazon Pinpoint * for the user who's associated with the endpoint.
*/ inline bool UserHasBeenSet() const { return m_userHasBeenSet; } /** *One or more custom user attributes that your app reports to Amazon Pinpoint * for the user who's associated with the endpoint.
*/ inline void SetUser(const EndpointUser& value) { m_userHasBeenSet = true; m_user = value; } /** *One or more custom user attributes that your app reports to Amazon Pinpoint * for the user who's associated with the endpoint.
*/ inline void SetUser(EndpointUser&& value) { m_userHasBeenSet = true; m_user = std::move(value); } /** *One or more custom user attributes that your app reports to Amazon Pinpoint * for the user who's associated with the endpoint.
*/ inline PublicEndpoint& WithUser(const EndpointUser& value) { SetUser(value); return *this;} /** *One or more custom user attributes that your app reports to Amazon Pinpoint * for the user who's associated with the endpoint.
*/ inline PublicEndpoint& WithUser(EndpointUser&& value) { SetUser(std::move(value)); return *this;} private: Aws::String m_address; bool m_addressHasBeenSet = false; Aws::Map