Class PivotTableOptions

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

The table options for a pivot table visual.

See Also:

  • Method Details

    • metricPlacement

      public final PivotTableMetricPlacement metricPlacement()

      The metric placement (row, column) options.

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

      Returns:
      The metric placement (row, column) options.
      See Also:

    • metricPlacementAsString

      public final String metricPlacementAsString()

      The metric placement (row, column) options.

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

      Returns:
      The metric placement (row, column) options.
      See Also:

    • singleMetricVisibility

      public final Visibility singleMetricVisibility()

      The visibility of the single metric options.

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

      Returns:
      The visibility of the single metric options.
      See Also:

    • singleMetricVisibilityAsString

      public final String singleMetricVisibilityAsString()

      The visibility of the single metric options.

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

      Returns:
      The visibility of the single metric options.
      See Also:

    • columnNamesVisibility

      public final Visibility columnNamesVisibility()

      The visibility of the column names.

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

      Returns:
      The visibility of the column names.
      See Also:

    • columnNamesVisibilityAsString

      public final String columnNamesVisibilityAsString()

      The visibility of the column names.

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

      Returns:
      The visibility of the column names.
      See Also:

    • toggleButtonsVisibility

      public final Visibility toggleButtonsVisibility()

      Determines the visibility of the pivot table.

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

      Returns:
      Determines the visibility of the pivot table.
      See Also:

    • toggleButtonsVisibilityAsString

      public final String toggleButtonsVisibilityAsString()

      Determines the visibility of the pivot table.

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

      Returns:
      Determines the visibility of the pivot table.
      See Also:

    • columnHeaderStyle

      public final TableCellStyle columnHeaderStyle()

      The table cell style of the column header.

      Returns:
      The table cell style of the column header.

    • rowHeaderStyle

      public final TableCellStyle rowHeaderStyle()

      The table cell style of the row headers.

      Returns:
      The table cell style of the row headers.

    • cellStyle

      public final TableCellStyle cellStyle()

      The table cell style of cells.

      Returns:
      The table cell style of cells.

    • rowFieldNamesStyle

      public final TableCellStyle rowFieldNamesStyle()

      The table cell style of row field names.

      Returns:
      The table cell style of row field names.

    • rowAlternateColorOptions

      public final RowAlternateColorOptions rowAlternateColorOptions()

      The row alternate color options (widget status, row alternate colors).

      Returns:
      The row alternate color options (widget status, row alternate colors).

    • collapsedRowDimensionsVisibility

      public final Visibility collapsedRowDimensionsVisibility()

      The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

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

      Returns:
      The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.
      See Also:

    • collapsedRowDimensionsVisibilityAsString

      public final String collapsedRowDimensionsVisibilityAsString()

      The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

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

      Returns:
      The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.
      See Also:

    • rowsLayout

      public final PivotTableRowsLayout rowsLayout()

      The layout for the row dimension headers of a pivot table. Choose one of the following options.

      • TABULAR: (Default) Each row field is displayed in a separate column.

      • HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

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

      Returns:
      The layout for the row dimension headers of a pivot table. Choose one of the following options.

      • TABULAR: (Default) Each row field is displayed in a separate column.

      • HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

      See Also:

    • rowsLayoutAsString

      public final String rowsLayoutAsString()

      The layout for the row dimension headers of a pivot table. Choose one of the following options.

      • TABULAR: (Default) Each row field is displayed in a separate column.

      • HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

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

      Returns:
      The layout for the row dimension headers of a pivot table. Choose one of the following options.

      • TABULAR: (Default) Each row field is displayed in a separate column.

      • HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.

      See Also:

    • rowsLabelOptions

      public final PivotTableRowsLabelOptions rowsLabelOptions()

      The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

      Returns:
      The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

    • defaultCellWidth

      public final String defaultCellWidth()

      The default cell width of the pivot table.

      Returns:
      The default cell width of the pivot table.

    • toBuilder

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

    • builder

      public static PivotTableOptions.Builder builder()

    • serializableBuilderClass

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