package analytics
- Alphabetic
- Public
- Protected
Type Members
- case class AnalyticsMetaData(requestId: String, clientContextId: String, signatureContent: Option[Array[Byte]], metrics: AnalyticsMetrics, warnings: Seq[AnalyticsWarning], status: AnalyticsStatus) extends Product with Serializable
Additional information returned by the Analytics service after any rows and errors.
Additional information returned by the Analytics service after any rows and errors.
- metrics
metrics related to the Analytics request, if they are available
- warnings
any warnings returned from the Analytics service
- status
the raw status string returned from the Analytics service
- case class AnalyticsMetrics(elapsedTime: Duration, executionTime: Duration, resultCount: Long, resultSize: Long, processedObjects: Long, errorCount: Long, warningCount: Long) extends Product with Serializable
Metrics of a given Analytics request.
Metrics of a given Analytics request.
- elapsedTime
the total time taken for the request, that is the time from when the request was received until the results were returned, in a human-readable format (eg. 123.45ms for a little over 123 milliseconds).
- executionTime
the time taken for the execution of the request, that is the time from when analytics execution started until the results were returned, in a human-readable format (eg. 123.45ms for a little over 123 milliseconds).
- resultCount
the total number of results selected by the engine before restriction through LIMIT clause.
- resultSize
the total number of returned rows.
- processedObjects
the total number of processed objects.
- errorCount
the number of errors that occurred during the request.
- warningCount
the number of warnings that occurred during the request.
- case class AnalyticsOptions extends Product with Serializable
Customize the execution of an analytics query.
Customize the execution of an analytics query.
- Since
1.0.0
- sealed trait AnalyticsParameters extends AnyRef
- case class AnalyticsResult(rows: Seq[AnalyticsChunkRow], metaData: AnalyticsMetaData) extends Product with Serializable
The results of an Analytics query.
The results of an Analytics query.
- rows
all rows returned from the analytics service
- metaData
any additional information related to the Analytics query
- Since
1.0.0
- sealed trait AnalyticsScanConsistency extends AnyRef
- sealed trait AnalyticsStatus extends AnyRef
- case class AnalyticsWarning(inner: ErrorCodeAndMessage) extends Product with Serializable
- case class ReactiveAnalyticsResult(rows: SFlux[AnalyticsChunkRow], meta: SMono[AnalyticsMetaData]) extends Product with Serializable
The results of an Analytics query, as returned by the reactive API.
The results of an Analytics query, as returned by the reactive API.
- rows
a Flux of any returned rows. If the Analytics service returns an error while returning the rows, it will be raised on this Flux
- meta
any additional information related to the Analytics query
Value Members
- object AnalyticsOptions extends Serializable
- object AnalyticsParameters
- object AnalyticsScanConsistency
- object AnalyticsStatus