EndpointResponse.Builder (AWS SDK for Java

All Superinterfaces:

CopyableBuilder<EndpointResponse.Builder,EndpointResponse>, SdkBuilder<EndpointResponse.Builder,EndpointResponse>

Enclosing class:

EndpointResponse
```
public static interface EndpointResponse.Builder
extends CopyableBuilder<EndpointResponse.Builder,EndpointResponse>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`EndpointResponse.Builder`	`address(String address)` The address or token of the endpoint as provided by your push provider (e.g.
`EndpointResponse.Builder`	`applicationId(String applicationId)` The ID of the application associated with the endpoint.
`EndpointResponse.Builder`	`attributes(Map<String,? extends Collection<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`EndpointResponse.Builder`	`channelType(ChannelType channelType)` The channel type.
`EndpointResponse.Builder`	`channelType(String channelType)` The channel type.
`EndpointResponse.Builder`	`cohortId(String cohortId)` A number from 0 - 99 that represents the cohort the endpoint is assigned to.
`EndpointResponse.Builder`	`creationDate(String creationDate)` The last time the endpoint was created.
`default EndpointResponse.Builder`	`demographic(Consumer<EndpointDemographic.Builder> demographic)` The endpoint demographic attributes.
`EndpointResponse.Builder`	`demographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`EndpointResponse.Builder`	`effectiveDate(String effectiveDate)` The last time the endpoint was updated.
`EndpointResponse.Builder`	`endpointStatus(String endpointStatus)` The endpoint status.
`EndpointResponse.Builder`	`id(String id)` The unique ID that you assigned to the endpoint.
`default EndpointResponse.Builder`	`location(Consumer<EndpointLocation.Builder> location)` The endpoint location attributes.
`EndpointResponse.Builder`	`location(EndpointLocation location)` The endpoint location attributes.
`EndpointResponse.Builder`	`metrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`EndpointResponse.Builder`	`optOut(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.Builder`	`requestId(String requestId)` The unique ID for the most recent request to update the endpoint.
`default EndpointResponse.Builder`	`user(Consumer<EndpointUser.Builder> user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`EndpointResponse.Builder`	`user(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
apply, build

- Method Detail
  - address
```
EndpointResponse.Builder address(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.
  - applicationId
```
EndpointResponse.Builder applicationId(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.
  - attributes
```
EndpointResponse.Builder attributes(Map<String,? extends Collection<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.
  - channelType
```
EndpointResponse.Builder channelType(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, ChannelType
  - channelType
```
EndpointResponse.Builder channelType(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, ChannelType
  - cohortId
```
EndpointResponse.Builder cohortId(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.
  - creationDate
```
EndpointResponse.Builder creationDate(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.
  - demographic
```
EndpointResponse.Builder demographic(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.
  - demographic
```
default EndpointResponse.Builder demographic(Consumer<EndpointDemographic.Builder> demographic)
```
    The endpoint demographic attributes. This is a convenience that creates an instance of the EndpointDemographic.Builder avoiding the need to create one manually via EndpointDemographic.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to demographic(EndpointDemographic).
    
    Parameters:
    
    demographic - a consumer that will call methods on EndpointDemographic.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    demographic(EndpointDemographic)
  - effectiveDate
```
EndpointResponse.Builder effectiveDate(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.
  - endpointStatus
```
EndpointResponse.Builder endpointStatus(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.
  - id
```
EndpointResponse.Builder id(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.
  - location
```
EndpointResponse.Builder location(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.
  - location
```
default EndpointResponse.Builder location(Consumer<EndpointLocation.Builder> location)
```
    The endpoint location attributes. This is a convenience that creates an instance of the EndpointLocation.Builder avoiding the need to create one manually via EndpointLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(EndpointLocation).
    
    Parameters:
    
    location - a consumer that will call methods on EndpointLocation.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    location(EndpointLocation)
  - metrics
```
EndpointResponse.Builder metrics(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.
  - optOut
```
EndpointResponse.Builder optOut(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.
  - requestId
```
EndpointResponse.Builder requestId(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.
  - user
```
EndpointResponse.Builder user(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.
  - user
```
default EndpointResponse.Builder user(Consumer<EndpointUser.Builder> user)
```
    Custom user-specific attributes that your app reports to Amazon Pinpoint. This is a convenience that creates an instance of the EndpointUser.Builder avoiding the need to create one manually via EndpointUser.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to user(EndpointUser).
    
    Parameters:
    
    user - a consumer that will call methods on EndpointUser.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    user(EndpointUser)

Interface EndpointResponse.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

address

applicationId

attributes

channelType

channelType

cohortId

creationDate

demographic

demographic

effectiveDate

endpointStatus

id

location

location

metrics

optOut

requestId

user

user