@InterfaceAudience.Private @InterfaceStability.Unstable public class TimelineDataToRetrieve extends Object
TimelineFilterList
object
containing TimelinePrefixFilter
objects. These can either be
exact config keys' or prefixes which are then compared against config
keys' to decide configs(inside entities) to return in response. If null
or empty, all configurations will be fetched if fieldsToRetrieve
contains TimelineReader.Field.CONFIGS
or TimelineReader.Field.ALL
. This should not be
confused with configFilters which is used to decide which entities to
return instead.TimelineFilterList
object
containing TimelinePrefixFilter
objects. These can either be
exact metric ids' or prefixes which are then compared against metric
ids' to decide metrics(inside entities) to return in response. If null
or empty, all metrics will be fetched if fieldsToRetrieve contains
TimelineReader.Field.METRICS
or TimelineReader.Field.ALL
. This should not be confused
with metricFilters which is used to decide which entities to return
instead.TimelineReader.Field
. If null, retrieves 3 fields,
namely entity id, entity type and entity created time. All fields will
be returned if TimelineReader.Field.ALL
is specified.Long.MAX_VALUE
.
Modifier and Type | Field and Description |
---|---|
static Integer |
DEFAULT_METRICS_LIMIT
Default limit of number of metrics to return.
|
Constructor and Description |
---|
TimelineDataToRetrieve() |
TimelineDataToRetrieve(TimelineFilterList confs,
TimelineFilterList metrics,
EnumSet<TimelineReader.Field> fields,
Integer limitForMetrics,
Long metricTimeBegin,
Long metricTimeEnd) |
Modifier and Type | Method and Description |
---|---|
void |
addFieldsBasedOnConfsAndMetricsToRetrieve()
Adds configs and metrics fields to fieldsToRetrieve(if they are not
present) if confsToRetrieve and metricsToRetrieve are specified.
|
TimelineFilterList |
getConfsToRetrieve() |
EnumSet<TimelineReader.Field> |
getFieldsToRetrieve() |
Integer |
getMetricsLimit() |
Long |
getMetricsTimeBegin() |
Long |
getMetricsTimeEnd() |
TimelineFilterList |
getMetricsToRetrieve() |
void |
setConfsToRetrieve(TimelineFilterList confs) |
void |
setFieldsToRetrieve(EnumSet<TimelineReader.Field> fields) |
void |
setMetricsLimit(Integer limit) |
void |
setMetricsToRetrieve(TimelineFilterList metrics) |
public static final Integer DEFAULT_METRICS_LIMIT
public TimelineDataToRetrieve()
public TimelineDataToRetrieve(TimelineFilterList confs, TimelineFilterList metrics, EnumSet<TimelineReader.Field> fields, Integer limitForMetrics, Long metricTimeBegin, Long metricTimeEnd)
public TimelineFilterList getConfsToRetrieve()
public void setConfsToRetrieve(TimelineFilterList confs)
public TimelineFilterList getMetricsToRetrieve()
public void setMetricsToRetrieve(TimelineFilterList metrics)
public EnumSet<TimelineReader.Field> getFieldsToRetrieve()
public void setFieldsToRetrieve(EnumSet<TimelineReader.Field> fields)
public void addFieldsBasedOnConfsAndMetricsToRetrieve()
public Integer getMetricsLimit()
public Long getMetricsTimeBegin()
public Long getMetricsTimeEnd()
public void setMetricsLimit(Integer limit)
Copyright © 2008–2020 Apache Software Foundation. All rights reserved.