/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Pinpoint { namespace Model { /** *

Specifies an endpoint to create or update and the settings and attributes to * set or change for the endpoint.

See Also:

AWS * API Reference

*/ class EndpointBatchItem { public: AWS_PINPOINT_API EndpointBatchItem(); AWS_PINPOINT_API EndpointBatchItem(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API EndpointBatchItem& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_PINPOINT_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::String& GetAddress() const{ return m_address; } /** *

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.

*/ inline bool AddressHasBeenSet() const { return m_addressHasBeenSet; } /** *

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.

*/ inline void SetAddress(const Aws::String& value) { m_addressHasBeenSet = true; m_address = value; } /** *

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.

*/ inline void SetAddress(Aws::String&& value) { m_addressHasBeenSet = true; m_address = std::move(value); } /** *

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.

*/ inline void SetAddress(const char* value) { m_addressHasBeenSet = true; m_address.assign(value); } /** *

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.

*/ inline EndpointBatchItem& WithAddress(const Aws::String& value) { SetAddress(value); return *this;} /** *

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.

*/ inline EndpointBatchItem& WithAddress(Aws::String&& value) { SetAddress(std::move(value)); return *this;} /** *

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.

*/ inline EndpointBatchItem& 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. 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.

*/ inline const Aws::Map>& GetAttributes() const{ return m_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.

*/ 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. 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.

*/ inline void SetAttributes(const Aws::Map>& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

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.

*/ inline void SetAttributes(Aws::Map>&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

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.

*/ inline EndpointBatchItem& WithAttributes(const Aws::Map>& value) { SetAttributes(value); return *this;} /** *

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.

*/ inline EndpointBatchItem& WithAttributes(Aws::Map>&& value) { SetAttributes(std::move(value)); return *this;} /** *

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.

*/ inline EndpointBatchItem& AddAttributes(const Aws::String& key, const Aws::Vector& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

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.

*/ inline EndpointBatchItem& AddAttributes(Aws::String&& key, const Aws::Vector& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline EndpointBatchItem& AddAttributes(const Aws::String& key, Aws::Vector&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline EndpointBatchItem& AddAttributes(Aws::String&& key, Aws::Vector&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

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.

*/ inline EndpointBatchItem& AddAttributes(const char* key, Aws::Vector&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline EndpointBatchItem& AddAttributes(const char* key, const Aws::Vector& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

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

*/ inline const ChannelType& GetChannelType() const{ return m_channelType; } /** *

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

*/ inline bool ChannelTypeHasBeenSet() const { return m_channelTypeHasBeenSet; } /** *

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

*/ inline void SetChannelType(const ChannelType& value) { m_channelTypeHasBeenSet = true; m_channelType = value; } /** *

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

*/ inline void SetChannelType(ChannelType&& value) { m_channelTypeHasBeenSet = true; m_channelType = std::move(value); } /** *

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

*/ inline EndpointBatchItem& WithChannelType(const ChannelType& value) { SetChannelType(value); return *this;} /** *

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

*/ inline EndpointBatchItem& 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 EndpointBatchItem& WithDemographic(const EndpointDemographic& value) { SetDemographic(value); return *this;} /** *

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

*/ inline EndpointBatchItem& WithDemographic(EndpointDemographic&& value) { SetDemographic(std::move(value)); return *this;} /** *

The date and time, in ISO 8601 format, when the endpoint was created or * updated.

*/ inline const Aws::String& GetEffectiveDate() const{ return m_effectiveDate; } /** *

The date and time, in ISO 8601 format, when the endpoint was created or * updated.

*/ inline bool EffectiveDateHasBeenSet() const { return m_effectiveDateHasBeenSet; } /** *

The date and time, in ISO 8601 format, when the endpoint was created or * 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 created or * 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 created or * 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 created or * updated.

*/ inline EndpointBatchItem& WithEffectiveDate(const Aws::String& value) { SetEffectiveDate(value); return *this;} /** *

The date and time, in ISO 8601 format, when the endpoint was created or * updated.

*/ inline EndpointBatchItem& WithEffectiveDate(Aws::String&& value) { SetEffectiveDate(std::move(value)); return *this;} /** *

The date and time, in ISO 8601 format, when the endpoint was created or * updated.

*/ inline EndpointBatchItem& 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 EndpointBatchItem& 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 EndpointBatchItem& 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 EndpointBatchItem& WithEndpointStatus(const char* value) { SetEndpointStatus(value); return *this;} /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline EndpointBatchItem& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline EndpointBatchItem& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

The unique identifier for the endpoint in the context of the batch.

*/ inline EndpointBatchItem& WithId(const char* value) { SetId(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 EndpointBatchItem& WithLocation(const EndpointLocation& value) { SetLocation(value); return *this;} /** *

The geographic information for the endpoint.

*/ inline EndpointBatchItem& 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::Map& GetMetrics() const{ return m_metrics; } /** *

One 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::Map& value) { m_metricsHasBeenSet = true; m_metrics = value; } /** *

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

*/ inline void SetMetrics(Aws::Map&& value) { m_metricsHasBeenSet = true; m_metrics = std::move(value); } /** *

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

*/ inline EndpointBatchItem& WithMetrics(const Aws::Map& value) { SetMetrics(value); return *this;} /** *

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

*/ inline EndpointBatchItem& WithMetrics(Aws::Map&& value) { SetMetrics(std::move(value)); return *this;} /** *

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

*/ inline EndpointBatchItem& 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 EndpointBatchItem& 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 EndpointBatchItem& 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 EndpointBatchItem& 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 EndpointBatchItem& 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 EndpointBatchItem& WithOptOut(const char* value) { SetOptOut(value); return *this;} /** *

The unique identifier for the request to create or update the endpoint.

*/ inline const Aws::String& GetRequestId() const{ return m_requestId; } /** *

The unique identifier for the request to create or update the endpoint.

*/ inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; } /** *

The unique identifier for the request to create or update the endpoint.

*/ inline void SetRequestId(const Aws::String& value) { m_requestIdHasBeenSet = true; m_requestId = value; } /** *

The unique identifier for the request to create or update the endpoint.

*/ inline void SetRequestId(Aws::String&& value) { m_requestIdHasBeenSet = true; m_requestId = std::move(value); } /** *

The unique identifier for the request to create or update the endpoint.

*/ inline void SetRequestId(const char* value) { m_requestIdHasBeenSet = true; m_requestId.assign(value); } /** *

The unique identifier for the request to create or update the endpoint.

*/ inline EndpointBatchItem& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} /** *

The unique identifier for the request to create or update the endpoint.

*/ inline EndpointBatchItem& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} /** *

The unique identifier for the request to create or update the endpoint.

*/ inline EndpointBatchItem& WithRequestId(const char* value) { SetRequestId(value); return *this;} /** *

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

*/ inline const EndpointUser& GetUser() const{ return m_user; } /** *

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

*/ inline bool UserHasBeenSet() const { return m_userHasBeenSet; } /** *

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

*/ inline void SetUser(const EndpointUser& value) { m_userHasBeenSet = true; m_user = value; } /** *

One or more custom attributes that describe 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 attributes that describe the user who's associated with * the endpoint.

*/ inline EndpointBatchItem& WithUser(const EndpointUser& value) { SetUser(value); return *this;} /** *

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

*/ inline EndpointBatchItem& WithUser(EndpointUser&& value) { SetUser(std::move(value)); return *this;} private: Aws::String m_address; bool m_addressHasBeenSet = false; Aws::Map> m_attributes; bool m_attributesHasBeenSet = false; ChannelType m_channelType; bool m_channelTypeHasBeenSet = false; EndpointDemographic m_demographic; bool m_demographicHasBeenSet = false; Aws::String m_effectiveDate; bool m_effectiveDateHasBeenSet = false; Aws::String m_endpointStatus; bool m_endpointStatusHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; EndpointLocation m_location; bool m_locationHasBeenSet = false; Aws::Map m_metrics; bool m_metricsHasBeenSet = false; Aws::String m_optOut; bool m_optOutHasBeenSet = false; Aws::String m_requestId; bool m_requestIdHasBeenSet = false; EndpointUser m_user; bool m_userHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws