Class TopBottomMoversComputation

    • Method Detail

      • 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.
      • time

        public final DimensionField time()

        The time field that is used in a computation.

        Returns:
        The time field that is used in 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.
      • moverSize

        public final Integer moverSize()

        The mover size setup of the top and bottom movers computation.

        Returns:
        The mover size setup of the top and bottom movers computation.
      • sortOrderAsString

        public final String sortOrderAsString()

        The sort order setup of the top and bottom movers computation.

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

        Returns:
        The sort order setup of the top and bottom movers computation.
        See Also:
        TopBottomSortOrder
      • type

        public final TopBottomComputationType type()

        The computation type. Choose from the following options:

        • TOP: Top movers computation.

        • BOTTOM: Bottom movers 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 from the following options:

        • TOP: Top movers computation.

        • BOTTOM: Bottom movers computation.

        See Also:
        TopBottomComputationType
      • typeAsString

        public final String typeAsString()

        The computation type. Choose from the following options:

        • TOP: Top movers computation.

        • BOTTOM: Bottom movers 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 from the following options:

        • TOP: Top movers computation.

        • BOTTOM: Bottom movers computation.

        See Also:
        TopBottomComputationType
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)