EndpointProfile (AWS SDK for Android - Amazon Pinpoint 2.12.7 API)

java.lang.Object
- com.amazonaws.mobileconnectors.pinpoint.targeting.endpointProfile.EndpointProfile

All Implemented Interfaces:

com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable
```
public class EndpointProfile
extends Object
implements com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable
```
Represents the device endpoint for which your application may add information to The example below demonstrates how to add custom attributes

Constructor Summary

Constructors
Constructor and Description

EndpointProfile(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)
Constructor.

Constructors
Constructor and Description
`EndpointProfile(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(String name, List<String> values)` Adds a custom attribute to this `EndpointProfile` with the specified key.
`void`	`addMetric(String name, Double value)` Adds a metric to this `EndpointProfile` with the specified key.
`String`	`getAddress()` Returns the Address of the endpoint.
`Map<String,List<String>>`	`getAllAttributes()` Returns a map of all custom attributes contained within this `EndpointProfile`
`Map<String,Double>`	`getAllMetrics()` Returns a map of all metrics contained within this `EndpointProfile`
`String`	`getApplicationId()` Returns the Mobile Analytics application Id
`List<String>`	`getAttribute(String name)` Returns the array of values of the custom attribute with the specified name.
`String`	`getChannelType()` Returns the Channel Type of this endpoint, currently defaults to GCM
`EndpointProfileDemographic`	`getDemographic()` Returns the Demographic facet of the endpoint.
`long`	`getEffectiveDate()` Returns the effective date of the endpoint.
`String`	`getEndpointId()` Returns the EndpointProfile Identifier of the device
`EndpointProfileLocation`	`getLocation()` Returns the Location facet of the endpoint.
`Double`	`getMetric(String name)` Returns the value of the metric with the specified name.
`String`	`getOptOut()` Returns weather the endpoint is opted out of notification.
`EndpointProfileUser`	`getUser()` Returns the User facet of the endpoint.
`boolean`	`hasAttribute(String attributeName)` Determines if this `EndpointProfile` contains a specific custom attribute
`boolean`	`hasMetric(String metricName)` Determines if this `EndpointProfile` contains a specific metric.
`void`	`setDemographic(EndpointProfileDemographic demographic)` Sets the Demographic facet of the endpoint.
`void`	`setEffectiveDate(long effectiveDate)` Sets the effectiveDate of the endpoint.
`void`	`setLocation(EndpointProfileLocation location)` Sets the Location facet of the endpoint.
`void`	`setUser(EndpointProfileUser user)` Sets the User facet of the endpoint.
`org.json.JSONObject`	`toJSONObject()`
`String`	`toString()`
`EndpointProfile`	`withAttribute(String name, List<String> values)` Adds a custom attribute to this `EndpointProfile` with the specified key.
`EndpointProfile`	`withMetric(String name, Double value)` Adds a metric to this `EndpointProfile` with the specified key.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EndpointProfile
```
public EndpointProfile(com.amazonaws.mobileconnectors.pinpoint.internal.core.PinpointContext pinpointContext)
```
    Constructor.
    
    Parameters:
    
    pinpointContext - the pinpoint context.
- Method Detail
  - getApplicationId
```
public String getApplicationId()
```
    Returns the Mobile Analytics application Id
    
    Returns:
    
    the application id
  - getEndpointId
```
public String getEndpointId()
```
    Returns the EndpointProfile Identifier of the device
    
    Returns:
    
    the endpoint id
  - getChannelType
```
public String getChannelType()
```
    Returns the Channel Type of this endpoint, currently defaults to GCM
    
    Returns:
    
    the channel type
  - getAddress
```
public String getAddress()
```
    Returns the Address of the endpoint. The token that is returned by the channel selected.
    
    Returns:
    
    the address
  - getDemographic
```
public EndpointProfileDemographic getDemographic()
```
    Returns the Demographic facet of the endpoint.
    
    Returns:
    
    EndpointProfileDemographic
  - setDemographic
```
public void setDemographic(EndpointProfileDemographic demographic)
```
    Sets the Demographic facet of the endpoint.
    
    Parameters:
    
    demographic - The demographic facet.
  - getLocation
```
public EndpointProfileLocation getLocation()
```
    Returns the Location facet of the endpoint.
    
    Returns:
    
    EndpointProfileLocation
  - setLocation
```
public void setLocation(EndpointProfileLocation location)
```
    Sets the Location facet of the endpoint.
    
    Parameters:
    
    location - The location facet.
  - getEffectiveDate
```
public long getEffectiveDate()
```
    Returns the effective date of the endpoint.
    
    Returns:
    
    long
  - setEffectiveDate
```
public void setEffectiveDate(long effectiveDate)
```
    Sets the effectiveDate of the endpoint.
    
    Parameters:
    
    effectiveDate - The demographic facet.
  - getOptOut
