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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SegmentDimensions.Builder,SegmentDimensions>

@Generated("software.amazon.awssdk:codegen")
public final class SegmentDimensions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SegmentDimensions.Builder,SegmentDimensions>

Specifies the dimension settings for a segment.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SegmentDimensions.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,AttributeDimension>`	`attributes()`	One or more custom attributes to use as criteria for the segment.
`SegmentBehaviors`	`behavior()`	The behavior-based criteria, such as how recently users have used your app, for the segment.
`static SegmentDimensions.Builder`	`builder()`
`SegmentDemographics`	`demographic()`	The demographic-based criteria, such as device platform, for the segment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAttributes()`	For responses, this returns true if the service returned a value for the Attributes property.
`int`	`hashCode()`
`boolean`	`hasMetrics()`	For responses, this returns true if the service returned a value for the Metrics property.
`boolean`	`hasUserAttributes()`	For responses, this returns true if the service returned a value for the UserAttributes property.
`SegmentLocation`	`location()`	The location-based criteria, such as region or GPS coordinates, for the segment.
`Map<String,MetricDimension>`	`metrics()`	One or more custom metrics to use as criteria for the segment.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SegmentDimensions.Builder>`	`serializableBuilderClass()`
`SegmentDimensions.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Map<String,AttributeDimension>`	`userAttributes()`	One or more custom user attributes to use as criteria for the segment.

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

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

- Method Detail
  - hasAttributes
```
public final boolean hasAttributes()
```
    For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - attributes
```
public final Map<String,AttributeDimension> attributes()
```
    One or more custom attributes to use as criteria for the segment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.
    
    Returns:
    
    One or more custom attributes to use as criteria for the segment.
  - behavior
```
public final SegmentBehaviors behavior()
```
    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.
  - demographic
```
public final SegmentDemographics demographic()
```
    The demographic-based criteria, such as device platform, for the segment.
    
    Returns:
    
    The demographic-based criteria, such as device platform, for the segment.
  - location
```
public final SegmentLocation location()
```
    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.
  - hasMetrics
```
public final boolean hasMetrics()
```
    For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - metrics
```
public final Map<String,MetricDimension> metrics()
```
    One or more custom metrics to use as criteria for the segment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.
    
    Returns:
    
    One or more custom metrics to use as criteria for the segment.
  - hasUserAttributes
```
public final boolean hasUserAttributes()
```
    For responses, this returns true if the service returned a value for the UserAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - userAttributes
```
public final Map<String,AttributeDimension> userAttributes()
```
    One or more custom user attributes to use as criteria for the segment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAttributes() method.
    
    Returns:
    
    One or more custom user attributes to use as criteria for the segment.
  - toBuilder
```
public SegmentDimensions.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SegmentDimensions.Builder,SegmentDimensions>
  - builder
```
public static SegmentDimensions.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SegmentDimensions.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SegmentDimensions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAttributes

attributes

behavior

demographic

location

hasMetrics

metrics

hasUserAttributes

userAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields