software.amazon.awssdk.services.pinpoint.model

Class SegmentDimensions

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SegmentDimensions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SegmentDimensions.Builder,SegmentDimensions>

@Generated(value="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 and Description
static interface	SegmentDimensions.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUserAttributes() Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 boolean hasAttributes()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public 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.

You can use hasAttributes() to see if a value was sent in this field.

Returns:

One or more custom attributes to use as criteria for the segment.

behavior

public 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 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 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 boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metrics

public 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.

You can use hasMetrics() to see if a value was sent in this field.

Returns:

One or more custom metrics to use as criteria for the segment.

hasUserAttributes

public boolean hasUserAttributes()

Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userAttributes

public 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.

You can use hasUserAttributes() to see if a value was sent in this field.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo