trait QueryFacade extends ServiceFacadeWithDatabase with ServiceFacade[QueryFacade]
The interface for the external API of the Query Service.
The Query Service is responsible for the management of configuration related to dashboards and presentations, and it also handles live queries against source and pipeline result data, whether previewing unsaved changes to a dashboard or presentation, or submitting a SQL request.
- Alphabetic
- By Inheritance
- QueryFacade
- ServiceFacade
- ServiceFacadeWithDatabase
- ServiceFacadeBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract val environment: String
- Definition Classes
- ServiceFacadeBase
- abstract def getCacheStatistics: Array[CacheStatistics]
- Definition Classes
- ServiceFacadeBase
- abstract def getColumnsForSql(sql: String, tag: String, dateFrom: LocalDateTime, dateTo: LocalDateTime, liveSources: Array[String] = Array()): Array[TableColumn]
gets the schema for a SQL query against the underlying result data with given parameters.
gets the schema for a SQL query against the underlying result data with given parameters.
- sql
The SQL string to run (see Apache Spark SQL docs for specifics on dialect).
- tag
The tag to use when loading result data.
- dateFrom
The lower bound on the collection on timeline dates to fetch for.
- dateTo
The upper bound on the collection on timeline dates to fetch for.
- liveSources
A list of ID's for sources to live refresh for use in the query, even if not directly used.
- abstract def getContentForDisplayForComponentForDashboard(id: String, componentId: String, displayId: String, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX): Array[DashboardDisplayContentInfo]
Gets the underlying persisted data for a specific display in a given dashboard, component and time interval.
Gets the underlying persisted data for a specific display in a given dashboard, component and time interval.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- displayId
The unique id of the display in the component.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- abstract def getCountForSearch(search: SearchContent, tag: String, date: LocalDateTime): Long
Gets the count of the result data set resulting from a given search definition run on a given date.
Gets the count of the result data set resulting from a given search definition run on a given date.
- search
The search definition.
- tag
The tag in the dashboards to fetch for.
- date
The date to use when running the search.
- abstract def getDashboard(id: String): DashboardInfo
Gets the most recent version of a specific dashboard.
Gets the most recent version of a specific dashboard.
- id
The unique id of the dashboard.
- abstract def getDashboardDisplayTrends(): Array[DashboardDisplayTrendsInfo]
Gets information on all display trends in all dashboards.
Gets information on all display trends in all dashboards. Trend and outlier data is only build for displays in DashboardOptions.MONITORED_DISPLAYS.
- abstract def getDashboardSummaries(): Array[DashboardSummary]
Gets a summary of the update information for each dashboard.
- abstract def getDashboards(includeDeleted: Boolean = false): Array[DashboardInfo]
Gets the most recent version of each dashboard, including deleted.
Gets the most recent version of each dashboard, including deleted.
- includeDeleted
Whether to include deleted dashboards.
- abstract def getDatabase(outputStream: OutputStream): Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def getDatabasePath: String
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def getDisplayTrendsForDashboard(id: String): Array[DashboardDisplayTrendsInfo]
Gets information on all display trends and outliers for a specific dashboard.
Gets information on all display trends and outliers for a specific dashboard. Trend and outlier data is only build for displays in DashboardOptions.MONITORED_DISPLAYS.
- id
The unique id of the dashboard.
- abstract def getDisplayTrendsForDisplayForComponentForDashboard(id: String, componentId: String, displayId: String): DashboardDisplayTrendsInfo
Gets information on all display trends and outliers for a specific dashboard, component and display.
Gets information on all display trends and outliers for a specific dashboard, component and display. Trend and outlier data is only build for displays in DashboardOptions.MONITORED_DISPLAYS.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- displayId
The unique id of the display in the component.
- abstract def getFile(path: String, outputStream: OutputStream): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def getLatestMetadataForComponentForDashboard(id: String, componentId: String, tag: String, date: LocalDateTime): DashboardComponentMetadata
Gets the most recently available column metadata for the output data set for a specific component and dashboard relative to a given date.
Gets the most recently available column metadata for the output data set for a specific component and dashboard relative to a given date.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- tag
The tag in the dashboard to fetch for.
- date
The upper bound on the collection on timeline dates to consider.
- abstract def getLatestOutputForComponentForDashboard(id: String, componentId: String, outputStream: OutputStream, tag: String, locale: Option[String] = None, limit: Option[Int] = None, maxDecimals: Option[Int] = None, includeTimestamp: Option[Boolean] = None, serializeAsJson: Option[Boolean] = None): Unit
Gets the latest output data set for a specific component and dashboard with given parameters.
Gets the latest output data set for a specific component and dashboard with given parameters.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- limit
A limit on the number of data rows to write.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- serializeAsJson
Serialize the output as JSON array of arrays or as a csv with a ';' as the separator in either case the first row/line is the header.
- abstract def getLogLevel: String
- Definition Classes
- ServiceFacadeBase
- abstract def getMetadataForComponentForDashboard(id: String, componentId: String, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array()): DashboardComponentMetadata
Gets the column metadata for the output data set for a specific component and dashboard with given parameters.
Gets the column metadata for the output data set for a specific component and dashboard with given parameters.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- abstract def getOutputForComponentForDashboard(id: String, componentId: String, outputStream: OutputStream, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array(), locale: String = getOutputDefaultLocale, limit: Option[Int] = None, maxDecimals: Int = getOutputDefaultMaxDecimals, includeTimestamp: Boolean = true, serializeAsJson: Boolean = false): Unit
Gets the output data set for a specific component and dashboard with given parameters.
Gets the output data set for a specific component and dashboard with given parameters.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- limit
A limit on the number of data rows to write.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- serializeAsJson
Serialize the output as JSON array of arrays or as a csv with a ';' as the separator in either case the first row/line is the header.
- abstract def getOutputForDisplayForComponentForDashboard(id: String, componentId: String, displayId: String, outputStream: OutputStream, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array(), locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Gets the output data set for a specific display, component and dashboard with given parameters.
Gets the output data set for a specific display, component and dashboard with given parameters.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- displayId
The unique id of the display in the component.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def getOutputForDisplayForPresentation(id: String, displayId: String, outputStream: OutputStream, tag: String, date: LocalDateTime, locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Gets the output data set for a specific display and presentation with given parameters.
Gets the output data set for a specific display and presentation with given parameters.
- id
The unique id of the presentation.
- displayId
The unique id of the display in the presentation.
- outputStream
The stream data is written to.
- tag
The tag in the presentation to fetch for.
- date
The date in the presentation to fetch for.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def getPerformanceMetrics: PerformanceMetrics
- Definition Classes
- ServiceFacadeBase
- abstract def getPipelineSnapshotsForComponentForDashboard(id: String, componentId: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX): Array[PipelineSnapshotInfo]
Gets all pipeline snapshots loaded by a given dashboard and component in a given time interval.
Gets all pipeline snapshots loaded by a given dashboard and component in a given time interval.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- abstract def getPresentation(id: String): PresentationInfo
Gets the most recent version of a specific presentation.
Gets the most recent version of a specific presentation.
- id
The unique id of the presentation.
- abstract def getPresentationDisplayTrends(): Array[DashboardDisplayTrendsInfo]
Gets information on all display trends in all presentations.
Gets information on all display trends in all presentations. Trend and outlier data is only build for displays in PresentationOptions.MONITORED_DISPLAYS.
- abstract def getPresentationSummaries(): Array[PresentationSummary]
Gets a summary of the update information for each presentation.
- abstract def getPresentations(includeDeleted: Boolean = false): Array[PresentationInfo]
Gets the most recent version of each presentation, including deleted.
Gets the most recent version of each presentation, including deleted.
- includeDeleted
Whether to include deleted presentations.
- abstract def getResultKeysForSql(sql: String, tag: String): ResultKeys
Gets the result data identifiers loaded by a given SQL statement run with a given tag.
Gets the result data identifiers loaded by a given SQL statement run with a given tag.
- sql
The SQL statement to analyze.
- tag
The tag to use. Untagged results may be included if no matching tag exists.
- abstract def getSourceSnapshotsForComponentForDashboard(id: String, componentId: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX): Array[SourceSnapshotInfo]
Gets all source snapshots loaded by a given dashboard and component in a given time interval.
Gets all source snapshots loaded by a given dashboard and component in a given time interval.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- abstract def getSqlUsers: Array[String]
Gets the unique ids of the users currently running queries.
- abstract def getStateForComponentForDashboard(id: String, componentId: String, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX): DashboardComponentState
Gets the state summary of a specific component and dashboard when considering only a limited time period.
Gets the state summary of a specific component and dashboard when considering only a limited time period.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- abstract def getStatesForComponentForDashboard(id: String, componentId: String, states: Set[String]): Array[DashboardStateInfo]
Gets all dashboard states for a specific component and dashboard when only a restricted set of job states.
Gets all dashboard states for a specific component and dashboard when only a restricted set of job states.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- states
The JobStates to include in the result
- abstract def getStatisticsForComponentForDashboard(id: String, componentId: String, outputStream: OutputStream, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array(), locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals, includeTimestamp: Boolean = true): Unit
Gets the statistics on the output data set for a specific component and dashboard with given parameters.
Gets the statistics on the output data set for a specific component and dashboard with given parameters.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- abstract def getStatisticsForSearch(search: SearchContent, outputStream: OutputStream, tag: String, date: LocalDateTime, locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Gets the general statistics of the result data set resulting from a given search definition run on a given date.
Gets the general statistics of the result data set resulting from a given search definition run on a given date.
- search
The search definition.
- outputStream
The stream data is written to.
- tag
The tag in the dashboards to fetch for.
- date
The date to use when running the search.
- abstract def getSummaryForDashboard(id: String): DashboardSummary
Gets a summary of the update information for a specific dashboard.
Gets a summary of the update information for a specific dashboard.
- id
The unique id of the dashboard.
- abstract def getSummaryForPresentation(id: String): PresentationSummary
Gets a summary of the update information for a specific presentation.
Gets a summary of the update information for a specific presentation.
- id
The unique id of the presentation.
- abstract def getTagsForComponentForDashboard(id: String, componentId: String): Array[String]
Gets the tags with persisted data available for a specific dashboard and component.
Gets the tags with persisted data available for a specific dashboard and component.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- abstract def getTagsForDashboard(id: String): Array[String]
Gets the tags with persisted data available for a specific dashboard.
Gets the tags with persisted data available for a specific dashboard.
- id
The unique id of the dashboard.
- abstract def getTimelineForComponentForDashboard(id: String, componentId: String, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) with persisted data available for a specific dashboard and component.
Gets the timeline of dates (sorted ascending) with persisted data available for a specific dashboard and component.
- id
The unique id of the dashboard.
- componentId
The unique id of the component in the dashboard.
- tag
The tag in the dashboard to fetch for.
- abstract def getTimelineForDashboard(id: String, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) with persisted data available for a specific dashboard.
Gets the timeline of dates (sorted ascending) with persisted data available for a specific dashboard.
- id
The unique id of the dashboard.
- tag
The tag in the dashboard to fetch for.
- abstract def getTimelineForPageForPresentation(id: String, pageId: String, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) with persisted data available for a specific presentation and page.
Gets the timeline of dates (sorted ascending) with persisted data available for a specific presentation and page.
- id
The unique id of the presentation.
- pageId
The unique id of the page in the presentation.
- tag
The tag in the presentation to fetch for.
- abstract def getTimelineForPresentation(id: String, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) with persisted data available for a specific presentation.
Gets the timeline of dates (sorted ascending) with persisted data available for a specific presentation.
- id
The unique id of the presentation.
- tag
The tag in the presentation to fetch for.
- abstract def getVersion: String
- Definition Classes
- ServiceFacadeBase
- abstract def getVersionForDashboard(id: String, version: UUID): DashboardInfo
Gets a specific version of a specific dashboard.
Gets a specific version of a specific dashboard.
- id
The unique id of the dashboard.
- version
The
UUIDfor the version.
- abstract def getVersionForPresentation(id: String, version: UUID): PresentationInfo
Gets a specific version of a specific presentation.
Gets a specific version of a specific presentation.
- id
The unique id of the presentation.
- version
The
UUIDfor the version.
- abstract def getVersionsForDashboard(id: String): Array[DashboardInfo]
Gets all versions of a specific dashboard.
Gets all versions of a specific dashboard.
- id
The unique id of the dashboard.
- abstract def getVersionsForPresentation(id: String): Array[PresentationInfo]
Gets all versions of a specific presentation.
Gets all versions of a specific presentation.
- id
The unique id of the presentation.
- abstract def isReady: Boolean
- Definition Classes
- ServiceFacadeBase
- abstract def postAnalyzeOriginsForSource(description: SourceDescription): Array[String]
Gets identifiers for the origins of a given source description.
Gets identifiers for the origins of a given source description. For database queries this would be the tables referenced by the query, while for an internal file it would be the file id.
- description
The source description.
- abstract def postCachePurge(id: Option[String]): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def postCancelSearch(): Unit
Cancels all currently running searches started by the caller.
- abstract def postCancelSql(): Unit
Cancels all currently running SQL queries started by the caller.
- abstract def postDashboard(content: DashboardContent): Unit
Creates a new version of a dashboard with the specific content.
Creates a new version of a dashboard with the specific content.
- content
The content of the new version.
- abstract def postDatabaseBackup(encryptionEnabled: Option[Boolean], encryptionMasterKeyIdentifier: Option[String], outputRepository: String = EnvironmentVariables.output_repository): Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def postDeleteForDashboard(id: String): Unit
Marks a specific dashboard as deleted.
Marks a specific dashboard as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the dashboard.
- abstract def postDeleteForPresentation(id: String): Unit
Marks a specific presentation as deleted.
Marks a specific presentation as deleted. Technically a copy of the most recent version is created with the deletion time set.
- id
The unique id of the presentation.
- abstract def postDeleteVersionForPresentation(id: String, version: UUID): Unit
Permanently deletes a specific version of a presentation.
Permanently deletes a specific version of a presentation.
- id
The unique id of the presentation.
- version
The
UUIDfor the version.
- abstract def postDisplayContentForDashboard(content: DashboardDisplayContentInfo): Unit
Updates the persisted data for a specific display in a dashboard.
Updates the persisted data for a specific display in a dashboard. For internal use only.
- abstract def postDisplayTrendsForDashboard(content: DashboardDisplayTrendsInfo): Unit
Updates the persisted trend information for a specific display in a dashboard.
Updates the persisted trend information for a specific display in a dashboard. For internal use only.
- abstract def postPresentation(content: PresentationContent): Unit
Creates a new version of a presentation with the specific content.
Creates a new version of a presentation with the specific content.
- content
The content of the new version.
- abstract def postRefresh(content: QueryRefreshContent): Unit
Updates all dashboards based on which source and pipeline snapshots have been added or removed.
Updates all dashboards based on which source and pipeline snapshots have been added or removed. For internal use only.
- content
A description of the changes provoking the refresh.
- abstract def postRestart: Unit
- Definition Classes
- ServiceFacadeBase
- abstract def postRunModel(pipelineId: String, transformId: String, input: ModelInputSpecification, tag: String, outputStream: OutputStream, date: LocalDateTime, locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals, includeTimestamp: Boolean = true): Unit
Runs an ML model against specified input with given parameters.
Runs an ML model against specified input with given parameters.
- pipelineId
The unique ID of the pipeline the model is built from.
- transformId
The unique ID of the transform in the pipeline building the model.
- input
The specification of input that the model should be run against.
- tag
The tag to use when loading the model.
- outputStream
The stream data is written to.
- date
The date to use then loading the model.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- abstract def postSearch(search: SearchContent, outputStream: OutputStream, tag: String, date: LocalDateTime, limit: Option[Int], locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Runs a search definition against the underlying result data with given parameters.
Runs a search definition against the underlying result data with given parameters.
- search
The search definition.
- outputStream
The stream data is written to.
- tag
The tag in the dashboards to fetch for.
- date
The date to use as upper bound on the result data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def postSql(sql: String, tag: String, outputStream: OutputStream, dateFrom: LocalDateTime, dateTo: LocalDateTime, locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals, includeTimestamp: Boolean = true, liveSources: Array[String] = Array(), serializeAsJson: Boolean = false): Unit
Runs a SQL query against the underlying result data with given parameters.
Runs a SQL query against the underlying result data with given parameters.
- sql
The SQL string to run (see Apache Spark SQL docs for specifics on dialect).
- tag
The tag to use when loading result data.
- outputStream
The stream data is written to.
- dateFrom
The lower bound on the collection on timeline dates to fetch for.
- dateTo
The upper bound on the collection on timeline dates to fetch for.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- liveSources
A list of ID's for sources to live refresh for use in the query, even if not directly used.
- serializeAsJson
Serialize the output as JSON array of arrays or as a csv with a ';' as the separator in either case the first row/line is the header.
- abstract def postStateForDashboard(state: DashboardStateInfo): Unit
Updates a state for a specific dashboard.
Updates a state for a specific dashboard. If the current state is in JobStates.absorbing the state can only be set to JobStates.pending.
- abstract def postTestMetadataForComponentForDashboard(content: DashboardContent, componentId: String, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array()): DashboardComponentMetadata
Gets the column metadata for the output data set for a specific component in a dashboard definition with given parameters.
Gets the column metadata for the output data set for a specific component in a dashboard definition with given parameters.
- content
The dashboard definition.
- componentId
The unique id of the component in the dashboard.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- abstract def postTestOutputForComponentForDashboard(content: DashboardContent, componentId: String, outputStream: OutputStream, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array(), locale: String = getOutputDefaultLocale, limit: Option[Int] = None, maxDecimals: Int = getOutputDefaultMaxDecimals, includeTimestamp: Boolean = true, serializeAsJson: Boolean = false): Unit
Gets the output data set for a specific component in a dashboard definition with given parameters.
Gets the output data set for a specific component in a dashboard definition with given parameters.
- content
The dashboard definition.
- componentId
The unique id of the component in the dashboard.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- limit
A limit on the number of data rows to write.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- serializeAsJson
Serialize the output as JSON array of arrays or as a csv with a ';' as the separator in either case the first row/line is the header.
- abstract def postTestOutputForDisplayForComponentForDashboard(content: DashboardContent, componentId: String, displayId: String, outputStream: OutputStream, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array(), locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Gets the output data set for a specific display and component in a dashboard definition with given parameters.
Gets the output data set for a specific display and component in a dashboard definition with given parameters.
- content
The dashboard definition.
- componentId
The unique id of the component in the dashboard.
- displayId
The unique id of the display in the component.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def postTestOutputForDisplayForPresentation(content: PresentationContent, displayId: String, outputStream: OutputStream, tag: String, date: LocalDateTime, locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals): Unit
Gets the output data set for a specific display in a presentation definition with given parameters.
Gets the output data set for a specific display in a presentation definition with given parameters.
- content
The presentation definition.
- displayId
The unique id of the display in the presentation.
- outputStream
The stream data is written to.
- tag
The tag in the presentation to fetch for.
- date
The date in the presentation to fetch for.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- abstract def postTestStatisticsForComponentForDashboard(content: DashboardContent, componentId: String, outputStream: OutputStream, tag: String, startDate: LocalDateTime = LocalDateTime.MIN, endDate: LocalDateTime = LocalDateTime.MAX, filters: Array[DashboardComponentFilter] = Array(), locale: String = getOutputDefaultLocale, maxDecimals: Int = getOutputDefaultMaxDecimals, includeTimestamp: Boolean = true): Unit
Gets the statistics on the output data set for a specific component in a dashboard definition with given parameters.
Gets the statistics on the output data set for a specific component in a dashboard definition with given parameters.
- content
The dashboard definition.
- componentId
The unique id of the component in the dashboard.
- outputStream
The stream data is written to.
- tag
The tag in the dashboard to fetch for.
- startDate
The lower bound on the collection on timeline dates to fetch for.
- endDate
The upper bound on the collection on timeline dates to fetch for.
- filters
A collection of filters to be applied in conjunction to the data.
- locale
The locale to use when formatting numbers, i.e. 'da'.
- maxDecimals
The maximum number of decimals to include when formatting numbers.
- includeTimestamp
Whether to include the OutputFacade.timestampOutputColumn in the data.
- abstract def postTestTagsForComponentForDashboard(content: DashboardContent, componentId: String): Array[String]
Gets the tags for which output data is computed for a specific component in a dashboard definition.
Gets the tags for which output data is computed for a specific component in a dashboard definition.
- content
The dashboard definition.
- componentId
The unique id of the component in the dashboard.
- abstract def postTestTagsForDashboard(content: DashboardContent): Array[String]
Gets the tags for which output data is computed for a specific dashboard definition.
Gets the tags for which output data is computed for a specific dashboard definition.
- content
The dashboard definition.
- abstract def postTestTimelineForComponentForDashboard(content: DashboardContent, componentId: String, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific component in a dashboard definition.
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific component in a dashboard definition.
- content
The dashboard definition.
- componentId
The unique id of the component in the dashboard.
- tag
The tag in the dashboard to fetch for.
- abstract def postTestTimelineForDashboard(content: DashboardContent, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific dashboard definition.
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific dashboard definition.
- content
The dashboard definition.
- tag
The tag in the dashboard to fetch for.
- abstract def postTestTimelineForPageForPresentation(content: PresentationContent, pageId: String, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific page in a presentation definition.
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific page in a presentation definition.
- content
The presentation definition.
- pageId
The unique id of the page in the presentation.
- tag
The tag in the presentation to fetch for.
- abstract def postTestTimelineForPresentation(content: PresentationContent, tag: String): Array[LocalDateTime]
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific presentation definition.
Gets the timeline of dates (sorted ascending) for which output data is computed for a specific presentation definition.
- content
The presentation definition.
- tag
The tag in the presentation to fetch for.
- abstract def postVacuumDatabase: Unit
- Definition Classes
- ServiceFacadeWithDatabase
- abstract def setLogLevel(level: String): Unit
- Definition Classes
- ServiceFacadeBase
- abstract def withTimeout(seconds: Int): QueryFacade
- Definition Classes
- ServiceFacade
- abstract def withToken(token: UUID): QueryFacade
- Definition Classes
- ServiceFacade
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getDashboards: Array[DashboardInfo]
Gets the most recent version of each dashboard.
- def getPresentations: Array[PresentationInfo]
Gets the most recent version of each presentation.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitIsReady(timeoutSeconds: Int, pollIntervalSeconds: Int): Unit
- Definition Classes
- ServiceFacadeBase
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)