Interface DashboardPublishOptions.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DashboardPublishOptions.Builder,
,DashboardPublishOptions> SdkBuilder<DashboardPublishOptions.Builder,
,DashboardPublishOptions> SdkPojo
- Enclosing class:
DashboardPublishOptions
-
Method Summary
Modifier and TypeMethodDescriptiondefault DashboardPublishOptions.Builder
adHocFilteringOption
(Consumer<AdHocFilteringOption.Builder> adHocFilteringOption) Ad hoc (one-time) filtering option.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.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.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.dataPointTooltipOption
(DataPointTooltipOption dataPointTooltipOption) The data point tool tip options of a dashboard.default DashboardPublishOptions.Builder
exportToCSVOption
(Consumer<ExportToCSVOption.Builder> exportToCSVOption) Export to .csv option.exportToCSVOption
(ExportToCSVOption exportToCSVOption) Export to .csv option.default DashboardPublishOptions.Builder
exportWithHiddenFieldsOption
(Consumer<ExportWithHiddenFieldsOption.Builder> exportWithHiddenFieldsOption) Determines if hidden fields are exported with a dashboard.exportWithHiddenFieldsOption
(ExportWithHiddenFieldsOption exportWithHiddenFieldsOption) Determines if hidden fields are exported with a dashboard.default DashboardPublishOptions.Builder
sheetControlsOption
(Consumer<SheetControlsOption.Builder> sheetControlsOption) Sheet controls option.sheetControlsOption
(SheetControlsOption sheetControlsOption) Sheet controls option.default DashboardPublishOptions.Builder
sheetLayoutElementMaximizationOption
(Consumer<SheetLayoutElementMaximizationOption.Builder> sheetLayoutElementMaximizationOption) The sheet layout maximization options of a dashbaord.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.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.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.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, sdkFields
-
Method Details
-
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 theAdHocFilteringOption.Builder
avoiding the need to create one manually viaAdHocFilteringOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadHocFilteringOption(AdHocFilteringOption)
.- Parameters:
adHocFilteringOption
- a consumer that will call methods onAdHocFilteringOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theExportToCSVOption.Builder
avoiding the need to create one manually viaExportToCSVOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexportToCSVOption(ExportToCSVOption)
.- Parameters:
exportToCSVOption
- a consumer that will call methods onExportToCSVOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theSheetControlsOption.Builder
avoiding the need to create one manually viaSheetControlsOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosheetControlsOption(SheetControlsOption)
.- Parameters:
sheetControlsOption
- a consumer that will call methods onSheetControlsOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDashboardVisualPublishOptions.Builder
avoiding the need to create one manually viaDashboardVisualPublishOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisualPublishOptions(DashboardVisualPublishOptions)
.- Parameters:
visualPublishOptions
- a consumer that will call methods onDashboardVisualPublishOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theSheetLayoutElementMaximizationOption.Builder
avoiding the need to create one manually viaSheetLayoutElementMaximizationOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosheetLayoutElementMaximizationOption(SheetLayoutElementMaximizationOption)
.- Parameters:
sheetLayoutElementMaximizationOption
- a consumer that will call methods onSheetLayoutElementMaximizationOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theVisualMenuOption.Builder
avoiding the need to create one manually viaVisualMenuOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisualMenuOption(VisualMenuOption)
.- Parameters:
visualMenuOption
- a consumer that will call methods onVisualMenuOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theVisualAxisSortOption.Builder
avoiding the need to create one manually viaVisualAxisSortOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovisualAxisSortOption(VisualAxisSortOption)
.- Parameters:
visualAxisSortOption
- a consumer that will call methods onVisualAxisSortOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theExportWithHiddenFieldsOption.Builder
avoiding the need to create one manually viaExportWithHiddenFieldsOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexportWithHiddenFieldsOption(ExportWithHiddenFieldsOption)
.- Parameters:
exportWithHiddenFieldsOption
- a consumer that will call methods onExportWithHiddenFieldsOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDataPointDrillUpDownOption.Builder
avoiding the need to create one manually viaDataPointDrillUpDownOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataPointDrillUpDownOption(DataPointDrillUpDownOption)
.- Parameters:
dataPointDrillUpDownOption
- a consumer that will call methods onDataPointDrillUpDownOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDataPointMenuLabelOption.Builder
avoiding the need to create one manually viaDataPointMenuLabelOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataPointMenuLabelOption(DataPointMenuLabelOption)
.- Parameters:
dataPointMenuLabelOption
- a consumer that will call methods onDataPointMenuLabelOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theDataPointTooltipOption.Builder
avoiding the need to create one manually viaDataPointTooltipOption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataPointTooltipOption(DataPointTooltipOption)
.- Parameters:
dataPointTooltipOption
- a consumer that will call methods onDataPointTooltipOption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-