software.amazon.awssdk.services.quicksight.model

Interface SnapshotFileSheetSelection.Builder

All Superinterfaces:

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

Enclosing class:

SnapshotFileSheetSelection

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

Method Summary

Modifier and Type	Method and Description
SnapshotFileSheetSelection.Builder	selectionScope(SnapshotFileSheetSelectionScope selectionScope) The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
SnapshotFileSheetSelection.Builder	selectionScope(String selectionScope) The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
SnapshotFileSheetSelection.Builder	sheetId(String sheetId) The sheet ID of the dashboard to generate the snapshot artifact from.
SnapshotFileSheetSelection.Builder	visualIds(Collection<String> visualIds) A structure that lists the IDs of the visuals in the selected sheet.
SnapshotFileSheetSelection.Builder	visualIds(String... visualIds) A structure that lists the IDs of the visuals in the selected sheet.

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

sheetId

SnapshotFileSheetSelection.Builder sheetId(String sheetId)

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

Parameters:

sheetId - The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

Returns:

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

selectionScope

SnapshotFileSheetSelection.Builder selectionScope(String selectionScope)

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

Parameters:

selectionScope - The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

Returns:

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

See Also:

SnapshotFileSheetSelectionScope, SnapshotFileSheetSelectionScope

selectionScope

SnapshotFileSheetSelection.Builder selectionScope(SnapshotFileSheetSelectionScope selectionScope)

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

Parameters:

selectionScope - The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

• ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.

• SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.

Returns:

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

See Also:

SnapshotFileSheetSelectionScope, SnapshotFileSheetSelectionScope

visualIds

SnapshotFileSheetSelection.Builder visualIds(Collection<String> visualIds)

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Parameters:

visualIds - A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Returns:

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

visualIds

SnapshotFileSheetSelection.Builder visualIds(String... visualIds)

A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Parameters:

visualIds - A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.

Returns:

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