EndpointResponse (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.EndpointResponse

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EndpointResponse
extends Object
implements Serializable, Cloneable, StructuredPojo

Endpoint response

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EndpointResponse()

Constructors
Constructor and Description
`EndpointResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EndpointResponse`	`addAttributesEntry(String key, List<String> value)`
`EndpointResponse`	`addMetricsEntry(String key, Double value)`
`EndpointResponse`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`EndpointResponse`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`EndpointResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAddress()` The address or token of the endpoint as provided by your push provider (e.g.
`String`	`getApplicationId()` The ID of the application associated with the endpoint.
`Map<String,List<String>>`	`getAttributes()` Custom attributes that your app reports to Amazon Pinpoint.
`String`	`getChannelType()` The channel type.
`String`	`getCohortId()` A number from 0 - 99 that represents the cohort the endpoint is assigned to.
`String`	`getCreationDate()` The last time the endpoint was created.
`EndpointDemographic`	`getDemographic()` The endpoint demographic attributes.
`String`	`getEffectiveDate()` The last time the endpoint was updated.
`String`	`getEndpointStatus()` The endpoint status.
`String`	`getId()` The unique ID that you assigned to the endpoint.
`EndpointLocation`	`getLocation()` The endpoint location attributes.
`Map<String,Double>`	`getMetrics()` Custom metrics that your app reports to Amazon Pinpoint.
`String`	`getOptOut()` Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.
`String`	`getRequestId()` The unique ID for the most recent request to update the endpoint.
`EndpointUser`	`getUser()` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAddress(String address)` The address or token of the endpoint as provided by your push provider (e.g.
`void`	`setApplicationId(String applicationId)` The ID of the application associated with the endpoint.
`void`	`setAttributes(Map<String,List<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`void`	`setChannelType(ChannelType channelType)` The channel type.
`void`	`setChannelType(String channelType)` The channel type.
`void`	`setCohortId(String cohortId)` A number from 0 - 99 that represents the cohort the endpoint is assigned to.
`void`	`setCreationDate(String creationDate)` The last time the endpoint was created.
`void`	`setDemographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`void`	`setEffectiveDate(String effectiveDate)` The last time the endpoint was updated.
`void`	`setEndpointStatus(String endpointStatus)` The endpoint status.
`void`	`setId(String id)` The unique ID that you assigned to the endpoint.
`void`	`setLocation(EndpointLocation location)` The endpoint location attributes.
`void`	`setMetrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`void`	`setOptOut(String optOut)` Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.
`void`	`setRequestId(String requestId)` The unique ID for the most recent request to update the endpoint.
`void`	`setUser(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`EndpointResponse`	`withAddress(String address)` The address or token of the endpoint as provided by your push provider (e.g.
`EndpointResponse`	`withApplicationId(String applicationId)` The ID of the application associated with the endpoint.
`EndpointResponse`	`withAttributes(Map<String,List<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`EndpointResponse`	`withChannelType(ChannelType channelType)` The channel type.
`EndpointResponse`	`withChannelType(String channelType)` The channel type.
`EndpointResponse`	`withCohortId(String cohortId)` A number from 0 - 99 that represents the cohort the endpoint is assigned to.
`EndpointResponse`	`withCreationDate(String creationDate)` The last time the endpoint was created.
`EndpointResponse`	`withDemographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`EndpointResponse`	`withEffectiveDate(String effectiveDate)` The last time the endpoint was updated.
`EndpointResponse`	`withEndpointStatus(String endpointStatus)` The endpoint status.
`EndpointResponse`	`withId(String id)` The unique ID that you assigned to the endpoint.
`EndpointResponse`	`withLocation(EndpointLocation location)` The endpoint location attributes.
`EndpointResponse`	`withMetrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointResponse`	`withOptOut(String optOut)` Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages.
`EndpointResponse`	`withRequestId(String requestId)` The unique ID for the most recent request to update the endpoint.
`EndpointResponse`	`withUser(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointResponse
```
public EndpointResponse()
```
- Method Detail
  - setAddress
```
public void setAddress(String address)
```
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Parameters:
    
    address - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  - getAddress
```
public String getAddress()
```
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Returns:
    
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
  - withAddress
```
public EndpointResponse withAddress(String address)
```
    The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Parameters:
    
    address - The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The ID of the application associated with the endpoint.
    
    Parameters:
    
    applicationId - The ID of the application associated with the endpoint.
  - getApplicationId
```
public String getApplicationId()
```
    The ID of the application associated with the endpoint.
    
    Returns:
    
    The ID of the application associated with the endpoint.
  - withApplicationId
```
public EndpointResponse withApplicationId(String applicationId)
```
    The ID of the application associated with the endpoint.
    
    Parameters:
    
    applicationId - The ID of the application associated with the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributes
```
public Map<String,List<String>> getAttributes()
```
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Returns:
    
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
  - setAttributes
```
public void setAttributes(Map<String,List<String>> attributes)
```
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Parameters:
    
    attributes - Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
  - withAttributes
```
public EndpointResponse withAttributes(Map<String,List<String>> attributes)
```
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Parameters:
    
    attributes - Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public EndpointResponse addAttributesEntry(String key,
                                           List<String> value)
```
  - clearAttributesEntries
```
public EndpointResponse clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChannelType
```
public void setChannelType(String channelType)
```
    The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    See Also:
    
    ChannelType
  - getChannelType
```
public String getChannelType()
```
    The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Returns:
    
    The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointResponse withChannelType(String channelType)
```
    The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - setChannelType
```
public void setChannelType(ChannelType channelType)
```
    The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    See Also:
    
    ChannelType
  - withChannelType
```
public EndpointResponse withChannelType(ChannelType channelType)
```
    The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Parameters:
    
    channelType - The channel type. Valid values: GCM | APNS | SMS | EMAIL
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType
  - setCohortId
```
public void setCohortId(String cohortId)
```
    A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
    
    Parameters:
    
    cohortId - A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
  - getCohortId
```
public String getCohortId()
```
    A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
    
    Returns:
    
    A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
  - withCohortId
```
public EndpointResponse withCohortId(String cohortId)
```
    A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
    
    Parameters:
    
    cohortId - A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(String creationDate)
```
    The last time the endpoint was created. Provided in ISO 8601 format.
    
    Parameters:
    
    creationDate - The last time the endpoint was created. Provided in ISO 8601 format.
  - getCreationDate
```
public String getCreationDate()
```
    The last time the endpoint was created. Provided in ISO 8601 format.
    
    Returns:
    
    The last time the endpoint was created. Provided in ISO 8601 format.
  - withCreationDate
```
public EndpointResponse withCreationDate(String creationDate)
```
    The last time the endpoint was created. Provided in ISO 8601 format.
    
    Parameters:
    
    creationDate - The last time the endpoint was created. Provided in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDemographic
```
public void setDemographic(EndpointDemographic demographic)
```
    The endpoint demographic attributes.
    
    Parameters:
    
    demographic - The endpoint demographic attributes.
  - getDemographic
```
public EndpointDemographic getDemographic()
```
    The endpoint demographic attributes.
    
    Returns:
    
    The endpoint demographic attributes.
  - withDemographic
```
public EndpointResponse withDemographic(EndpointDemographic demographic)
```
    The endpoint demographic attributes.
    
    Parameters:
    
    demographic - The endpoint demographic attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEffectiveDate
```
public void setEffectiveDate(String effectiveDate)
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
  - getEffectiveDate
```
public String getEffectiveDate()
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Returns:
    
    The last time the endpoint was updated. Provided in ISO 8601 format.
  - withEffectiveDate
```
public EndpointResponse withEffectiveDate(String effectiveDate)
```
    The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The last time the endpoint was updated. Provided in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointStatus
```
public void setEndpointStatus(String endpointStatus)
```
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Parameters:
    
    endpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  - getEndpointStatus
```
public String getEndpointStatus()
```
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Returns:
    
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
  - withEndpointStatus
```
public EndpointResponse withEndpointStatus(String endpointStatus)
```
    The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Parameters:
    
    endpointStatus - The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
    
    Parameters:
    
    id - The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
  - getId
```
public String getId()
```
    The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
    
    Returns:
    
    The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
  - withId
```
public EndpointResponse withId(String id)
```
    The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
    
    Parameters:
    
    id - The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(EndpointLocation location)
```
    The endpoint location attributes.
    
    Parameters:
    
    location - The endpoint location attributes.
  - getLocation
```
public EndpointLocation getLocation()
```
    The endpoint location attributes.
    
    Returns:
    
    The endpoint location attributes.
  - withLocation
```
public EndpointResponse withLocation(EndpointLocation location)
```
    The endpoint location attributes.
    
    Parameters:
    
    location - The endpoint location attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetrics
```
public Map<String,Double> getMetrics()
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom metrics that your app reports to Amazon Pinpoint.
  - setMetrics
```
public void setMetrics(Map<String,Double> metrics)
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    metrics - Custom metrics that your app reports to Amazon Pinpoint.
  - withMetrics
```
public EndpointResponse withMetrics(Map<String,Double> metrics)
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    metrics - Custom metrics that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetricsEntry
```
public EndpointResponse addMetricsEntry(String key,
                                        Double value)
```
  - clearMetricsEntries
```
public EndpointResponse clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOptOut
```
public void setOptOut(String optOut)
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    
    Parameters:
    
    optOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  - getOptOut
```
public String getOptOut()
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    
    Returns:
    
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
  - withOptOut
```
public EndpointResponse withOptOut(String optOut)
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    
    Parameters:
    
    optOut - Indicates whether a user has opted out of receiving messages with one of the following values: ALL - User has opted out of all messages. NONE - Users has not opted out and receives all messages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestId
```
public void setRequestId(String requestId)
```
    The unique ID for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique ID for the most recent request to update the endpoint.
  - getRequestId
```
public String getRequestId()
```
    The unique ID for the most recent request to update the endpoint.
    
    Returns:
    
    The unique ID for the most recent request to update the endpoint.
  - withRequestId
```
public EndpointResponse withRequestId(String requestId)
```
    The unique ID for the most recent request to update the endpoint.
    
    Parameters:
    
    requestId - The unique ID for the most recent request to update the endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUser
```
public void setUser(EndpointUser user)
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    user - Custom user-specific attributes that your app reports to Amazon Pinpoint.
  - getUser
```
public EndpointUser getUser()
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
  - withUser
```
public EndpointResponse withUser(EndpointUser user)
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Parameters:
    
    user - Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EndpointResponse clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class EndpointResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointResponse

Method Detail

setAddress

getAddress

withAddress

setApplicationId

getApplicationId

withApplicationId

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setChannelType

getChannelType

withChannelType

setChannelType

withChannelType

setCohortId

getCohortId

withCohortId

setCreationDate

getCreationDate

withCreationDate

setDemographic

getDemographic

withDemographic

setEffectiveDate

getEffectiveDate

withEffectiveDate

setEndpointStatus

getEndpointStatus

withEndpointStatus

setId

getId

withId

setLocation

getLocation

withLocation

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

setOptOut

getOptOut

withOptOut

setRequestId

getRequestId

withRequestId

setUser

getUser

withUser

toString

equals

hashCode

clone

marshall