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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PivotTableOptions.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PivotTableOptions.Builder
builder()
TableCellStyle
cellStyle()
The table cell style of cells.Visibility
collapsedRowDimensionsVisibility()
The visibility setting of a pivot table's collapsed row dimension fields.String
collapsedRowDimensionsVisibilityAsString()
The visibility setting of a pivot table's collapsed row dimension fields.TableCellStyle
columnHeaderStyle()
The table cell style of the column header.Visibility
columnNamesVisibility()
The visibility of the column names.String
columnNamesVisibilityAsString()
The visibility of the column names.String
defaultCellWidth()
The default cell width of the pivot table.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
PivotTableMetricPlacement
metricPlacement()
The metric placement (row, column) options.String
metricPlacementAsString()
The metric placement (row, column) options.RowAlternateColorOptions
rowAlternateColorOptions()
The row alternate color options (widget status, row alternate colors).TableCellStyle
rowFieldNamesStyle()
The table cell style of row field names.TableCellStyle
rowHeaderStyle()
The table cell style of the row headers.PivotTableRowsLabelOptions
rowsLabelOptions()
The options for the label that is located above the row headers.PivotTableRowsLayout
rowsLayout()
The layout for the row dimension headers of a pivot table.String
rowsLayoutAsString()
The layout for the row dimension headers of a pivot table.List<SdkField<?>>
sdkFields()
static Class<? extends PivotTableOptions.Builder>
serializableBuilderClass()
Visibility
singleMetricVisibility()
The visibility of the single metric options.String
singleMetricVisibilityAsString()
The visibility of the single metric options.PivotTableOptions.Builder
toBuilder()
Visibility
toggleButtonsVisibility()
Determines the visibility of the pivot table.String
toggleButtonsVisibilityAsString()
Determines the visibility of the pivot table.String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnPivotTableMetricPlacement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricPlacementAsString()
.- Returns:
- The metric placement (row, column) options.
- See Also:
PivotTableMetricPlacement
-
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 returnPivotTableMetricPlacement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricPlacementAsString()
.- Returns:
- The metric placement (row, column) options.
- See Also:
PivotTableMetricPlacement
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsingleMetricVisibilityAsString()
.- Returns:
- The visibility of the single metric options.
- See Also:
Visibility
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsingleMetricVisibilityAsString()
.- Returns:
- The visibility of the single metric options.
- See Also:
Visibility
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcolumnNamesVisibilityAsString()
.- Returns:
- The visibility of the column names.
- See Also:
Visibility
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcolumnNamesVisibilityAsString()
.- Returns:
- The visibility of the column names.
- See Also:
Visibility
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtoggleButtonsVisibilityAsString()
.- Returns:
- Determines the visibility of the pivot table.
- See Also:
Visibility
-
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 returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtoggleButtonsVisibilityAsString()
.- Returns:
- Determines the visibility of the pivot table.
- See Also:
Visibility
-
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 isVISIBLE
.If the service returns an enum value that is not available in the current SDK version,
collapsedRowDimensionsVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcollapsedRowDimensionsVisibilityAsString()
.- 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 isVISIBLE
. - See Also:
Visibility
-
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 isVISIBLE
.If the service returns an enum value that is not available in the current SDK version,
collapsedRowDimensionsVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcollapsedRowDimensionsVisibilityAsString()
.- 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 isVISIBLE
. - See Also:
Visibility
-
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 returnPivotTableRowsLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrowsLayoutAsString()
.- 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:
PivotTableRowsLayout
-
-
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 returnPivotTableRowsLayout.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrowsLayoutAsString()
.- 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:
PivotTableRowsLayout
-
-
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 toHIERARCHY
.- Returns:
- The options for the label that is located above the row headers. This option is only applicable when
RowsLayout
is set toHIERARCHY
.
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PivotTableOptions.Builder,PivotTableOptions>
-
builder
public static PivotTableOptions.Builder builder()
-
serializableBuilderClass
public static Class<? extends PivotTableOptions.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-