SnapshotFileSheetSelection (AWS Java SDK for Amazon QuickSight 1.12.531 API)

java.lang.Object
- com.amazonaws.services.quicksight.model.SnapshotFileSheetSelection

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SnapshotFileSheetSelection()

Constructors
Constructor and Description
`SnapshotFileSheetSelection()`

Method Summary

All Methods Instance Methods Concrete Methods
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 list of visual IDs that are located in the selected sheet.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller 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 list of visual IDs that are located 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 list of visual IDs that are located in the selected sheet.
`SnapshotFileSheetSelection`	`withVisualIds(String... visualIds)` A list of visual IDs that are located in the selected sheet.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SnapshotFileSheetSelection
```
public SnapshotFileSheetSelection()
```
- Method Detail
  - setSheetId
```
public void setSheetId(String sheetId)
```
    The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
    
    Parameters:
    
    sheetId - The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
  - getSheetId
```
public String getSheetId()
```
    The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
    
    Returns:
    
    The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
  - withSheetId
```
public SnapshotFileSheetSelection withSheetId(String sheetId)
```
    The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
    
    Parameters:
    
    sheetId - The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSelectionScope
```
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.
    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.
    See Also:
    
    SnapshotFileSheetSelectionScope
  - getSelectionScope
```
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.
    Returns:
    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.
    See Also:
    
    SnapshotFileSheetSelectionScope
  - withSelectionScope
```
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.
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SnapshotFileSheetSelectionScope
  - withSelectionScope
```
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.
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SnapshotFileSheetSelectionScope
  - getVisualIds
```
public List<String> getVisualIds()
```
    A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
    
    Returns:
    
    A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
  - setVisualIds
```
public void setVisualIds(Collection<String> visualIds)
```
    A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
    
    Parameters:
    
    visualIds - A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
  - withVisualIds
```
public SnapshotFileSheetSelection withVisualIds(String... visualIds)
```
    A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
    
    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.
    
    Parameters:
    
    visualIds - A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVisualIds
```
public SnapshotFileSheetSelection withVisualIds(Collection<String> visualIds)
```
    A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
    
    Parameters:
    
    visualIds - A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SnapshotFileSheetSelection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class SnapshotFileSheetSelection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SnapshotFileSheetSelection

Method Detail

setSheetId

getSheetId

withSheetId

setSelectionScope

getSelectionScope

withSelectionScope

withSelectionScope

getVisualIds

setVisualIds

withVisualIds

withVisualIds

toString

equals

hashCode

clone

marshall