Interface DashboardPublishOptions.Builder

All Superinterfaces:

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

Enclosing class:

DashboardPublishOptions

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

Method Summary

Modifier and Type	Method	Description
default DashboardPublishOptions.Builder	adHocFilteringOption(Consumer<AdHocFilteringOption.Builder> adHocFilteringOption)	Ad hoc (one-time) filtering option.
DashboardPublishOptions.Builder	adHocFilteringOption(AdHocFilteringOption adHocFilteringOption)	Ad hoc (one-time) filtering option.
default DashboardPublishOptions.Builder	dataPointDrillUpDownOption(Consumer<DataPointDrillUpDownOption.Builder> dataPointDrillUpDownOption)	The drill-down options of data points in a dashboard.
DashboardPublishOptions.Builder	dataPointDrillUpDownOption(DataPointDrillUpDownOption dataPointDrillUpDownOption)	The drill-down options of data points in a dashboard.
default DashboardPublishOptions.Builder	dataPointMenuLabelOption(Consumer<DataPointMenuLabelOption.Builder> dataPointMenuLabelOption)	The data point menu label options of a dashboard.
DashboardPublishOptions.Builder	dataPointMenuLabelOption(DataPointMenuLabelOption dataPointMenuLabelOption)	The data point menu label options of a dashboard.
default DashboardPublishOptions.Builder	dataPointTooltipOption(Consumer<DataPointTooltipOption.Builder> dataPointTooltipOption)	The data point tool tip options of a dashboard.
DashboardPublishOptions.Builder	dataPointTooltipOption(DataPointTooltipOption dataPointTooltipOption)	The data point tool tip options of a dashboard.
default DashboardPublishOptions.Builder	dataQAEnabledOption(Consumer<DataQAEnabledOption.Builder> dataQAEnabledOption)	Adds Q&A capabilities to an Quick Sight dashboard.
DashboardPublishOptions.Builder	dataQAEnabledOption(DataQAEnabledOption dataQAEnabledOption)	Adds Q&A capabilities to an Quick Sight dashboard.
default DashboardPublishOptions.Builder	dataStoriesSharingOption(Consumer<DataStoriesSharingOption.Builder> dataStoriesSharingOption)	Data stories sharing option.
DashboardPublishOptions.Builder	dataStoriesSharingOption(DataStoriesSharingOption dataStoriesSharingOption)	Data stories sharing option.
default DashboardPublishOptions.Builder	executiveSummaryOption(Consumer<ExecutiveSummaryOption.Builder> executiveSummaryOption)	Executive summary option.
DashboardPublishOptions.Builder	executiveSummaryOption(ExecutiveSummaryOption executiveSummaryOption)	Executive summary option.
default DashboardPublishOptions.Builder	exportToCSVOption(Consumer<ExportToCSVOption.Builder> exportToCSVOption)	Export to .csv option.
DashboardPublishOptions.Builder	exportToCSVOption(ExportToCSVOption exportToCSVOption)	Export to .csv option.
default DashboardPublishOptions.Builder	exportWithHiddenFieldsOption(Consumer<ExportWithHiddenFieldsOption.Builder> exportWithHiddenFieldsOption)	Determines if hidden fields are exported with a dashboard.
DashboardPublishOptions.Builder	exportWithHiddenFieldsOption(ExportWithHiddenFieldsOption exportWithHiddenFieldsOption)	Determines if hidden fields are exported with a dashboard.
default DashboardPublishOptions.Builder	quickSuiteActionsOption(Consumer<QuickSuiteActionsOption.Builder> quickSuiteActionsOption)	Determines if Actions in Amazon Quick Suite are enabled in a dashboard.
DashboardPublishOptions.Builder	quickSuiteActionsOption(QuickSuiteActionsOption quickSuiteActionsOption)	Determines if Actions in Amazon Quick Suite are enabled in a dashboard.
default DashboardPublishOptions.Builder	sheetControlsOption(Consumer<SheetControlsOption.Builder> sheetControlsOption)	Sheet controls option.
DashboardPublishOptions.Builder	sheetControlsOption(SheetControlsOption sheetControlsOption)	Sheet controls option.
default DashboardPublishOptions.Builder	sheetLayoutElementMaximizationOption(Consumer<SheetLayoutElementMaximizationOption.Builder> sheetLayoutElementMaximizationOption)	The sheet layout maximization options of a dashbaord.
DashboardPublishOptions.Builder	sheetLayoutElementMaximizationOption(SheetLayoutElementMaximizationOption sheetLayoutElementMaximizationOption)	The sheet layout maximization options of a dashbaord.
default DashboardPublishOptions.Builder	visualAxisSortOption(Consumer<VisualAxisSortOption.Builder> visualAxisSortOption)	The axis sort options of a dashboard.
DashboardPublishOptions.Builder	visualAxisSortOption(VisualAxisSortOption visualAxisSortOption)	The axis sort options of a dashboard.
default DashboardPublishOptions.Builder	visualMenuOption(Consumer<VisualMenuOption.Builder> visualMenuOption)	The menu options of a visual in a dashboard.
DashboardPublishOptions.Builder	visualMenuOption(VisualMenuOption visualMenuOption)	The menu options of a visual in a dashboard.
default DashboardPublishOptions.Builder	visualPublishOptions(Consumer<DashboardVisualPublishOptions.Builder> visualPublishOptions)	Deprecated. VisualPublishOptions property will reach its end of standard support in a future release.
DashboardPublishOptions.Builder	visualPublishOptions(DashboardVisualPublishOptions visualPublishOptions)	Deprecated. VisualPublishOptions property will reach its end of standard support in a future release.

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 Details

