Class DashboardPublishOptions

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

Dashboard publish options.

See Also:

  • Method Details

    • adHocFilteringOption

      public final AdHocFilteringOption adHocFilteringOption()

      Ad hoc (one-time) filtering option.

      Returns:
      Ad hoc (one-time) filtering option.

    • exportToCSVOption

      public final ExportToCSVOption exportToCSVOption()

      Export to .csv option.

      Returns:
      Export to .csv option.

    • sheetControlsOption

      public final SheetControlsOption sheetControlsOption()

      Sheet controls option.

      Returns:
      Sheet controls option.

    • visualPublishOptions

      @Deprecated public final DashboardVisualPublishOptions visualPublishOptions()
      Deprecated.
      VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields.

      The visual publish options of a visual in a dashboard.

      Returns:
      The visual publish options of a visual in a dashboard.

    • sheetLayoutElementMaximizationOption

      public final SheetLayoutElementMaximizationOption sheetLayoutElementMaximizationOption()

      The sheet layout maximization options of a dashbaord.

      Returns:
      The sheet layout maximization options of a dashbaord.

    • visualMenuOption

      public final VisualMenuOption visualMenuOption()

      The menu options of a visual in a dashboard.

      Returns:
      The menu options of a visual in a dashboard.

    • visualAxisSortOption

      public final VisualAxisSortOption visualAxisSortOption()

      The axis sort options of a dashboard.

      Returns:
      The axis sort options of a dashboard.

    • exportWithHiddenFieldsOption

      public final ExportWithHiddenFieldsOption exportWithHiddenFieldsOption()

      Determines if hidden fields are exported with a dashboard.

      Returns:
      Determines if hidden fields are exported with a dashboard.

    • dataPointDrillUpDownOption

      public final DataPointDrillUpDownOption dataPointDrillUpDownOption()

      The drill-down options of data points in a dashboard.

      Returns:
      The drill-down options of data points in a dashboard.

    • dataPointMenuLabelOption

      public final DataPointMenuLabelOption dataPointMenuLabelOption()

      The data point menu label options of a dashboard.

      Returns:
      The data point menu label options of a dashboard.

    • dataPointTooltipOption

      public final DataPointTooltipOption dataPointTooltipOption()

      The data point tool tip options of a dashboard.

      Returns:
      The data point tool tip options of a dashboard.

    • dataQAEnabledOption

      public final DataQAEnabledOption dataQAEnabledOption()

      Adds Q&A capabilities to an Amazon QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

      Returns:
      Adds Q&A capabilities to an Amazon QuickSight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

    • toBuilder

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

    • builder

      public static DashboardPublishOptions.Builder builder()

    • serializableBuilderClass

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