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>

Define how a segment based on recency of use.

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 length of time during which users have been active or inactive with your app.
String	durationAsString() The length of time during which users have been active or inactive with your app.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RecencyType	recencyType() The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment.
String	recencyTypeAsString() The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment.
List<SdkField<?>>	sdkFields()
static Class<? extends RecencyDimension.Builder>	serializableBuilderClass()
RecencyDimension.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

duration

public Duration duration()

The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

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 length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

See Also:

Duration

durationAsString

public String durationAsString()

The length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

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 length of time during which users have been active or inactive with your app. Valid values: HR_24, DAY_7, DAY_14, DAY_30

See Also:

Duration

recencyType

public RecencyType recencyType()

The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app 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 recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.

See Also:

RecencyType

recencyTypeAsString

public String recencyTypeAsString()

The recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app 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 recency dimension type: ACTIVE - Users who have used your app within the specified duration are included in the segment. INACTIVE - Users who have not used your app within the specified duration are included in the segment.

See Also:

RecencyType

toBuilder

public RecencyDimension.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RecencyDimension.Builder,RecencyDimension>

Returns:

a builder for type T

builder

public static RecencyDimension.Builder builder()

serializableBuilderClass

public static Class<? extends RecencyDimension.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.