adHocFilteringOption

DashboardPublishOptions.Builder adHocFilteringOption(AdHocFilteringOption adHocFilteringOption)

Ad hoc (one-time) filtering option.

Parameters:

adHocFilteringOption - Ad hoc (one-time) filtering option.

Returns:

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

adHocFilteringOption

default DashboardPublishOptions.Builder adHocFilteringOption(Consumer<AdHocFilteringOption.Builder> adHocFilteringOption)

Ad hoc (one-time) filtering option.

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

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

Parameters:

adHocFilteringOption - a consumer that will call methods on AdHocFilteringOption.Builder

Returns:

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

See Also:

• adHocFilteringOption(AdHocFilteringOption)

exportToCSVOption

DashboardPublishOptions.Builder exportToCSVOption(ExportToCSVOption exportToCSVOption)

Export to .csv option.

Parameters:

exportToCSVOption - Export to .csv option.

Returns:

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

exportToCSVOption

default DashboardPublishOptions.Builder exportToCSVOption(Consumer<ExportToCSVOption.Builder> exportToCSVOption)

Export to .csv option.

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

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

Parameters:

exportToCSVOption - a consumer that will call methods on ExportToCSVOption.Builder

Returns:

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

See Also:

• exportToCSVOption(ExportToCSVOption)

sheetControlsOption

DashboardPublishOptions.Builder sheetControlsOption(SheetControlsOption sheetControlsOption)

Sheet controls option.

Parameters:

sheetControlsOption - Sheet controls option.

Returns:

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

sheetControlsOption

default DashboardPublishOptions.Builder sheetControlsOption(Consumer<SheetControlsOption.Builder> sheetControlsOption)

Sheet controls option.

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

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

Parameters:

sheetControlsOption - a consumer that will call methods on SheetControlsOption.Builder

Returns:

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

See Also:

• sheetControlsOption(SheetControlsOption)

visualPublishOptions

@Deprecated
DashboardPublishOptions.Builder visualPublishOptions(DashboardVisualPublishOptions visualPublishOptions)

Deprecated.

VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields.

The visual publish options of a visual in a dashboard.

Parameters:

visualPublishOptions - The visual publish options of a visual in a dashboard.

Returns:

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

visualPublishOptions

@Deprecated
default DashboardPublishOptions.Builder visualPublishOptions(Consumer<DashboardVisualPublishOptions.Builder> visualPublishOptions)

Deprecated.

VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields.

The visual publish options of a visual in a dashboard.

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

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

Parameters:

visualPublishOptions - a consumer that will call methods on DashboardVisualPublishOptions.Builder

Returns:

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

See Also:

