case class Query(metricName: MetricName, tags: Seq[QueryTag] = Seq.empty, groupBys: Seq[GroupBy] = Seq.empty, aggregators: Seq[Aggregator] = Seq.empty, limit: Option[Int] = None, order: Order = Order.defaultOrder, excludeTags: Boolean = false, plugins: Seq[QueryPlugin] = Seq.empty) extends Product with Serializable

tags

Tags narrow down the search. Only metrics that include the tag and matches one of the values are returned. Tags are optional.

groupBys

The resulting data points can be grouped by one or more tags, a time range, or by value, or by a combination of the three.

aggregators

An ordered array of aggregators. They are processed in the order specified. The output of an aggregator is passed to the input of the next until all have been processed.

limit

Limits the number of data points returned from the data store. The limit is applied before any aggregator is executed.

order

Orders the returned data points. This sorting is done before any aggregators are executed.

excludeTags

By default, the result of the query includes tags and tag values associated with the data points. If excludeTags is set to true, the tags will be excluded from the response.

plugins

optional plugin references to customize the behavior of the query on this metric

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Query
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Query(metricName: MetricName, tags: Seq[QueryTag] = Seq.empty, groupBys: Seq[GroupBy] = Seq.empty, aggregators: Seq[Aggregator] = Seq.empty, limit: Option[Int] = None, order: Order = Order.defaultOrder, excludeTags: Boolean = false, plugins: Seq[QueryPlugin] = Seq.empty)

    tags

    Tags narrow down the search. Only metrics that include the tag and matches one of the values are returned. Tags are optional.

    groupBys

    The resulting data points can be grouped by one or more tags, a time range, or by value, or by a combination of the three.

    aggregators

    An ordered array of aggregators. They are processed in the order specified. The output of an aggregator is passed to the input of the next until all have been processed.

    limit

    Limits the number of data points returned from the data store. The limit is applied before any aggregator is executed.

    order

    Orders the returned data points. This sorting is done before any aggregators are executed.

    excludeTags

    By default, the result of the query includes tags and tag values associated with the data points. If excludeTags is set to true, the tags will be excluded from the response.

    plugins

    optional plugin references to customize the behavior of the query on this metric

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val aggregators: Seq[Aggregator]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val excludeTags: Boolean
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. val groupBys: Seq[GroupBy]
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val limit: Option[Int]
  13. val metricName: MetricName
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val order: Order
  18. val plugins: Seq[QueryPlugin]
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val tags: Seq[QueryTag]
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped