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

Interface SubtotalOptions.Builder

All Superinterfaces:

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

Enclosing class:

SubtotalOptions

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

Method Summary

Modifier and Type	Method	Description
SubtotalOptions.Builder	customLabel(String customLabel)	The custom label string for the subtotal cells.
SubtotalOptions.Builder	fieldLevel(String fieldLevel)	The field level (all, custom, last) for the subtotal cells.
SubtotalOptions.Builder	fieldLevel(PivotTableSubtotalLevel fieldLevel)	The field level (all, custom, last) for the subtotal cells.
SubtotalOptions.Builder	fieldLevelOptions(Collection<PivotTableFieldSubtotalOptions> fieldLevelOptions)	The optional configuration of subtotal cells.
SubtotalOptions.Builder	fieldLevelOptions(Consumer<PivotTableFieldSubtotalOptions.Builder>... fieldLevelOptions)	The optional configuration of subtotal cells.
SubtotalOptions.Builder	fieldLevelOptions(PivotTableFieldSubtotalOptions... fieldLevelOptions)	The optional configuration of subtotal cells.
default SubtotalOptions.Builder	metricHeaderCellStyle(Consumer<TableCellStyle.Builder> metricHeaderCellStyle)	The cell styling options for the subtotals of header cells.
SubtotalOptions.Builder	metricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)	The cell styling options for the subtotals of header cells.
SubtotalOptions.Builder	styleTargets(Collection<TableStyleTarget> styleTargets)	The style targets options for subtotals.
SubtotalOptions.Builder	styleTargets(Consumer<TableStyleTarget.Builder>... styleTargets)	The style targets options for subtotals.
SubtotalOptions.Builder	styleTargets(TableStyleTarget... styleTargets)	The style targets options for subtotals.
default SubtotalOptions.Builder	totalCellStyle(Consumer<TableCellStyle.Builder> totalCellStyle)	The cell styling options for the subtotal cells.
SubtotalOptions.Builder	totalCellStyle(TableCellStyle totalCellStyle)	The cell styling options for the subtotal cells.
SubtotalOptions.Builder	totalsVisibility(String totalsVisibility)	The visibility configuration for the subtotal cells.
SubtotalOptions.Builder	totalsVisibility(Visibility totalsVisibility)	The visibility configuration for the subtotal cells.
default SubtotalOptions.Builder	valueCellStyle(Consumer<TableCellStyle.Builder> valueCellStyle)	The cell styling options for the subtotals of value cells.
SubtotalOptions.Builder	valueCellStyle(TableCellStyle valueCellStyle)	The cell styling options for the subtotals 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, sdkFields

Method Details

totalsVisibility

SubtotalOptions.Builder totalsVisibility(String totalsVisibility)

The visibility configuration for the subtotal cells.

Parameters:

totalsVisibility - The visibility configuration for the subtotal cells.

Returns:

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

See Also:

• Visibility
• Visibility

totalsVisibility

SubtotalOptions.Builder totalsVisibility(Visibility totalsVisibility)

The visibility configuration for the subtotal cells.

Parameters:

totalsVisibility - The visibility configuration for the subtotal cells.

Returns:

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

See Also:

• Visibility
• Visibility

customLabel

SubtotalOptions.Builder customLabel(String customLabel)

The custom label string for the subtotal cells.

Parameters:

customLabel - The custom label string for the subtotal cells.

Returns:

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

fieldLevel

SubtotalOptions.Builder fieldLevel(String fieldLevel)

The field level (all, custom, last) for the subtotal cells.

Parameters:

fieldLevel - The field level (all, custom, last) for the subtotal cells.

Returns:

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

See Also:

• PivotTableSubtotalLevel
• PivotTableSubtotalLevel

fieldLevel

SubtotalOptions.Builder fieldLevel(PivotTableSubtotalLevel fieldLevel)

The field level (all, custom, last) for the subtotal cells.

Parameters:

fieldLevel - The field level (all, custom, last) for the subtotal cells.

Returns:

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

See Also:

• PivotTableSubtotalLevel
• PivotTableSubtotalLevel

fieldLevelOptions

SubtotalOptions.Builder fieldLevelOptions(Collection<PivotTableFieldSubtotalOptions> fieldLevelOptions)

The optional configuration of subtotal cells.

Parameters:

fieldLevelOptions - The optional configuration of subtotal cells.

Returns:

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

fieldLevelOptions

SubtotalOptions.Builder fieldLevelOptions(PivotTableFieldSubtotalOptions... fieldLevelOptions)

The optional configuration of subtotal cells.

Parameters:

fieldLevelOptions - The optional configuration of subtotal cells.

Returns:

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

fieldLevelOptions

SubtotalOptions.Builder fieldLevelOptions(Consumer<PivotTableFieldSubtotalOptions.Builder>... fieldLevelOptions)

The optional configuration of subtotal cells.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldLevelOptions(List<PivotTableFieldSubtotalOptions>).

Parameters:

fieldLevelOptions - a consumer that will call methods on PivotTableFieldSubtotalOptions.Builder

Returns:

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

See Also:

• fieldLevelOptions(java.util.Collection<PivotTableFieldSubtotalOptions>)

totalCellStyle

SubtotalOptions.Builder totalCellStyle(TableCellStyle totalCellStyle)

The cell styling options for the subtotal cells.

Parameters:

totalCellStyle - The cell styling options for the subtotal cells.

Returns:

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

totalCellStyle

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

The cell styling options for the subtotal 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

SubtotalOptions.Builder valueCellStyle(TableCellStyle valueCellStyle)

The cell styling options for the subtotals of value cells.

Parameters:

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

Returns:

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

valueCellStyle

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

The cell styling options for the subtotals 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

SubtotalOptions.Builder metricHeaderCellStyle(TableCellStyle metricHeaderCellStyle)

The cell styling options for the subtotals of header cells.

Parameters:

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

Returns:

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

metricHeaderCellStyle

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

The cell styling options for the subtotals 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)

styleTargets

SubtotalOptions.Builder styleTargets(Collection<TableStyleTarget> styleTargets)

The style targets options for subtotals.

Parameters:

styleTargets - The style targets options for subtotals.

Returns:

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

styleTargets

SubtotalOptions.Builder styleTargets(TableStyleTarget... styleTargets)

The style targets options for subtotals.

Parameters:

styleTargets - The style targets options for subtotals.

Returns:

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

styleTargets

SubtotalOptions.Builder styleTargets(Consumer<TableStyleTarget.Builder>... styleTargets)

The style targets options for subtotals.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to styleTargets(List<TableStyleTarget>).

Parameters:

styleTargets - a consumer that will call methods on TableStyleTarget.Builder

Returns:

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

See Also:

• styleTargets(java.util.Collection<TableStyleTarget>)