@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SnapshotFileSheetSelection extends Object implements Serializable, Cloneable, StructuredPojo
A structure that contains information that identifies the snapshot that needs to be generated.
Constructor and Description |
---|
SnapshotFileSheetSelection() |
Modifier and Type | Method and Description |
---|---|
SnapshotFileSheetSelection |
clone() |
boolean |
equals(Object obj) |
String |
getSelectionScope()
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
|
String |
getSheetId()
The sheet ID of the dashboard to generate the snapshot artifact from.
|
List<String> |
getVisualIds()
A structure that lists the IDs of the visuals in the selected sheet.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setSelectionScope(String selectionScope)
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
|
void |
setSheetId(String sheetId)
The sheet ID of the dashboard to generate the snapshot artifact from.
|
void |
setVisualIds(Collection<String> visualIds)
A structure that lists the IDs of the visuals in the selected sheet.
|
String |
toString()
Returns a string representation of this object.
|
SnapshotFileSheetSelection |
withSelectionScope(SnapshotFileSheetSelectionScope selectionScope)
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
|
SnapshotFileSheetSelection |
withSelectionScope(String selectionScope)
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
|
SnapshotFileSheetSelection |
withSheetId(String sheetId)
The sheet ID of the dashboard to generate the snapshot artifact from.
|
SnapshotFileSheetSelection |
withVisualIds(Collection<String> visualIds)
A structure that lists the IDs of the visuals in the selected sheet.
|
SnapshotFileSheetSelection |
withVisualIds(String... visualIds)
A structure that lists the IDs of the visuals in the selected sheet.
|
public void setSheetId(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.
sheetId
- The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV,
Excel, and PDF format types.public String getSheetId()
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
public SnapshotFileSheetSelection withSheetId(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.
sheetId
- The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV,
Excel, and PDF format types.public void setSelectionScope(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.
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.
SnapshotFileSheetSelectionScope
public String getSelectionScope()
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.
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.
SnapshotFileSheetSelectionScope
public SnapshotFileSheetSelection withSelectionScope(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.
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.
SnapshotFileSheetSelectionScope
public SnapshotFileSheetSelection withSelectionScope(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.
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.
SnapshotFileSheetSelectionScope
public List<String> getVisualIds()
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.
public void setVisualIds(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.
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.public SnapshotFileSheetSelection withVisualIds(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.
NOTE: This method appends the values to the existing list (if any). Use
setVisualIds(java.util.Collection)
or withVisualIds(java.util.Collection)
if you want to
override the existing values.
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.public SnapshotFileSheetSelection withVisualIds(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.
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.public String toString()
toString
in class Object
Object.toString()
public SnapshotFileSheetSelection clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.