Query (spectator-reg-atlas 1.5.4 API)

All Known Subinterfaces:

Query.KeyQuery

All Known Implementing Classes:

Query.And, Query.CompositeKeyQuery, Query.Equal, Query.GreaterThan, Query.GreaterThanEqual, Query.Has, Query.In, Query.InvertedKeyQuery, Query.LessThan, Query.LessThanEqual, Query.Not, Query.Or, Query.Regex
```
public interface Query
```
Query for matching based on tags. For more information see: https://github.com/Netflix/atlas/wiki/Stack-Language#query Classes in this package are only intended for use internally within spectator. They may change at any time and without notice.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Query.And` Query that matches if both sub-queries match.
`static class`	`Query.CompositeKeyQuery` Checks all of a set of conditions for the same key match the specified value.
`static class`	`Query.Equal` Query that matches if the tag map contains key `k` with value `v`.
`static class`	`Query.GreaterThan` Query that matches if the tag map contains key `k` with a value that is lexically greater than `v`.
`static class`	`Query.GreaterThanEqual` Query that matches if the tag map contains key `k` with a value that is lexically greater than or equal to `v`.
`static class`	`Query.Has` Query that matches if the tag map contains a specified key.
`static class`	`Query.In` Query that matches if the tag map contains key `k` with a value in the set `vs`.
`static class`	`Query.InvertedKeyQuery` Query that matches if the underlying key query does not match.
`static interface`	`Query.KeyQuery` Base interface for simple queries that check the value associated with a single key.
`static class`	`Query.LessThan` Query that matches if the tag map contains key `k` with a value that is lexically less than `v`.
`static class`	`Query.LessThanEqual` Query that matches if the tag map contains key `k` with a value that is lexically less than or equal to `v`.
`static class`	`Query.Not` Query that matches if the sub-query does not match.
`static class`	`Query.Or` Query that matches if either sub-queries match.
`static class`	`Query.Regex` Query that matches if the tag map contains key `k` with a value that matches the regex in `v`.

Field Summary

Fields
Modifier and Type Field and Description

static Query FALSE
Query that never matches.

static Query TRUE
Query that always matches.

Fields
Modifier and Type	Field and Description
`static Query`	`FALSE` Query that never matches.
`static Query`	`TRUE` Query that always matches.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Query`	`and(Query q)` Returns a new query: `this AND q`.
`default List<Query>`	`andList()` Converts this query into a list of sub-queries that can be ANDd together.
`default List<Query>`	`dnfList()` Converts this query into disjunctive normal form.
`default Map<String,String>`	`exactTags()` Extract the tags from the query that have an exact match for a given value.
`default boolean`	`matches(com.netflix.spectator.api.Id id)` Check to see if this query matches an id.
`boolean`	`matches(Map<String,String> tags)` Check to see if this query matches a set of tags.
`default Query`	`not()` Returns an inverted version of this query.
`default Query`	`or(Query q)` Returns a new query: `this OR q`.
`default Query`	`simplify(Map<String,String> tags)` Return a new query that has been simplified by pre-evaluating the conditions for a set of tags that are common to all metrics.
`static Map<String,String>`	`toMap(com.netflix.spectator.api.Id id)` Convert `id` to a map.

- Field Detail
  - TRUE
```
static final Query TRUE
```
    Query that always matches.
  - FALSE
```
static final Query FALSE
```
    Query that never matches.
- Method Detail
  - toMap
```
static Map<String,String> toMap(com.netflix.spectator.api.Id id)
```
    Convert id to a map.
  - matches
```
boolean matches(Map<String,String> tags)
```
    Check to see if this query matches a set of tags. Common tags or changes to fix invalid characters should be performed prior to checking for a match.
    
    Parameters:
    
    tags - Tags to use when checking for a match.
    
    Returns:
    
    True if the query expression matches the tag map.
  - matches
```
default boolean matches(com.netflix.spectator.api.Id id)
```
    Check to see if this query matches an id. Equivalent to calling matches(Map) with the result of toMap(Id).
    
    Parameters:
    
    id - Id to use when checking for a match.
    
    Returns:
    
    True if the query expression matches the id.
  - exactTags
```
default Map<String,String> exactTags()
```
    Extract the tags from the query that have an exact match for a given value. That is are specified using an Query.Equal clause.
    
    Returns:
    
    Tags that are exactly matched as part of the query.
  - and
```
default Query and(Query q)
```
    Returns a new query: this AND q.
  - or
```
default Query or(Query q)
```
    Returns a new query: this OR q.
  - not
```
default Query not()
```
    Returns an inverted version of this query.
  - dnfList
```
default List<Query> dnfList()
```
    Converts this query into disjunctive normal form. The return value is a list of sub-queries that should be ORd together.
  - andList
```
default List<Query> andList()
```
    Converts this query into a list of sub-queries that can be ANDd together. The query will not be normalized first, it will only expand top-level AND clauses.
  - simplify
```
default Query simplify(Map<String,String> tags)
```
    Return a new query that has been simplified by pre-evaluating the conditions for a set of tags that are common to all metrics.

Interface Query

Nested Class Summary

Field Summary

Method Summary

Field Detail

TRUE

FALSE

Method Detail

toMap

matches

matches

exactTags

and

or

not

dnfList

andList

simplify