EndpointResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.pinpoint.model.EndpointResponse

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<EndpointResponse.Builder,EndpointResponse>

@Generated("software.amazon.awssdk:codegen")
public class EndpointResponse
extends Object
implements StructuredPojo, ToCopyableBuilder<EndpointResponse.Builder,EndpointResponse>

Endpoint response

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface EndpointResponse.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`EndpointResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`address()`	The address or token of the endpoint as provided by your push provider (e.g.
`String`	`applicationId()`	The ID of the application associated with the endpoint.
`Map<String,List<String>>`	`attributes()`	Custom attributes that your app reports to Amazon Pinpoint.
`static EndpointResponse.Builder`	`builder()`
`String`	`channelType()`	The channel type.
`String`	`cohortId()`	A number from 0 - 99 that represents the cohort the endpoint is assigned to.
`String`	`creationDate()`	The last time the endpoint was created.
`EndpointDemographic`	`demographic()`	The endpoint demographic attributes.
`String`	`effectiveDate()`	The last time the endpoint was updated.
`String`	`endpointStatus()`	The endpoint status.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`id()`	The unique ID that you assigned to the endpoint.
`EndpointLocation`	`location()`	The endpoint location attributes.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`Map<String,Double>`	`metrics()`	Custom metrics that your app reports to Amazon Pinpoint.
`String`	`optOut()`	Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages.
`String`	`requestId()`	The unique ID for the most recent request to update the endpoint.
`static Class<? extends EndpointResponse.Builder>`	`serializableBuilderClass()`
`String`	`shardId()`	The ShardId of endpoint
`EndpointResponse.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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

- Method Detail
  - address
```
public String address()
```
    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).
  - applicationId
```
public String applicationId()
```
    The ID of the application associated with the endpoint.
    
    Returns:
    
    The ID of the application associated with the endpoint.
  - attributes
```
public 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.
    
    Returns:
    
    Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment.
  - channelType
```
public String channelType()
```
    The channel type. Valid values: APNS, GCM
    
    Returns:
    
    The channel type. Valid values: APNS, GCM
    
    See Also:
    
    ChannelType
  - cohortId
```
public 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.
    
    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.
  - creationDate
```
public String creationDate()
```
    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.
  - demographic
```
public EndpointDemographic demographic()
```
    The endpoint demographic attributes.
    
    Returns:
    
    The endpoint demographic attributes.
  - effectiveDate
```
public String effectiveDate()
```
    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.
  - endpointStatus
```
public 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.
    
    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.
  - id
```
public 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.
    
    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.
  - location
```
public EndpointLocation location()
```
    The endpoint location attributes.
    
    Returns:
    
    The endpoint location attributes.
  - metrics
```
public Map<String,Double> metrics()
```
    Custom metrics that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom metrics that your app reports to Amazon Pinpoint.
  - optOut
```
public String optOut()
```
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
    
    Returns:
    
    Indicates whether a user has opted out of receiving messages with one of the following values: ALL – User receives all messages. NONE – User receives no messages.
  - requestId
```
public String requestId()
```
    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.
  - user
```
public EndpointUser user()
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
    
    Returns:
    
    Custom user-specific attributes that your app reports to Amazon Pinpoint.
  - shardId
```
public String shardId()
```
    The ShardId of endpoint
    
    Returns:
    
    The ShardId of endpoint
  - toBuilder
```
public EndpointResponse.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EndpointResponse.Builder,EndpointResponse>
    
    Returns:
    
    a builder for type T
  - builder
```
public static EndpointResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EndpointResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class EndpointResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

address

applicationId

attributes

channelType

cohortId

creationDate

demographic

effectiveDate

endpointStatus

id

location

metrics

optOut

requestId

user

shardId

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall