Class Range

java.lang.Object
software.amazon.awssdk.services.customerprofiles.model.Range
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Range.Builder,Range>
@Generated("software.amazon.awssdk:codegen") public final class Range extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Range.Builder,Range>

The relative time period over which data is included in the aggregation.

See Also:

  • Method Details

    • value

      public final Integer value()

      The amount of time of the specified unit.

      Returns:
      The amount of time of the specified unit.

    • unit

      public final Unit unit()

      The unit of time.

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

      Returns:
      The unit of time.
      See Also:

    • unitAsString

      public final String unitAsString()

      The unit of time.

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

      Returns:
      The unit of time.
      See Also:

    • valueRange

      public final ValueRange valueRange()

      A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.

      Returns:
      A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute. Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.

    • timestampSource

      public final String timestampSource()

      An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \ "{ObjectTypeName.<Location of timestamp field in JSON pointer format>}\". E.g. if your object type is MyType and source JSON is {" generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}".

      Returns:
      An expression specifying the field in your JSON object from which the date should be parsed. The expression should follow the structure of \ "{ObjectTypeName.<Location of timestamp field in JSON pointer format>}\". E.g. if your object type is MyType and source JSON is {" generatedAt ": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}".

    • timestampFormat

      public final String timestampFormat()

      The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat should be "ISO_8601".

      Returns:
      The format the timestamp field in your JSON object is specified. This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat should be "ISO_8601".

    • toBuilder

      public Range.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<Range.Builder,Range>
      Returns:
      a builder for type T

    • builder

      public static Range.Builder builder()

    • serializableBuilderClass

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