• visualPublishOptions(DashboardVisualPublishOptions)

sheetLayoutElementMaximizationOption

DashboardPublishOptions.Builder sheetLayoutElementMaximizationOption(SheetLayoutElementMaximizationOption sheetLayoutElementMaximizationOption)

The sheet layout maximization options of a dashbaord.

Parameters:

sheetLayoutElementMaximizationOption - The sheet layout maximization options of a dashbaord.

Returns:

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

sheetLayoutElementMaximizationOption

default DashboardPublishOptions.Builder sheetLayoutElementMaximizationOption(Consumer<SheetLayoutElementMaximizationOption.Builder> sheetLayoutElementMaximizationOption)

The sheet layout maximization options of a dashbaord.

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

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

Parameters:

sheetLayoutElementMaximizationOption - a consumer that will call methods on SheetLayoutElementMaximizationOption.Builder

Returns:

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

See Also:

• sheetLayoutElementMaximizationOption(SheetLayoutElementMaximizationOption)

visualMenuOption

DashboardPublishOptions.Builder visualMenuOption(VisualMenuOption visualMenuOption)

The menu options of a visual in a dashboard.

Parameters:

visualMenuOption - The menu options of a visual in a dashboard.

Returns:

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

visualMenuOption

default DashboardPublishOptions.Builder visualMenuOption(Consumer<VisualMenuOption.Builder> visualMenuOption)

The menu options of a visual in a dashboard.

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

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

Parameters:

visualMenuOption - a consumer that will call methods on VisualMenuOption.Builder

Returns:

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

See Also:

• visualMenuOption(VisualMenuOption)

visualAxisSortOption

DashboardPublishOptions.Builder visualAxisSortOption(VisualAxisSortOption visualAxisSortOption)

The axis sort options of a dashboard.

Parameters:

visualAxisSortOption - The axis sort options of a dashboard.

Returns:

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

visualAxisSortOption

default DashboardPublishOptions.Builder visualAxisSortOption(Consumer<VisualAxisSortOption.Builder> visualAxisSortOption)

The axis sort options of a dashboard.

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

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

Parameters:

visualAxisSortOption - a consumer that will call methods on VisualAxisSortOption.Builder

Returns:

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

See Also:

• visualAxisSortOption(VisualAxisSortOption)

exportWithHiddenFieldsOption

DashboardPublishOptions.Builder exportWithHiddenFieldsOption(ExportWithHiddenFieldsOption exportWithHiddenFieldsOption)

Determines if hidden fields are exported with a dashboard.

Parameters:

exportWithHiddenFieldsOption - Determines if hidden fields are exported with a dashboard.

Returns:

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

exportWithHiddenFieldsOption

default DashboardPublishOptions.Builder exportWithHiddenFieldsOption(Consumer<ExportWithHiddenFieldsOption.Builder> exportWithHiddenFieldsOption)

Determines if hidden fields are exported with a dashboard.

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

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

Parameters:

exportWithHiddenFieldsOption - a consumer that will call methods on ExportWithHiddenFieldsOption.Builder

Returns:

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

See Also:

• exportWithHiddenFieldsOption(ExportWithHiddenFieldsOption)

dataPointDrillUpDownOption

DashboardPublishOptions.Builder dataPointDrillUpDownOption(DataPointDrillUpDownOption dataPointDrillUpDownOption)

The drill-down options of data points in a dashboard.

Parameters:

dataPointDrillUpDownOption - The drill-down options of data points in a dashboard.

Returns:

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

dataPointDrillUpDownOption

default DashboardPublishOptions.Builder dataPointDrillUpDownOption(Consumer<DataPointDrillUpDownOption.Builder> dataPointDrillUpDownOption)

The drill-down options of data points in a dashboard.

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

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

Parameters:

dataPointDrillUpDownOption - a consumer that will call methods on DataPointDrillUpDownOption.Builder

Returns:

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

See Also:

• dataPointDrillUpDownOption(DataPointDrillUpDownOption)

dataPointMenuLabelOption

DashboardPublishOptions.Builder dataPointMenuLabelOption(DataPointMenuLabelOption dataPointMenuLabelOption)

