Package software.amazon.awssdk.services.quicksight.model

Class KPIOptions

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

The options that determine the presentation of a KPI visual.

See Also:

  • Method Details

    • progressBar

      public final ProgressBarOptions progressBar()

      The options that determine the presentation of the progress bar of a KPI visual.

      Returns:
      The options that determine the presentation of the progress bar of a KPI visual.

    • trendArrows

      public final TrendArrowOptions trendArrows()

      The options that determine the presentation of trend arrows in a KPI visual.

      Returns:
      The options that determine the presentation of trend arrows in a KPI visual.

    • secondaryValue

      public final SecondaryValueOptions secondaryValue()

      The options that determine the presentation of the secondary value of a KPI visual.

      Returns:
      The options that determine the presentation of the secondary value of a KPI visual.

    • comparison

      public final ComparisonConfiguration comparison()

      The comparison configuration of a KPI visual.

      Returns:
      The comparison configuration of a KPI visual.

    • primaryValueDisplayType

      public final PrimaryValueDisplayType primaryValueDisplayType()

      The options that determine the primary value display type.

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

      Returns:
      The options that determine the primary value display type.
      See Also:

    • primaryValueDisplayTypeAsString

      public final String primaryValueDisplayTypeAsString()

      The options that determine the primary value display type.

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

      Returns:
      The options that determine the primary value display type.
      See Also:

    • primaryValueFontConfiguration

      public final FontConfiguration primaryValueFontConfiguration()

      The options that determine the primary value font configuration.

      Returns:
      The options that determine the primary value font configuration.

    • secondaryValueFontConfiguration

      public final FontConfiguration secondaryValueFontConfiguration()

      The options that determine the secondary value font configuration.

      Returns:
      The options that determine the secondary value font configuration.

    • sparkline

      public final KPISparklineOptions sparkline()

      The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

      Returns:
      The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

    • visualLayoutOptions

      public final KPIVisualLayoutOptions visualLayoutOptions()

      The options that determine the layout a KPI visual.

      Returns:
      The options that determine the layout a KPI visual.

    • toBuilder

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

    • builder

      public static KPIOptions.Builder builder()

    • serializableBuilderClass

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