Class AggregationFunction

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

An aggregation function aggregates values from a dimension or measure.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

  • Method Details

    • numericalAggregationFunction

      public final NumericalAggregationFunction numericalAggregationFunction()

      Aggregation for numerical values.

      Returns:
      Aggregation for numerical values.

    • categoricalAggregationFunction

      public final CategoricalAggregationFunction categoricalAggregationFunction()

      Aggregation for categorical values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

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

      Returns:
      Aggregation for categorical values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

      See Also:

    • categoricalAggregationFunctionAsString

      public final String categoricalAggregationFunctionAsString()

      Aggregation for categorical values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

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

      Returns:
      Aggregation for categorical values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

      See Also:

    • dateAggregationFunction

      public final DateAggregationFunction dateAggregationFunction()

      Aggregation for date values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

      • MIN: Select the smallest date value.

      • MAX: Select the largest date value.

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

      Returns:
      Aggregation for date values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

      • MIN: Select the smallest date value.

      • MAX: Select the largest date value.

      See Also:

    • dateAggregationFunctionAsString

      public final String dateAggregationFunctionAsString()

      Aggregation for date values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

      • MIN: Select the smallest date value.

      • MAX: Select the largest date value.

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

      Returns:
      Aggregation for date values.

      • COUNT: Aggregate by the total number of values, including duplicates.

      • DISTINCT_COUNT: Aggregate by the total number of distinct values.

      • MIN: Select the smallest date value.

      • MAX: Select the largest date value.

      See Also:

    • attributeAggregationFunction

      public final AttributeAggregationFunction attributeAggregationFunction()

      Aggregation for attributes.

      Returns:
      Aggregation for attributes.

    • toBuilder

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

    • builder

      public static AggregationFunction.Builder builder()

    • serializableBuilderClass

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