```
public String getOptOut()
```
    Returns weather the endpoint is opted out of notification.
    
    Returns:
    
    String (ALL | NONE)
  - addAttribute
```
public void addAttribute(String name,
                         List<String> values)
```
    Adds a custom attribute to this EndpointProfile with the specified key. Only 20 custom attributes/metrics are allowed to be added to a EndpointProfile. If 20 attributes already exist on this EndpointProfile, the call may be ignored.
    
    Parameters:
    
    name - The name of the custom attribute. The name will be truncated if it exceeds 50 characters.
    
    values - An array of values of the custom attribute. The values will be truncated if it exceeds 100 characters.
  - hasAttribute
```
public boolean hasAttribute(String attributeName)
```
    Determines if this EndpointProfile contains a specific custom attribute
    
    Parameters:
    
    attributeName - The name of the custom attribute
    
    Returns:
    
    true if this EndpointProfile has a custom attribute with the specified name, false otherwise
  - getAttribute
```
public List<String> getAttribute(String name)
```
    Returns the array of values of the custom attribute with the specified name.
    
    Parameters:
    
    name - The name of the custom attribute to return
    
    Returns:
    
    The array of custom attributes with the specified name, or null if attribute does not exist
  - withAttribute
```
public EndpointProfile withAttribute(String name,
                                     List<String> values)
```
    Adds a custom attribute to this EndpointProfile with the specified key. Only 20 custom attributes are allowed to be added to an EndpointProfile. If 20 custom attributes/metrics already exist on this EndpointProfile, the call may be ignored.
    
    Parameters:
    
    name - The name of the custom attribute. The name will be truncated if it exceeds 50 characters.
    
    values - An array of values of the custom attribute. The values will be truncated if it exceeds 100 characters.
    
    Returns:
    
    The same EndpointProfile instance is returned to allow for method chaining.
  - getAllAttributes
```
public Map<String,List<String>> getAllAttributes()
```
    Returns a map of all custom attributes contained within this EndpointProfile
    
    Returns:
    
    a map of all custom attributes, where the attribute names are the keys and the attribute values are the values
  - addMetric
```
public void addMetric(String name,
                      Double value)
```
    Adds a metric to this EndpointProfile with the specified key. Only 20 attributes/metrics are allowed to be added to an Event. If 20 attribute/metrics already exist on this Event, the call may be ignored.
    
    Parameters:
    
    name - The name of the metric. The name will be truncated if it exceeds 50 characters.
    
    value - The value of the metric.
  - hasMetric
```
public boolean hasMetric(String metricName)
```
    Determines if this EndpointProfile contains a specific metric.
    
    Parameters:
    
    metricName - The name of the metric
    
    Returns:
    
    true if this EndpointProfile has a metric with the specified name, false otherwise
  - getMetric
```
public Double getMetric(String name)
```
    Returns the value of the metric with the specified name.
    
    Parameters:
    
    name - The name of the metric to return
    
    Returns:
    
    The metric with the specified name, or null if metric does not exist
  - withMetric
```
public EndpointProfile withMetric(String name,
                                  Double value)
```
    Adds a metric to this EndpointProfile with the specified key. Only 20 attributes/metrics are allowed to be added to an EndpointProfile. If 20 attribute/metrics already exist on this EndpointProfile, the call may be ignored.
    
    Parameters:
    
    name - The name of the metric. The name will be truncated if it exceeds 50 characters.
    
    value - The value of the metric.
    
    Returns:
    
    The same EndpointProfile instance is returned to allow for method chaining.
  - getAllMetrics
```
public Map<String,Double> getAllMetrics()
```
    Returns a map of all metrics contained within this EndpointProfile
    
    Returns:
    
    a map of all metrics, where the metric names are the keys and the metric values are the values
  - getUser
```
public EndpointProfileUser getUser()
```
    Returns the User facet of the endpoint.
    
    Returns:
    
    EndpointProfileUser
  - setUser
```
public void setUser(EndpointProfileUser user)
```
    Sets the User facet of the endpoint.
    
    Parameters:
    
    user - The user facet
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJSONObject
```
public org.json.JSONObject toJSONObject()
```
    Specified by:
    
    toJSONObject in interface com.amazonaws.mobileconnectors.pinpoint.internal.core.util.JSONSerializable

Class EndpointProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EndpointProfile

Method Detail

getApplicationId

getEndpointId

getChannelType

getAddress

getDemographic

setDemographic

getLocation

setLocation

getEffectiveDate

setEffectiveDate

getOptOut

addAttribute

hasAttribute

getAttribute

withAttribute

getAllAttributes

addMetric

hasMetric

getMetric

withMetric

getAllMetrics

getUser

setUser

toString

toJSONObject