Class AggregateOperation

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

A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values.

See Also:

  • Method Details

    • alias

      public final String alias()

      Alias for this operation.

      Returns:
      Alias for this operation.

    • source

      public final TransformOperationSource source()

      The source transform operation that provides input data for the aggregation.

      Returns:
      The source transform operation that provides input data for the aggregation.

    • hasGroupByColumnNames

      public final boolean hasGroupByColumnNames()
      For responses, this returns true if the service returned a value for the GroupByColumnNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • groupByColumnNames

      public final List<String> groupByColumnNames()

      The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupByColumnNames() method.

      Returns:
      The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together.

    • hasAggregations

      public final boolean hasAggregations()
      For responses, this returns true if the service returned a value for the Aggregations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • aggregations

      public final List<Aggregation> aggregations()

      The list of aggregation functions to apply to the grouped data, such as SUM, COUNT, or AVERAGE.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAggregations() method.

      Returns:
      The list of aggregation functions to apply to the grouped data, such as SUM, COUNT, or AVERAGE.

    • toBuilder

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

    • builder

      public static AggregateOperation.Builder builder()

    • serializableBuilderClass

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