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

Class SnapshotFile

java.lang.Object

software.amazon.awssdk.services.quicksight.model.SnapshotFile

All Implemented Interfaces:

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

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

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnapshotFile.Builder

Method Summary

Modifier and Type	Method	Description
static SnapshotFile.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SnapshotFileFormatType	formatType()	The format of the snapshot file to be generated.
String	formatTypeAsString()	The format of the snapshot file to be generated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSheetSelections()	For responses, this returns true if the service returned a value for the SheetSelections property.
List<SdkField<?>>	sdkFields()
static Class<? extends SnapshotFile.Builder>	serializableBuilderClass()
List<SnapshotFileSheetSelection>	sheetSelections()	A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported.
SnapshotFile.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasSheetSelections

public final boolean hasSheetSelections()

For responses, this returns true if the service returned a value for the SheetSelections 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.

sheetSelections

public final List<SnapshotFileSheetSelection> sheetSelections()

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

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 hasSheetSelections() method.

Returns:

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

formatType

public final SnapshotFileFormatType formatType()

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

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

Returns:

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

See Also:

SnapshotFileFormatType

formatTypeAsString

public final String formatTypeAsString()

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

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

Returns:

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

See Also:

SnapshotFileFormatType

toBuilder

public SnapshotFile.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SnapshotFile.Builder,SnapshotFile>

builder

public static SnapshotFile.Builder builder()

serializableBuilderClass

public static Class<? extends SnapshotFile.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