Class KPISparklineOptions

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

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

See Also:

  • Method Details

    • visibility

      public final Visibility visibility()

      The visibility of the sparkline.

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

      Returns:
      The visibility of the sparkline.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      The visibility of the sparkline.

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

      Returns:
      The visibility of the sparkline.
      See Also:

    • type

      public final KPISparklineType type()

      The type of the sparkline.

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

      Returns:
      The type of the sparkline.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the sparkline.

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

      Returns:
      The type of the sparkline.
      See Also:

    • color

      public final String color()

      The color of the sparkline.

      Returns:
      The color of the sparkline.

    • tooltipVisibility

      public final Visibility tooltipVisibility()

      The tooltip visibility of the sparkline.

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

      Returns:
      The tooltip visibility of the sparkline.
      See Also:

    • tooltipVisibilityAsString

      public final String tooltipVisibilityAsString()

      The tooltip visibility of the sparkline.

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

      Returns:
      The tooltip visibility of the sparkline.
      See Also:

    • toBuilder

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

    • builder

      public static KPISparklineOptions.Builder builder()

    • serializableBuilderClass

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