Interface SnapshotFile.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SnapshotFile.Builder,SnapshotFile>, SdkBuilder<SnapshotFile.Builder,SnapshotFile>, SdkPojo
Enclosing class:
SnapshotFile
@Mutable @NotThreadSafe public static interface SnapshotFile.Builder extends SdkPojo, CopyableBuilder<SnapshotFile.Builder,SnapshotFile>

  • Method Details

    • sheetSelections

      SnapshotFile.Builder sheetSelections(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.

    • sheetSelections

      SnapshotFile.Builder sheetSelections(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.

    • sheetSelections

      SnapshotFile.Builder sheetSelections(Consumer<SnapshotFileSheetSelection.Builder>... 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.

      This is a convenience method that creates an instance of the SnapshotFileSheetSelection.Builder avoiding the need to create one manually via SnapshotFileSheetSelection.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sheetSelections(List<SnapshotFileSheetSelection>).

      Parameters:
      sheetSelections - a consumer that will call methods on SnapshotFileSheetSelection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • formatType

      SnapshotFile.Builder formatType(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:

    • formatType

      SnapshotFile.Builder formatType(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: