Class TopBottomRankedComputation

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

The top ranked and bottom ranked computation configuration.

See Also:

  • Method Details

    • computationId

      public final String computationId()

      The ID for a computation.

      Returns:
      The ID for a computation.

    • name

      public final String name()

      The name of a computation.

      Returns:
      The name of a computation.

    • category

      public final DimensionField category()

      The category field that is used in a computation.

      Returns:
      The category field that is used in a computation.

    • value

      public final MeasureField value()

      The value field that is used in a computation.

      Returns:
      The value field that is used in a computation.

    • resultSize

      public final Integer resultSize()

      The result size of a top and bottom ranked computation.

      Returns:
      The result size of a top and bottom ranked computation.

    • type

      public final TopBottomComputationType type()

      The computation type. Choose one of the following options:

      • TOP: A top ranked computation.

      • BOTTOM: A bottom ranked computation.

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

      Returns:
      The computation type. Choose one of the following options:

      • TOP: A top ranked computation.

      • BOTTOM: A bottom ranked computation.

      See Also:

    • typeAsString

      public final String typeAsString()

      The computation type. Choose one of the following options:

      • TOP: A top ranked computation.

      • BOTTOM: A bottom ranked computation.

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

      Returns:
      The computation type. Choose one of the following options:

      • TOP: A top ranked computation.

      • BOTTOM: A bottom ranked computation.

      See Also:

    • toBuilder

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

    • builder

      public static TopBottomRankedComputation.Builder builder()

    • serializableBuilderClass

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