software.amazon.awssdk.services.pinpoint.model

Class RecencyDimension

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.RecencyDimension

All Implemented Interfaces:

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

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

Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecencyDimension.Builder

Method Summary

Modifier and Type	Method and Description
static RecencyDimension.Builder	builder()
Duration	duration() The duration to use when determining whether an endpoint is active or inactive.
String	durationAsString() The duration to use when determining whether an endpoint is active or inactive.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RecencyType	recencyType() The type of recency dimension to use for the segment.
String	recencyTypeAsString() The type of recency dimension to use for the segment.
List<SdkField<?>>	sdkFields()
static Class<? extends RecencyDimension.Builder>	serializableBuilderClass()
RecencyDimension.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

duration

public final Duration duration()

The duration to use when determining whether an endpoint is active or inactive.

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

Returns:

The duration to use when determining whether an endpoint is active or inactive.

See Also:

Duration

durationAsString

public final String durationAsString()

The duration to use when determining whether an endpoint is active or inactive.

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

Returns:

The duration to use when determining whether an endpoint is active or inactive.

See Also:

Duration

recencyType

public final RecencyType recencyType()

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

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

Returns:

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

See Also:

RecencyType

recencyTypeAsString

public final String recencyTypeAsString()

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

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

Returns:

The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

See Also:

RecencyType

toBuilder

public RecencyDimension.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecencyDimension.Builder,RecencyDimension>

builder

public static RecencyDimension.Builder builder()

serializableBuilderClass

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