Class RecencyDimension

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.RecencyDimension
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RecencyDimension.Builder,RecencyDimension>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.