@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.
Constructor and Description |
---|
SnapshotFile() |
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)
Marshalls this structured data using the given
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. |
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.
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.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.
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.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.
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.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.
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.public void setFormatType(String formatType)
The format of the snapshot file to be generated. You can choose between CSV
, Excel
, or
PDF
.
formatType
- The format of the snapshot file to be generated. You can choose between CSV
,
Excel
, or PDF
.SnapshotFileFormatType
public String getFormatType()
The format of the snapshot file to be generated. You can choose between CSV
, Excel
, or
PDF
.
CSV
,
Excel
, or PDF
.SnapshotFileFormatType
public SnapshotFile withFormatType(String formatType)
The format of the snapshot file to be generated. You can choose between CSV
, Excel
, or
PDF
.
formatType
- The format of the snapshot file to be generated. You can choose between CSV
,
Excel
, or PDF
.SnapshotFileFormatType
public SnapshotFile withFormatType(SnapshotFileFormatType formatType)
The format of the snapshot file to be generated. You can choose between CSV
, Excel
, or
PDF
.
formatType
- The format of the snapshot file to be generated. You can choose between CSV
,
Excel
, or PDF
.SnapshotFileFormatType
public String toString()
toString
in class Object
Object.toString()
public SnapshotFile clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.