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

Interface EndpointResponse.Builder

    • Method Detail

      • address

        EndpointResponse.Builder address​(String address)

        The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is 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 example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • applicationId

        EndpointResponse.Builder applicationId​(String applicationId)

        The unique identifier for the application that's associated with the endpoint.

        Parameters:
        applicationId - The unique identifier for the application that's associated with the endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attributes

        EndpointResponse.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.

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

      • channelType

        EndpointResponse.Builder channelType​(String channelType)

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

        Parameters:
        channelType - The channel that's used 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

        EndpointResponse.Builder channelType​(ChannelType channelType)

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

        Parameters:
        channelType - The channel that's used 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

      • cohortId

        EndpointResponse.Builder cohortId​(String cohortId)

        A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

        Parameters:
        cohortId - A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        EndpointResponse.Builder creationDate​(String creationDate)

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

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

      • demographic

        EndpointResponse.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

        EndpointResponse.Builder effectiveDate​(String effectiveDate)

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

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

      • endpointStatus

        EndpointResponse.Builder endpointStatus​(String endpointStatus)

        Specifies whether messages or push notifications are sent to the endpoint. Possible 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 messages or push notifications are sent to the endpoint. Possible 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.

      • id

        EndpointResponse.Builder id​(String id)

        The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

        Parameters:
        id - The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • location

        EndpointResponse.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

        EndpointResponse.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

        EndpointResponse.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

        EndpointResponse.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

        EndpointResponse.Builder user​(EndpointUser user)

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

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