software.amazon.awssdk.services.quicksight.model

Interface PivotTableOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PivotTableOptions.Builder,PivotTableOptions>, SdkBuilder<PivotTableOptions.Builder,PivotTableOptions>, SdkPojo

Enclosing class:

PivotTableOptions

public static interface PivotTableOptions.Builder
extends SdkPojo, CopyableBuilder<PivotTableOptions.Builder,PivotTableOptions>

Method Summary

Modifier and Type	Method and Description
default PivotTableOptions.Builder	cellStyle(Consumer<TableCellStyle.Builder> cellStyle) The table cell style of cells.
PivotTableOptions.Builder	cellStyle(TableCellStyle cellStyle) The table cell style of cells.
PivotTableOptions.Builder	collapsedRowDimensionsVisibility(String collapsedRowDimensionsVisibility) The visibility setting of a pivot table's collapsed row dimension fields.
PivotTableOptions.Builder	collapsedRowDimensionsVisibility(Visibility collapsedRowDimensionsVisibility) The visibility setting of a pivot table's collapsed row dimension fields.
default PivotTableOptions.Builder	columnHeaderStyle(Consumer<TableCellStyle.Builder> columnHeaderStyle) The table cell style of the column header.
PivotTableOptions.Builder	columnHeaderStyle(TableCellStyle columnHeaderStyle) The table cell style of the column header.
PivotTableOptions.Builder	columnNamesVisibility(String columnNamesVisibility) The visibility of the column names.
PivotTableOptions.Builder	columnNamesVisibility(Visibility columnNamesVisibility) The visibility of the column names.
PivotTableOptions.Builder	defaultCellWidth(String defaultCellWidth) The default cell width of the pivot table.
PivotTableOptions.Builder	metricPlacement(PivotTableMetricPlacement metricPlacement) The metric placement (row, column) options.
PivotTableOptions.Builder	metricPlacement(String metricPlacement) The metric placement (row, column) options.
default PivotTableOptions.Builder	rowAlternateColorOptions(Consumer<RowAlternateColorOptions.Builder> rowAlternateColorOptions) The row alternate color options (widget status, row alternate colors).
PivotTableOptions.Builder	rowAlternateColorOptions(RowAlternateColorOptions rowAlternateColorOptions) The row alternate color options (widget status, row alternate colors).
default PivotTableOptions.Builder	rowFieldNamesStyle(Consumer<TableCellStyle.Builder> rowFieldNamesStyle) The table cell style of row field names.
PivotTableOptions.Builder	rowFieldNamesStyle(TableCellStyle rowFieldNamesStyle) The table cell style of row field names.
default PivotTableOptions.Builder	rowHeaderStyle(Consumer<TableCellStyle.Builder> rowHeaderStyle) The table cell style of the row headers.
PivotTableOptions.Builder	rowHeaderStyle(TableCellStyle rowHeaderStyle) The table cell style of the row headers.
default PivotTableOptions.Builder	rowsLabelOptions(Consumer<PivotTableRowsLabelOptions.Builder> rowsLabelOptions) The options for the label that is located above the row headers.
PivotTableOptions.Builder	rowsLabelOptions(PivotTableRowsLabelOptions rowsLabelOptions) The options for the label that is located above the row headers.
PivotTableOptions.Builder	rowsLayout(PivotTableRowsLayout rowsLayout) The layout for the row dimension headers of a pivot table.
PivotTableOptions.Builder	rowsLayout(String rowsLayout) The layout for the row dimension headers of a pivot table.
PivotTableOptions.Builder	singleMetricVisibility(String singleMetricVisibility) The visibility of the single metric options.
PivotTableOptions.Builder	singleMetricVisibility(Visibility singleMetricVisibility) The visibility of the single metric options.
PivotTableOptions.Builder	toggleButtonsVisibility(String toggleButtonsVisibility) Determines the visibility of the pivot table.
PivotTableOptions.Builder	toggleButtonsVisibility(Visibility toggleButtonsVisibility) Determines the visibility of the pivot table.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

metricPlacement

PivotTableOptions.Builder metricPlacement(String metricPlacement)

The metric placement (row, column) options.

Parameters:

metricPlacement - The metric placement (row, column) options.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PivotTableMetricPlacement, PivotTableMetricPlacement

metricPlacement

PivotTableOptions.Builder metricPlacement(PivotTableMetricPlacement metricPlacement)

The metric placement (row, column) options.

Parameters:

metricPlacement - The metric placement (row, column) options.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PivotTableMetricPlacement, PivotTableMetricPlacement

singleMetricVisibility

PivotTableOptions.Builder singleMetricVisibility(String singleMetricVisibility)

The visibility of the single metric options.

Parameters:

singleMetricVisibility - The visibility of the single metric options.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

singleMetricVisibility

PivotTableOptions.Builder singleMetricVisibility(Visibility singleMetricVisibility)

The visibility of the single metric options.

Parameters:

singleMetricVisibility - The visibility of the single metric options.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

columnNamesVisibility

PivotTableOptions.Builder columnNamesVisibility(String columnNamesVisibility)

The visibility of the column names.

Parameters:

columnNamesVisibility - The visibility of the column names.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

columnNamesVisibility

PivotTableOptions.Builder columnNamesVisibility(Visibility columnNamesVisibility)

The visibility of the column names.

Parameters:

columnNamesVisibility - The visibility of the column names.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

toggleButtonsVisibility

PivotTableOptions.Builder toggleButtonsVisibility(String toggleButtonsVisibility)

