Package software.amazon.awssdk.services.quicksight.model

Class SnapshotFileSheetSelection

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SnapshotFileSheetSelection

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SnapshotFileSheetSelection.Builder,SnapshotFileSheetSelection>

@Generated("software.amazon.awssdk:codegen")
public final class SnapshotFileSheetSelection
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SnapshotFileSheetSelection.Builder,SnapshotFileSheetSelection>

A structure that contains information that identifies the snapshot that needs to be generated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnapshotFileSheetSelection.Builder

Method Summary

Modifier and Type	Method	Description
static SnapshotFileSheetSelection.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVisualIds()	For responses, this returns true if the service returned a value for the VisualIds property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SnapshotFileSheetSelectionScope	selectionScope()	The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
String	selectionScopeAsString()	The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of.
static Class<? extends SnapshotFileSheetSelection.Builder>	serializableBuilderClass()
String	sheetId()	The sheet ID of the dashboard to generate the snapshot artifact from.
SnapshotFileSheetSelection.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	visualIds()	A structure that lists the IDs of the visuals in the selected sheet.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sheetId

public final 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.

Returns:

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

selectionScope

public final 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.

If the service returns an enum value that is not available in the current SDK version, selectionScope will return SnapshotFileSheetSelectionScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectionScopeAsString().

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 or Excel workbook.

See Also:

SnapshotFileSheetSelectionScope

selectionScopeAsString

public final String selectionScopeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, selectionScope will return SnapshotFileSheetSelectionScope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from selectionScopeAsString().

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 or Excel workbook.

See Also:

SnapshotFileSheetSelectionScope

hasVisualIds

public final boolean hasVisualIds()

For responses, this returns true if the service returned a value for the VisualIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

visualIds

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVisualIds() method.

Returns:

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.

toBuilder

public SnapshotFileSheetSelection.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotFileSheetSelection.Builder,SnapshotFileSheetSelection>

builder

public static SnapshotFileSheetSelection.Builder builder()

serializableBuilderClass

public static Class<? extends SnapshotFileSheetSelection.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo