Package software.amazon.awssdk.services.pinpoint.model

Interface EndpointRequest.Builder

    • Method Detail

      • address

        EndpointRequest.Builder address​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attributes

        EndpointRequest.Builder attributes​(Map<String,​? extends Collection<String>> 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • channelType

        EndpointRequest.Builder channelType​(String channelType)

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

        Parameters:
        channelType - The channel to use when sending messages or push notifications to the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ChannelType, ChannelType

      • channelType

        EndpointRequest.Builder channelType​(ChannelType channelType)

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

        Parameters:
        channelType - The channel to use when sending messages or push notifications to the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ChannelType, ChannelType

      • demographic

        EndpointRequest.Builder demographic​(EndpointDemographic demographic)

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

        Parameters:
        demographic - The demographic information for the endpoint, such as the time zone and platform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • effectiveDate

        EndpointRequest.Builder effectiveDate​(String effectiveDate)

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

        Parameters:
        effectiveDate - The date and time, in ISO 8601 format, when the endpoint is updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endpointStatus

        EndpointRequest.Builder endpointStatus​(String 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • location

        EndpointRequest.Builder location​(EndpointLocation location)

        The geographic information for the endpoint.

        Parameters:
        location - The geographic information for the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metrics

        EndpointRequest.Builder metrics​(Map<String,​Double> metrics)

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

        Parameters:
        metrics - One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optOut

        EndpointRequest.Builder optOut​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requestId

        EndpointRequest.Builder requestId​(String requestId)

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

        Parameters:
        requestId - The unique identifier for the most recent request to update the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • user

        EndpointRequest.Builder user​(EndpointUser user)

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

        Parameters:
        user - One or more custom attributes that describe the user who's associated with the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.