PublicEndpoint.Builder (AWS SDK for Java

All Superinterfaces:

Buildable, CopyableBuilder<PublicEndpoint.Builder,PublicEndpoint>, SdkBuilder<PublicEndpoint.Builder,PublicEndpoint>, SdkPojo

Enclosing class:

PublicEndpoint
```
public static interface PublicEndpoint.Builder
extends SdkPojo, CopyableBuilder<PublicEndpoint.Builder,PublicEndpoint>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`PublicEndpoint.Builder`	`address(String address)` The unique identifier for the recipient.
`PublicEndpoint.Builder`	`attributes(Map<String,? extends Collection<String>> attributes)` Custom attributes that your app reports to Amazon Pinpoint.
`PublicEndpoint.Builder`	`channelType(ChannelType channelType)` The channel type.
`PublicEndpoint.Builder`	`channelType(String channelType)` The channel type.
`default PublicEndpoint.Builder`	`demographic(Consumer<EndpointDemographic.Builder> demographic)` The endpoint demographic attributes.
`PublicEndpoint.Builder`	`demographic(EndpointDemographic demographic)` The endpoint demographic attributes.
`PublicEndpoint.Builder`	`effectiveDate(String effectiveDate)` The date and time when the endpoint was last updated, in ISO 8601 format.
`PublicEndpoint.Builder`	`endpointStatus(String endpointStatus)` The status of the endpoint.
`default PublicEndpoint.Builder`	`location(Consumer<EndpointLocation.Builder> location)` The endpoint location attributes.
`PublicEndpoint.Builder`	`location(EndpointLocation location)` The endpoint location attributes.
`PublicEndpoint.Builder`	`metrics(Map<String,Double> metrics)` Custom metrics that your app reports to Amazon Pinpoint.
`PublicEndpoint.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.
`PublicEndpoint.Builder`	`requestId(String requestId)` A unique identifier that is generated each time the endpoint is updated.
`default PublicEndpoint.Builder`	`user(Consumer<EndpointUser.Builder> user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.
`PublicEndpoint.Builder`	`user(EndpointUser user)` Custom user-specific attributes that your app reports to Amazon Pinpoint.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

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

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

- Method Detail
  - address
```
PublicEndpoint.Builder address(String address)
```
    The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    
    Parameters:
    
    address - The unique identifier for the recipient. For example, an address could be a device token, email address, or mobile phone number.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attributes
```
PublicEndpoint.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
```
PublicEndpoint.Builder channelType(String channelType)
```
    The channel type. Valid values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType, ChannelType
  - channelType
```
PublicEndpoint.Builder channelType(ChannelType channelType)
```
    The channel type. Valid values: APNS, GCM
    
    Parameters:
    
    channelType - The channel type. Valid values: APNS, GCM
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelType, ChannelType
  - demographic
```
PublicEndpoint.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 PublicEndpoint.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
```
PublicEndpoint.Builder effectiveDate(String effectiveDate)
```
    The date and time when the endpoint was last updated, in ISO 8601 format.
    
    Parameters:
    
    effectiveDate - The date and time when the endpoint was last updated, in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpointStatus
```
PublicEndpoint.Builder endpointStatus(String endpointStatus)
```
    The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    
    Parameters:
    
    endpointStatus - The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - location
```
PublicEndpoint.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 PublicEndpoint.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
```
PublicEndpoint.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
```
PublicEndpoint.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
```
PublicEndpoint.Builder requestId(String requestId)
```
    A unique identifier that is generated each time the endpoint is updated.
    
    Parameters:
    
    requestId - A unique identifier that is generated each time the endpoint is updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - user
```
PublicEndpoint.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 PublicEndpoint.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 PublicEndpoint.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

address

attributes

channelType

channelType

demographic

demographic

effectiveDate

endpointStatus

location

location

metrics

optOut

requestId

user

user