The data point menu label options of a dashboard.

Parameters:

dataPointMenuLabelOption - The data point menu label options of a dashboard.

Returns:

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

dataPointMenuLabelOption

default DashboardPublishOptions.Builder dataPointMenuLabelOption(Consumer<DataPointMenuLabelOption.Builder> dataPointMenuLabelOption)

The data point menu label options of a dashboard.

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

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

Parameters:

dataPointMenuLabelOption - a consumer that will call methods on DataPointMenuLabelOption.Builder

Returns:

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

See Also:

• dataPointMenuLabelOption(DataPointMenuLabelOption)

dataPointTooltipOption

DashboardPublishOptions.Builder dataPointTooltipOption(DataPointTooltipOption dataPointTooltipOption)

The data point tool tip options of a dashboard.

Parameters:

dataPointTooltipOption - The data point tool tip options of a dashboard.

Returns:

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

dataPointTooltipOption

default DashboardPublishOptions.Builder dataPointTooltipOption(Consumer<DataPointTooltipOption.Builder> dataPointTooltipOption)

The data point tool tip options of a dashboard.

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

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

Parameters:

dataPointTooltipOption - a consumer that will call methods on DataPointTooltipOption.Builder

Returns:

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

See Also:

• dataPointTooltipOption(DataPointTooltipOption)

dataQAEnabledOption

DashboardPublishOptions.Builder dataQAEnabledOption(DataQAEnabledOption dataQAEnabledOption)

Adds Q&A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

Parameters:

dataQAEnabledOption - Adds Q&A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

Returns:

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

dataQAEnabledOption

default DashboardPublishOptions.Builder dataQAEnabledOption(Consumer<DataQAEnabledOption.Builder> dataQAEnabledOption)

Adds Q&A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

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

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

Parameters:

dataQAEnabledOption - a consumer that will call methods on DataQAEnabledOption.Builder

Returns:

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

See Also:

• dataQAEnabledOption(DataQAEnabledOption)

quickSuiteActionsOption

DashboardPublishOptions.Builder quickSuiteActionsOption(QuickSuiteActionsOption quickSuiteActionsOption)

Determines if Actions in Amazon Quick Suite are enabled in a dashboard.

Parameters:

quickSuiteActionsOption - Determines if Actions in Amazon Quick Suite are enabled in a dashboard.

Returns:

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

quickSuiteActionsOption

default DashboardPublishOptions.Builder quickSuiteActionsOption(Consumer<QuickSuiteActionsOption.Builder> quickSuiteActionsOption)

Determines if Actions in Amazon Quick Suite are enabled in a dashboard.

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

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

Parameters:

quickSuiteActionsOption - a consumer that will call methods on QuickSuiteActionsOption.Builder

Returns:

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

See Also:

• quickSuiteActionsOption(QuickSuiteActionsOption)

executiveSummaryOption

DashboardPublishOptions.Builder executiveSummaryOption(ExecutiveSummaryOption executiveSummaryOption)

Executive summary option.

Parameters:

executiveSummaryOption - Executive summary option.

Returns:

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

executiveSummaryOption

default DashboardPublishOptions.Builder executiveSummaryOption(Consumer<ExecutiveSummaryOption.Builder> executiveSummaryOption)

Executive summary option.

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

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

Parameters:

executiveSummaryOption - a consumer that will call methods on ExecutiveSummaryOption.Builder

Returns:

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

See Also:

• executiveSummaryOption(ExecutiveSummaryOption)

dataStoriesSharingOption

DashboardPublishOptions.Builder dataStoriesSharingOption(DataStoriesSharingOption dataStoriesSharingOption)

Data stories sharing option.

Parameters:

dataStoriesSharingOption - Data stories sharing option.

Returns:

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

dataStoriesSharingOption

default DashboardPublishOptions.Builder dataStoriesSharingOption(Consumer<DataStoriesSharingOption.Builder> dataStoriesSharingOption)

Data stories sharing option.

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

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

Parameters:

dataStoriesSharingOption - a consumer that will call methods on DataStoriesSharingOption.Builder

Returns:

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

See Also:

• dataStoriesSharingOption(DataStoriesSharingOption)