Determines the visibility of the pivot table.

Parameters:

toggleButtonsVisibility - Determines the visibility of the pivot table.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

toggleButtonsVisibility

PivotTableOptions.Builder toggleButtonsVisibility(Visibility toggleButtonsVisibility)

Determines the visibility of the pivot table.

Parameters:

toggleButtonsVisibility - Determines the visibility of the pivot table.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

columnHeaderStyle

PivotTableOptions.Builder columnHeaderStyle(TableCellStyle columnHeaderStyle)

The table cell style of the column header.

Parameters:

columnHeaderStyle - The table cell style of the column header.

Returns:

Returns a reference to this object so that method calls can be chained together.

columnHeaderStyle

default PivotTableOptions.Builder columnHeaderStyle(Consumer<TableCellStyle.Builder> columnHeaderStyle)

The table cell style of the column header.

This is a convenience method that creates an instance of the TableCellStyle.Builder avoiding the need to create one manually via TableCellStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to columnHeaderStyle(TableCellStyle).

Parameters:

columnHeaderStyle - a consumer that will call methods on TableCellStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

columnHeaderStyle(TableCellStyle)

rowHeaderStyle

PivotTableOptions.Builder rowHeaderStyle(TableCellStyle rowHeaderStyle)

The table cell style of the row headers.

Parameters:

rowHeaderStyle - The table cell style of the row headers.

Returns:

Returns a reference to this object so that method calls can be chained together.

rowHeaderStyle

default PivotTableOptions.Builder rowHeaderStyle(Consumer<TableCellStyle.Builder> rowHeaderStyle)

The table cell style of the row headers.

This is a convenience method that creates an instance of the TableCellStyle.Builder avoiding the need to create one manually via TableCellStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rowHeaderStyle(TableCellStyle).

Parameters:

rowHeaderStyle - a consumer that will call methods on TableCellStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rowHeaderStyle(TableCellStyle)

cellStyle

PivotTableOptions.Builder cellStyle(TableCellStyle cellStyle)

The table cell style of cells.

Parameters:

cellStyle - The table cell style of cells.

Returns:

Returns a reference to this object so that method calls can be chained together.

cellStyle

default PivotTableOptions.Builder cellStyle(Consumer<TableCellStyle.Builder> cellStyle)

The table cell style of cells.

This is a convenience method that creates an instance of the TableCellStyle.Builder avoiding the need to create one manually via TableCellStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cellStyle(TableCellStyle).

Parameters:

cellStyle - a consumer that will call methods on TableCellStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cellStyle(TableCellStyle)

rowFieldNamesStyle

PivotTableOptions.Builder rowFieldNamesStyle(TableCellStyle rowFieldNamesStyle)

The table cell style of row field names.

Parameters:

rowFieldNamesStyle - The table cell style of row field names.

Returns:

Returns a reference to this object so that method calls can be chained together.

rowFieldNamesStyle

default PivotTableOptions.Builder rowFieldNamesStyle(Consumer<TableCellStyle.Builder> rowFieldNamesStyle)

The table cell style of row field names.

This is a convenience method that creates an instance of the TableCellStyle.Builder avoiding the need to create one manually via TableCellStyle.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rowFieldNamesStyle(TableCellStyle).

Parameters:

rowFieldNamesStyle - a consumer that will call methods on TableCellStyle.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rowFieldNamesStyle(TableCellStyle)

rowAlternateColorOptions

PivotTableOptions.Builder rowAlternateColorOptions(RowAlternateColorOptions rowAlternateColorOptions)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

rowAlternateColorOptions

default PivotTableOptions.Builder rowAlternateColorOptions(Consumer<RowAlternateColorOptions.Builder> rowAlternateColorOptions)

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

This is a convenience method that creates an instance of the RowAlternateColorOptions.Builder avoiding the need to create one manually via RowAlternateColorOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rowAlternateColorOptions(RowAlternateColorOptions).

Parameters:

rowAlternateColorOptions - a consumer that will call methods on RowAlternateColorOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rowAlternateColorOptions(RowAlternateColorOptions)

collapsedRowDimensionsVisibility

PivotTableOptions.Builder collapsedRowDimensionsVisibility(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

collapsedRowDimensionsVisibility

PivotTableOptions.Builder collapsedRowDimensionsVisibility(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Visibility, Visibility

rowsLayout

PivotTableOptions.Builder rowsLayout(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PivotTableRowsLayout, PivotTableRowsLayout

rowsLayout

PivotTableOptions.Builder rowsLayout(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PivotTableRowsLayout, PivotTableRowsLayout

rowsLabelOptions

PivotTableOptions.Builder rowsLabelOptions(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

rowsLabelOptions

default PivotTableOptions.Builder rowsLabelOptions(Consumer<PivotTableRowsLabelOptions.Builder> rowsLabelOptions)

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

This is a convenience method that creates an instance of the PivotTableRowsLabelOptions.Builder avoiding the need to create one manually via PivotTableRowsLabelOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rowsLabelOptions(PivotTableRowsLabelOptions).

Parameters:

rowsLabelOptions - a consumer that will call methods on PivotTableRowsLabelOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rowsLabelOptions(PivotTableRowsLabelOptions)

defaultCellWidth

PivotTableOptions.Builder defaultCellWidth(String defaultCellWidth)

The default cell width of the pivot table.

Parameters:

defaultCellWidth - The default cell width of the pivot table.

Returns:

Returns a reference to this object so that method calls can be chained together.