Package software.amazon.awssdk.services.quicksight.model

Interface PivotTotalOptions.Builder

All Superinterfaces:

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

Enclosing class:

PivotTotalOptions

@Mutable
@NotThreadSafe
public static interface PivotTotalOptions.Builder
extends SdkPojo, CopyableBuilder<PivotTotalOptions.Builder,PivotTotalOptions>

Method Summary

Modifier and Type	Method	Description
PivotTotalOptions.Builder	customLabel(String customLabel)	The custom label string for the total cells.
default PivotTotalOptions.Builder	metricHeaderCellStyle(Consumer<TableCellStyle.Builder> metricHeaderCellStyle)	The cell styling options for the total of header cells.
PivotTotalOptions.Builder	metricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)	The cell styling options for the total of header cells.
PivotTotalOptions.Builder	placement(String placement)	The placement (start, end) for the total cells.
PivotTotalOptions.Builder	placement(TableTotalsPlacement placement)	The placement (start, end) for the total cells.
PivotTotalOptions.Builder	scrollStatus(String scrollStatus)	The scroll status (pinned, scrolled) for the total cells.
PivotTotalOptions.Builder	scrollStatus(TableTotalsScrollStatus scrollStatus)	The scroll status (pinned, scrolled) for the total cells.
PivotTotalOptions.Builder	totalAggregationOptions(Collection<TotalAggregationOption> totalAggregationOptions)	The total aggregation options for each value field.
PivotTotalOptions.Builder	totalAggregationOptions(Consumer<TotalAggregationOption.Builder>... totalAggregationOptions)	The total aggregation options for each value field.
PivotTotalOptions.Builder	totalAggregationOptions(TotalAggregationOption... totalAggregationOptions)	The total aggregation options for each value field.
default PivotTotalOptions.Builder	totalCellStyle(Consumer<TableCellStyle.Builder> totalCellStyle)	The cell styling options for the total cells.
PivotTotalOptions.Builder	totalCellStyle(TableCellStyle totalCellStyle)	The cell styling options for the total cells.
PivotTotalOptions.Builder	totalsVisibility(String totalsVisibility)	The visibility configuration for the total cells.
PivotTotalOptions.Builder	totalsVisibility(Visibility totalsVisibility)	The visibility configuration for the total cells.
default PivotTotalOptions.Builder	valueCellStyle(Consumer<TableCellStyle.Builder> valueCellStyle)	The cell styling options for the totals of value cells.
PivotTotalOptions.Builder	valueCellStyle(TableCellStyle valueCellStyle)	The cell styling options for the totals of value cells.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

totalsVisibility

PivotTotalOptions.Builder totalsVisibility(String totalsVisibility)

The visibility configuration for the total cells.

Parameters:

totalsVisibility - The visibility configuration for the total cells.

Returns:

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

See Also:

Visibility, Visibility

totalsVisibility

PivotTotalOptions.Builder totalsVisibility(Visibility totalsVisibility)

The visibility configuration for the total cells.

Parameters:

totalsVisibility - The visibility configuration for the total cells.

Returns:

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

See Also:

Visibility, Visibility

placement

PivotTotalOptions.Builder placement(String placement)

The placement (start, end) for the total cells.

Parameters:

placement - The placement (start, end) for the total cells.

Returns:

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

See Also:

TableTotalsPlacement, TableTotalsPlacement

placement

PivotTotalOptions.Builder placement(TableTotalsPlacement placement)

The placement (start, end) for the total cells.

Parameters:

placement - The placement (start, end) for the total cells.

Returns:

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

See Also:

TableTotalsPlacement, TableTotalsPlacement

scrollStatus

PivotTotalOptions.Builder scrollStatus(String scrollStatus)

The scroll status (pinned, scrolled) for the total cells.

Parameters:

scrollStatus - The scroll status (pinned, scrolled) for the total cells.

Returns:

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

See Also:

TableTotalsScrollStatus, TableTotalsScrollStatus

scrollStatus

PivotTotalOptions.Builder scrollStatus(TableTotalsScrollStatus scrollStatus)

The scroll status (pinned, scrolled) for the total cells.

Parameters:

scrollStatus - The scroll status (pinned, scrolled) for the total cells.

Returns:

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

See Also:

TableTotalsScrollStatus, TableTotalsScrollStatus

customLabel

PivotTotalOptions.Builder customLabel(String customLabel)

The custom label string for the total cells.

Parameters:

customLabel - The custom label string for the total cells.

Returns:

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

totalCellStyle

PivotTotalOptions.Builder totalCellStyle(TableCellStyle totalCellStyle)

The cell styling options for the total cells.

Parameters:

totalCellStyle - The cell styling options for the total cells.

Returns:

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

totalCellStyle

default PivotTotalOptions.Builder totalCellStyle(Consumer<TableCellStyle.Builder> totalCellStyle)

The cell styling options for the total 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 totalCellStyle(TableCellStyle).

Parameters:

totalCellStyle - 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:

totalCellStyle(TableCellStyle)

valueCellStyle

PivotTotalOptions.Builder valueCellStyle(TableCellStyle valueCellStyle)

The cell styling options for the totals of value cells.

Parameters:

valueCellStyle - The cell styling options for the totals of value cells.

Returns:

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

valueCellStyle

default PivotTotalOptions.Builder valueCellStyle(Consumer<TableCellStyle.Builder> valueCellStyle)

The cell styling options for the totals of value 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 valueCellStyle(TableCellStyle).

Parameters:

valueCellStyle - 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:

valueCellStyle(TableCellStyle)

metricHeaderCellStyle

PivotTotalOptions.Builder metricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)

The cell styling options for the total of header cells.

Parameters:

metricHeaderCellStyle - The cell styling options for the total of header cells.

Returns:

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

metricHeaderCellStyle

default PivotTotalOptions.Builder metricHeaderCellStyle(Consumer<TableCellStyle.Builder> metricHeaderCellStyle)

The cell styling options for the total of header 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 metricHeaderCellStyle(TableCellStyle).

Parameters:

metricHeaderCellStyle - 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:

metricHeaderCellStyle(TableCellStyle)

totalAggregationOptions

PivotTotalOptions.Builder totalAggregationOptions(Collection<TotalAggregationOption> totalAggregationOptions)

The total aggregation options for each value field.

Parameters:

totalAggregationOptions - The total aggregation options for each value field.

Returns:

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

totalAggregationOptions

PivotTotalOptions.Builder totalAggregationOptions(TotalAggregationOption... totalAggregationOptions)

The total aggregation options for each value field.

Parameters:

totalAggregationOptions - The total aggregation options for each value field.

Returns:

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

totalAggregationOptions

PivotTotalOptions.Builder totalAggregationOptions(Consumer<TotalAggregationOption.Builder>... totalAggregationOptions)

The total aggregation options for each value field.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #totalAggregationOptions(List).

Parameters:

totalAggregationOptions - a consumer that will call methods on TotalAggregationOption.Builder

Returns:

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

See Also:

#totalAggregationOptions(java.util.Collection)