Package com.seeq.model
Class ExportItemsV1
java.lang.Object
com.seeq.model.ExportItemsV1
ExportItemsV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddItemsItem
(ExportItemV1 itemsItem) autoupdateTimeRange
(Boolean autoupdateTimeRange) capsuleTime
(Boolean capsuleTime) boolean
exportCapsules
(Boolean exportCapsules) exportName
(String exportName) Boolean indicating if the time range for export should be updated to 'now' when the export is started.True if capsule time is displayed, false otherwise.True if capsule time is displayed, false otherwise.True if the capsule table should be exported, false otherwise.The desired name for the export.The desired export output format.Boolean indicating whether the data grid should be included.The origin timestamp for gridding.The desired sample period for the export.getItems()
A list of Series and Capsules to be exportedTrue if the original sample period should be used.The ID of the workbook to which this item will be scoped.Boolean indicating whether the summary statistics should be included.The ID of an asset to swap in.The ID of an asset to swap out.The IANA time zone name for all timestamps in this export.The worksheet link of the workbook to be added to the export.gridEnabled
(Boolean gridEnabled) gridOrigin
(String gridOrigin) int
hashCode()
items
(List<ExportItemV1> items) originalTimestampsEnabled
(Boolean originalTimestampsEnabled) void
setAutoupdateTimeRange
(Boolean autoupdateTimeRange) void
setCapsuleTime
(Boolean capsuleTime) void
setChainView
(Boolean chainView) void
setExportCapsules
(Boolean exportCapsules) void
setExportName
(String exportName) void
void
setGridEnabled
(Boolean gridEnabled) void
setGridOrigin
(String gridOrigin) void
setGridSize
(String gridSize) void
setItems
(List<ExportItemV1> items) void
setOriginalTimestampsEnabled
(Boolean originalTimestampsEnabled) void
setScopedTo
(String scopedTo) void
setStatisticsEnabled
(Boolean statisticsEnabled) void
void
setSwapOut
(String swapOut) void
setTimeZone
(String timeZone) void
setWorksheetLink
(String worksheetLink) statisticsEnabled
(Boolean statisticsEnabled) toString()
worksheetLink
(String worksheetLink)
-
Constructor Details
-
ExportItemsV1
public ExportItemsV1()
-
-
Method Details
-
autoupdateTimeRange
-
getAutoupdateTimeRange
Boolean indicating if the time range for export should be updated to 'now' when the export is started.- Returns:
- autoupdateTimeRange
-
setAutoupdateTimeRange
-
capsuleTime
-
getCapsuleTime
True if capsule time is displayed, false otherwise.- Returns:
- capsuleTime
-
setCapsuleTime
-
chainView
-
getChainView
True if capsule time is displayed, false otherwise.- Returns:
- chainView
-
setChainView
-
exportCapsules
-
getExportCapsules
True if the capsule table should be exported, false otherwise.- Returns:
- exportCapsules
-
setExportCapsules
-
exportName
-
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
-
format
-
getFormat
The desired export output format. Currently only 'xlsx' and 'odata' are supported.- Returns:
- format
-
setFormat
-
gridEnabled
-
getGridEnabled
Boolean indicating whether the data grid should be included.- Returns:
- gridEnabled
-
setGridEnabled
-
gridOrigin
-
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
-
gridSize
-
getGridSize
The desired sample period for the export. An automatic grid size is used when gridSize is set to 'false'.- Returns:
- gridSize
-
setGridSize
-
items
-
addItemsItem
-
getItems
A list of Series and Capsules to be exported- Returns:
- items
-
setItems
-
originalTimestampsEnabled
-
getOriginalTimestampsEnabled
True if the original sample period should be used. A manual or automatic grid size may be used when false.- Returns:
- originalTimestampsEnabled
-
setOriginalTimestampsEnabled
-
scopedTo
-
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
-
statisticsEnabled
-
getStatisticsEnabled
Boolean indicating whether the summary statistics should be included. This flag only applies to Excel exports.- Returns:
- statisticsEnabled
-
setStatisticsEnabled
-
swapIn
-
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
-
swapOut
-
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
-
timeZone
-
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
-
worksheetLink
-
getWorksheetLink
The worksheet link of the workbook to be added to the export.- Returns:
- worksheetLink
-
setWorksheetLink
-
equals
-
hashCode
public int hashCode() -
toString
-