Class ExportItemsV1

java.lang.Object
com.seeq.model.ExportItemsV1

public class ExportItemsV1 extends Object
ExportItemsV1
  • Constructor Details

    • ExportItemsV1

      public ExportItemsV1()
  • Method Details

    • autoupdateTimeRange

      public ExportItemsV1 autoupdateTimeRange(Boolean autoupdateTimeRange)
    • getAutoupdateTimeRange

      public Boolean getAutoupdateTimeRange()
      Boolean indicating if the time range for export should be updated to 'now' when the export is started.
      Returns:
      autoupdateTimeRange
    • setAutoupdateTimeRange

      public void setAutoupdateTimeRange(Boolean autoupdateTimeRange)
    • capsuleTime

      public ExportItemsV1 capsuleTime(Boolean capsuleTime)
    • getCapsuleTime

      public Boolean getCapsuleTime()
      True if capsule time is displayed, false otherwise.
      Returns:
      capsuleTime
    • setCapsuleTime

      public void setCapsuleTime(Boolean capsuleTime)
    • chainView

      public ExportItemsV1 chainView(Boolean chainView)
    • getChainView

      public Boolean getChainView()
      True if capsule time is displayed, false otherwise.
      Returns:
      chainView
    • setChainView

      public void setChainView(Boolean chainView)
    • exportCapsules

      public ExportItemsV1 exportCapsules(Boolean exportCapsules)
    • getExportCapsules

      public Boolean getExportCapsules()
      True if the capsule table should be exported, false otherwise.
      Returns:
      exportCapsules
    • setExportCapsules

      public void setExportCapsules(Boolean exportCapsules)
    • exportName

      public ExportItemsV1 exportName(String exportName)
    • getExportName

      public String getExportName()
      The desired name for the export. This name is used to create an OData endpoint for accessing the data being exported.
      Returns:
      exportName
    • setExportName

      public void setExportName(String exportName)
    • format

      public ExportItemsV1 format(String format)
    • getFormat

      public String getFormat()
      The desired export output format. Currently only 'xlsx' and 'odata' are supported.
      Returns:
      format
    • setFormat

      public void setFormat(String format)
    • gridEnabled

      public ExportItemsV1 gridEnabled(Boolean gridEnabled)
    • getGridEnabled

      public Boolean getGridEnabled()
      Boolean indicating whether the data grid should be included.
      Returns:
      gridEnabled
    • setGridEnabled

      public void setGridEnabled(Boolean gridEnabled)
    • gridOrigin

      public ExportItemsV1 gridOrigin(String gridOrigin)
    • getGridOrigin

      public String getGridOrigin()
      The origin timestamp for gridding. If not specified, the origin generally defaults to basic time alignment conventions. See the resample() operator's documentation for full details.
      Returns:
      gridOrigin
    • setGridOrigin

      public void setGridOrigin(String gridOrigin)
    • gridSize

      public ExportItemsV1 gridSize(String gridSize)
    • getGridSize

      public String getGridSize()
      The desired sample period for the export. An automatic grid size is used when gridSize is set to 'false'.
      Returns:
      gridSize
    • setGridSize

      public void setGridSize(String gridSize)
    • items

      public ExportItemsV1 items(List<ExportItemV1> items)
    • addItemsItem

      public ExportItemsV1 addItemsItem(ExportItemV1 itemsItem)
    • getItems

      public List<ExportItemV1> getItems()
      A list of Series and Capsules to be exported
      Returns:
      items
    • setItems

      public void setItems(List<ExportItemV1> items)
    • originalTimestampsEnabled

      public ExportItemsV1 originalTimestampsEnabled(Boolean originalTimestampsEnabled)
    • getOriginalTimestampsEnabled

      public Boolean getOriginalTimestampsEnabled()
      True if the original sample period should be used. A manual or automatic grid size may be used when false.
      Returns:
      originalTimestampsEnabled
    • setOriginalTimestampsEnabled

      public void setOriginalTimestampsEnabled(Boolean originalTimestampsEnabled)
    • scopedTo

      public ExportItemsV1 scopedTo(String scopedTo)
    • getScopedTo

      public String getScopedTo()
      The ID of the workbook to which this item will be scoped. Only valid for OData exports. If not provided, the export will have global scope.
      Returns:
      scopedTo
    • setScopedTo

      public void setScopedTo(String scopedTo)
    • statisticsEnabled

      public ExportItemsV1 statisticsEnabled(Boolean statisticsEnabled)
    • getStatisticsEnabled

      public Boolean getStatisticsEnabled()
      Boolean indicating whether the summary statistics should be included. This flag only applies to Excel exports.
      Returns:
      statisticsEnabled
    • setStatisticsEnabled

      public void setStatisticsEnabled(Boolean statisticsEnabled)
    • swapIn

      public ExportItemsV1 swapIn(String swapIn)
    • getSwapIn

      public String getSwapIn()
      The ID of an asset to swap in. Any parameters in the formula that are named the same in both the swapIn and swapOut assets will be swapped.
      Returns:
      swapIn
    • setSwapIn

      public void setSwapIn(String swapIn)
    • swapOut

      public ExportItemsV1 swapOut(String swapOut)
    • getSwapOut

      public String getSwapOut()
      The ID of an asset to swap out. Any parameters in the formula that are named the same in both the swapIn and swapOut assets will be swapped.
      Returns:
      swapOut
    • setSwapOut

      public void setSwapOut(String swapOut)
    • timeZone

      public ExportItemsV1 timeZone(String timeZone)
    • getTimeZone

      public String getTimeZone()
      The IANA time zone name for all timestamps in this export. If not specified, the server's time zone will be used.
      Returns:
      timeZone
    • setTimeZone

      public void setTimeZone(String timeZone)
    • worksheetLink

      public ExportItemsV1 worksheetLink(String worksheetLink)
    • getWorksheetLink

      public String getWorksheetLink()
      The worksheet link of the workbook to be added to the export.
      Returns:
      worksheetLink
    • setWorksheetLink

      public void setWorksheetLink(String worksheetLink)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object