Package software.amazon.awssdk.services.pinpoint.model

Class AttributeDimension

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.AttributeDimension

All Implemented Interfaces:

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

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

Specifies attribute-based criteria for including or excluding endpoints from a segment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AttributeDimension.Builder

Method Summary

Modifier and Type	Method	Description
AttributeType	attributeType()	The type of segment dimension to use.
String	attributeTypeAsString()	The type of segment dimension to use.
static AttributeDimension.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
List<SdkField<?>>	sdkFields()
static Class<? extends AttributeDimension.Builder>	serializableBuilderClass()
AttributeDimension.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The criteria values to use for the segment dimension.

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

attributeType

public final AttributeType attributeType()

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

If the service returns an enum value that is not available in the current SDK version, attributeType will return AttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeTypeAsString().

Returns:

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

See Also:

AttributeType

attributeTypeAsString

public final String attributeTypeAsString()

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

If the service returns an enum value that is not available in the current SDK version, attributeType will return AttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeTypeAsString().

Returns:

The type of segment dimension to use. Valid values are:

• INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
• EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
• CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
• BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
• AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
• ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
• BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

See Also:

AttributeType

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values 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.

values

public final List<String> values()

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

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 hasValues() method.

Returns:

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

toBuilder

public AttributeDimension.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributeDimension.Builder,AttributeDimension>

builder

public static AttributeDimension.Builder builder()

serializableBuilderClass

public static Class<? extends AttributeDimension.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