com.amazonaws.services.quicksight.model

Class SnapshotFile

java.lang.Object

com.amazonaws.services.quicksight.model.SnapshotFile

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SnapshotFile
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SnapshotFile()

Method Summary

Modifier and Type	Method and Description
SnapshotFile	clone()
boolean	equals(Object obj)
String	getFormatType() The format of the snapshot file to be generated.
List<SnapshotFileSheetSelection>	getSheetSelections() A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setFormatType(String formatType) The format of the snapshot file to be generated.
void	setSheetSelections(Collection<SnapshotFileSheetSelection> sheetSelections) A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported.
String	toString() Returns a string representation of this object.
SnapshotFile	withFormatType(SnapshotFileFormatType formatType) The format of the snapshot file to be generated.
SnapshotFile	withFormatType(String formatType) The format of the snapshot file to be generated.
SnapshotFile	withSheetSelections(Collection<SnapshotFileSheetSelection> sheetSelections) A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported.
SnapshotFile	withSheetSelections(SnapshotFileSheetSelection... sheetSelections) A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotFile

public SnapshotFile()

Method Detail

getSheetSelections

public List<SnapshotFileSheetSelection> getSheetSelections()

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.

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.

setSheetSelections

public void setSheetSelections(Collection<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.

Parameters:

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.

withSheetSelections

public SnapshotFile withSheetSelections(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.

NOTE: This method appends the values to the existing list (if any). Use setSheetSelections(java.util.Collection) or withSheetSelections(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

withSheetSelections

public SnapshotFile withSheetSelections(Collection<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.

Parameters:

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.

Returns:

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

setFormatType

public void setFormatType(String formatType)

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

Parameters:

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

See Also:

SnapshotFileFormatType

getFormatType

public String getFormatType()

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

Returns:

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

See Also:

SnapshotFileFormatType

withFormatType

public SnapshotFile withFormatType(String formatType)

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

Parameters:

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

Returns:

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

See Also:

SnapshotFileFormatType

withFormatType

public SnapshotFile withFormatType(SnapshotFileFormatType formatType)

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

Parameters:

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

Returns:

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

See Also:

SnapshotFileFormatType

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 SnapshotFile clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo