Class WaterfallVisual

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

A waterfall chart.

For more information, see Using waterfall charts in the Amazon Quick Suite User Guide.

See Also:

  • Method Details

    • visualId

      public final String visualId()

      The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

      Returns:
      The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

    • title

      public final VisualTitleLabelOptions title()

      The title that is displayed on the visual.

      Returns:
      The title that is displayed on the visual.

    • subtitle

      public final VisualSubtitleLabelOptions subtitle()

      The subtitle that is displayed on the visual.

      Returns:
      The subtitle that is displayed on the visual.

    • chartConfiguration

      public final WaterfallChartConfiguration chartConfiguration()

      The configuration for a waterfall visual.

      Returns:
      The configuration for a waterfall visual.

    • hasActions

      public final boolean hasActions()
      For responses, this returns true if the service returned a value for the Actions 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.

    • actions

      public final List<VisualCustomAction> actions()

      The list of custom actions that are configured for a visual.

      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 hasActions() method.

      Returns:
      The list of custom actions that are configured for a visual.

    • hasColumnHierarchies

      public final boolean hasColumnHierarchies()
      For responses, this returns true if the service returned a value for the ColumnHierarchies 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.

    • columnHierarchies

      public final List<ColumnHierarchy> columnHierarchies()

      The column hierarchy that is used during drill-downs and drill-ups.

      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 hasColumnHierarchies() method.

      Returns:
      The column hierarchy that is used during drill-downs and drill-ups.

    • visualContentAltText

      public final String visualContentAltText()

      The alt text for the visual.

      Returns:
      The alt text for the visual.

    • toBuilder

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

    • builder

      public static WaterfallVisual.Builder builder()

    • serializableBuilderClass

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