SegmentDimensions (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Specifies the dimension settings for a segment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SegmentDimensions()

Constructors
Constructor and Description
`SegmentDimensions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SegmentDimensions`	`addAttributesEntry(String key, AttributeDimension value)` Add a single Attributes entry
`SegmentDimensions`	`addMetricsEntry(String key, MetricDimension value)` Add a single Metrics entry
`SegmentDimensions`	`addUserAttributesEntry(String key, AttributeDimension value)` Add a single UserAttributes entry
`SegmentDimensions`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`SegmentDimensions`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`SegmentDimensions`	`clearUserAttributesEntries()` Removes all the entries added into UserAttributes.
`SegmentDimensions`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,AttributeDimension>`	`getAttributes()` One or more custom attributes to use as criteria for the segment.
`SegmentBehaviors`	`getBehavior()` The behavior-based criteria, such as how recently users have used your app, for the segment.
`SegmentDemographics`	`getDemographic()` The demographic-based criteria, such as device platform, for the segment.
`SegmentLocation`	`getLocation()` The location-based criteria, such as region or GPS coordinates, for the segment.
`Map<String,MetricDimension>`	`getMetrics()` One or more custom metrics to use as criteria for the segment.
`Map<String,AttributeDimension>`	`getUserAttributes()` One or more custom user attributes to use as criteria for the segment.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Map<String,AttributeDimension> attributes)` One or more custom attributes to use as criteria for the segment.
`void`	`setBehavior(SegmentBehaviors behavior)` The behavior-based criteria, such as how recently users have used your app, for the segment.
`void`	`setDemographic(SegmentDemographics demographic)` The demographic-based criteria, such as device platform, for the segment.
`void`	`setLocation(SegmentLocation location)` The location-based criteria, such as region or GPS coordinates, for the segment.
`void`	`setMetrics(Map<String,MetricDimension> metrics)` One or more custom metrics to use as criteria for the segment.
`void`	`setUserAttributes(Map<String,AttributeDimension> userAttributes)` One or more custom user attributes to use as criteria for the segment.
`String`	`toString()` Returns a string representation of this object.
`SegmentDimensions`	`withAttributes(Map<String,AttributeDimension> attributes)` One or more custom attributes to use as criteria for the segment.
`SegmentDimensions`	`withBehavior(SegmentBehaviors behavior)` The behavior-based criteria, such as how recently users have used your app, for the segment.
`SegmentDimensions`	`withDemographic(SegmentDemographics demographic)` The demographic-based criteria, such as device platform, for the segment.
`SegmentDimensions`	`withLocation(SegmentLocation location)` The location-based criteria, such as region or GPS coordinates, for the segment.
`SegmentDimensions`	`withMetrics(Map<String,MetricDimension> metrics)` One or more custom metrics to use as criteria for the segment.
`SegmentDimensions`	`withUserAttributes(Map<String,AttributeDimension> userAttributes)` One or more custom user attributes to use as criteria for the segment.

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

- Constructor Detail
  - SegmentDimensions
```
public SegmentDimensions()
```
- Method Detail
  - getAttributes
```
public Map<String,AttributeDimension> getAttributes()
```
    One or more custom attributes to use as criteria for the segment.
    
    Returns:
    
    One or more custom attributes to use as criteria for the segment.
  - setAttributes
```
public void setAttributes(Map<String,AttributeDimension> attributes)
```
    One or more custom attributes to use as criteria for the segment.
    
    Parameters:
    
    attributes - One or more custom attributes to use as criteria for the segment.
  - withAttributes
```
public SegmentDimensions withAttributes(Map<String,AttributeDimension> attributes)
```
    One or more custom attributes to use as criteria for the segment.
    
    Parameters:
    
    attributes - One or more custom attributes to use as criteria for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public SegmentDimensions addAttributesEntry(String key,
                                            AttributeDimension value)
```
    Add a single Attributes entry
    
    See Also:
    
    withAttributes(java.util.Map<java.lang.String, com.amazonaws.services.pinpoint.model.AttributeDimension>)
  - clearAttributesEntries
```
public SegmentDimensions clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBehavior
```
public void setBehavior(SegmentBehaviors behavior)
```
    The behavior-based criteria, such as how recently users have used your app, for the segment.
    
    Parameters:
    
    behavior - The behavior-based criteria, such as how recently users have used your app, for the segment.
  - getBehavior
```
public SegmentBehaviors getBehavior()
```
    The behavior-based criteria, such as how recently users have used your app, for the segment.
    
    Returns:
    
    The behavior-based criteria, such as how recently users have used your app, for the segment.
  - withBehavior
```
public SegmentDimensions withBehavior(SegmentBehaviors behavior)
```
    The behavior-based criteria, such as how recently users have used your app, for the segment.
    
    Parameters:
    
    behavior - The behavior-based criteria, such as how recently users have used your app, for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDemographic
```
public void setDemographic(SegmentDemographics demographic)
```
    The demographic-based criteria, such as device platform, for the segment.
    
    Parameters:
    
    demographic - The demographic-based criteria, such as device platform, for the segment.
  - getDemographic
```
public SegmentDemographics getDemographic()
```
    The demographic-based criteria, such as device platform, for the segment.
    
    Returns:
    
    The demographic-based criteria, such as device platform, for the segment.
  - withDemographic
```
public SegmentDimensions withDemographic(SegmentDemographics demographic)
```
    The demographic-based criteria, such as device platform, for the segment.
    
    Parameters:
    
    demographic - The demographic-based criteria, such as device platform, for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(SegmentLocation location)
```
    The location-based criteria, such as region or GPS coordinates, for the segment.
    
    Parameters:
    
    location - The location-based criteria, such as region or GPS coordinates, for the segment.
  - getLocation
```
public SegmentLocation getLocation()
```
    The location-based criteria, such as region or GPS coordinates, for the segment.
    
    Returns:
    
    The location-based criteria, such as region or GPS coordinates, for the segment.
  - withLocation
```
public SegmentDimensions withLocation(SegmentLocation location)
```
    The location-based criteria, such as region or GPS coordinates, for the segment.
    
    Parameters:
    
    location - The location-based criteria, such as region or GPS coordinates, for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetrics
```
public Map<String,MetricDimension> getMetrics()
```
    One or more custom metrics to use as criteria for the segment.
    
    Returns:
    
    One or more custom metrics to use as criteria for the segment.
  - setMetrics
```
public void setMetrics(Map<String,MetricDimension> metrics)
```
    One or more custom metrics to use as criteria for the segment.
    
    Parameters:
    
    metrics - One or more custom metrics to use as criteria for the segment.
  - withMetrics
```
public SegmentDimensions withMetrics(Map<String,MetricDimension> metrics)
```
    One or more custom metrics to use as criteria for the segment.
    
    Parameters:
    
    metrics - One or more custom metrics to use as criteria for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetricsEntry
```
public SegmentDimensions addMetricsEntry(String key,
                                         MetricDimension value)
```
    Add a single Metrics entry
    
    See Also:
    
    withMetrics(java.util.Map<java.lang.String, com.amazonaws.services.pinpoint.model.MetricDimension>)
  - clearMetricsEntries
```
public SegmentDimensions clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserAttributes
```
public Map<String,AttributeDimension> getUserAttributes()
```
    One or more custom user attributes to use as criteria for the segment.
    
    Returns:
    
    One or more custom user attributes to use as criteria for the segment.
  - setUserAttributes
```
public void setUserAttributes(Map<String,AttributeDimension> userAttributes)
```
    One or more custom user attributes to use as criteria for the segment.
    
    Parameters:
    
    userAttributes - One or more custom user attributes to use as criteria for the segment.
  - withUserAttributes
```
public SegmentDimensions withUserAttributes(Map<String,AttributeDimension> userAttributes)
```
    One or more custom user attributes to use as criteria for the segment.
    
    Parameters:
    
    userAttributes - One or more custom user attributes to use as criteria for the segment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUserAttributesEntry
```
public SegmentDimensions addUserAttributesEntry(String key,
                                                AttributeDimension value)
```
    Add a single UserAttributes entry
    
    See Also:
    
    withUserAttributes(java.util.Map<java.lang.String, com.amazonaws.services.pinpoint.model.AttributeDimension>)
  - clearUserAttributesEntries
```
public SegmentDimensions clearUserAttributesEntries()
```
    Removes all the entries added into UserAttributes.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 SegmentDimensions 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.

AWS SDK for Java 1.x API Reference - 1.12.779

Class SegmentDimensions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SegmentDimensions

Method Detail

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setBehavior

getBehavior

withBehavior

setDemographic

getDemographic

withDemographic

setLocation

getLocation

withLocation

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

getUserAttributes

setUserAttributes

withUserAttributes

addUserAttributesEntry

clearUserAttributesEntries

toString

equals

hashCode

clone

marshall