Package de.tsystems.mms.apm.performancesignature.dynatracesaas.rest.model

Class TimeseriesQueryMessage

java.lang.Object

de.tsystems.mms.apm.performancesignature.dynatracesaas.rest.model.TimeseriesQueryMessage

public class TimeseriesQueryMessage
extends Object

Contains settings for a timeseries query.

Constructor Summary

Constructors

Constructor	Description
TimeseriesQueryMessage()

Method Summary

Modifier and Type	Method	Description
TimeseriesQueryMessage	addEntitiesItem(String entitiesItem)
TimeseriesQueryMessage	addTagsItem(String tagsItem)
TimeseriesQueryMessage	aggregationType(AggregationTypeEnum aggregationType)
TimeseriesQueryMessage	endTimestamp(Long endTimestamp)
TimeseriesQueryMessage	entities(List<String> entities)
TimeseriesQueryMessage	filters(Map<String,String> filters)
AggregationTypeEnum	getAggregationType()	Defines which aggregation type is used for the resulting metric.
Long	getEndTimestamp()	End of timeframe in milliseconds since Unix epoch.
List<String>	getEntities()	Filters requested data points by entities which should deliver them.
Map<String,String>	getFilters()	A filter is an object, containing map of filter keys and its values.
Integer	getPercentile()	In case of the percentile aggregation type, this parameter specifies which percentile of the selected response time metric should be delivered.
QueryModeEnum	getQueryMode()	Defines the type of result that the call should return.
Long	getStartTimestamp()	Start of timeframe in milliseconds since Unix epoch.
List<String>	getTags()	List of labels of entities that you want to fetch data for.
String	getTimeseriesId()	Case-sensitive identifier of the metric, where you want to read data points.
Boolean	isPredict()	Used to predict future Values
TimeseriesQueryMessage	percentile(Integer percentile)
TimeseriesQueryMessage	predict(Boolean predict)
TimeseriesQueryMessage	putFiltersItem(String key, String filtersItem)
TimeseriesQueryMessage	queryMode(QueryModeEnum queryMode)
void	setAggregationType(AggregationTypeEnum aggregationType)
void	setEndTimestamp(Long endTimestamp)
TimeseriesQueryMessage	setEntities(List<String> entities)
void	setFilters(Map<String,String> filters)
void	setPercentile(Integer percentile)
void	setPredict(Boolean predict)
void	setQueryMode(QueryModeEnum queryMode)
void	setStartTimestamp(Long startTimestamp)
TimeseriesQueryMessage	setTags(List<String> tags)
void	setTimeseriesId(String timeseriesId)
TimeseriesQueryMessage	startTimestamp(Long startTimestamp)
TimeseriesQueryMessage	tags(List<String> tags)
TimeseriesQueryMessage	timeseriesId(String timeseriesId)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeseriesQueryMessage

public TimeseriesQueryMessage()

Method Detail

timeseriesId

public TimeseriesQueryMessage timeseriesId(String timeseriesId)

getTimeseriesId

public String getTimeseriesId()

Case-sensitive identifier of the metric, where you want to read data points. You can find a list of available built-in Dynatrace metrics in the Available timeseries section, and plugin-driven metrics in the Plugin timeseries section. You can also execute a GET timeseries request, to obtain the list of available metrics.

Returns:

timeseriesId

setTimeseriesId

public void setTimeseriesId(String timeseriesId)

aggregationType

public TimeseriesQueryMessage aggregationType(AggregationTypeEnum aggregationType)

getAggregationType

public AggregationTypeEnum getAggregationType()

Defines which aggregation type is used for the resulting metric. If the requested metric doesn't support the specified aggregation, the request will result in an error.

Returns:

aggregationType

setAggregationType

public void setAggregationType(AggregationTypeEnum aggregationType)

startTimestamp

public TimeseriesQueryMessage startTimestamp(Long startTimestamp)

getStartTimestamp

public Long getStartTimestamp()

Start of timeframe in milliseconds since Unix epoch.

Returns:

startTimestamp

setStartTimestamp

public void setStartTimestamp(Long startTimestamp)

endTimestamp

public TimeseriesQueryMessage endTimestamp(Long endTimestamp)

getEndTimestamp

public Long getEndTimestamp()

End of timeframe in milliseconds since Unix epoch. Must be larger(later) than start timestamp. If the given timestamp is larger than the actual time, then the actual time is used instead.

Returns:

endTimestamp

setEndTimestamp

public void setEndTimestamp(Long endTimestamp)

predict

public TimeseriesQueryMessage predict(Boolean predict)

isPredict

public Boolean isPredict()

Used to predict future Values

Returns:

predict

setPredict

public void setPredict(Boolean predict)

queryMode

public TimeseriesQueryMessage queryMode(QueryModeEnum queryMode)

getQueryMode

public QueryModeEnum getQueryMode()

Defines the type of result that the call should return. Valid result modes are: series: returns all the data points of the metric in the specified timeframe. total: returns one scalar value for the specified timeframe. By default, the series mode is used.

Returns:

queryMode

setQueryMode

public void setQueryMode(QueryModeEnum queryMode)

entities

public TimeseriesQueryMessage entities(List<String> entities)

addEntitiesItem

public TimeseriesQueryMessage addEntitiesItem(String entitiesItem)

getEntities

public List<String> getEntities()

Filters requested data points by entities which should deliver them. You can specify several entities at once. Allowed values are Dynatrace entity IDs. You can find them in the URL of the corresponding Dynatrace entity page, for example, HOST-007. If the selected entity doesn't support the requested metric, the request will result in an error.

Returns:

entities

setEntities

public TimeseriesQueryMessage setEntities(List<String> entities)

tags

public TimeseriesQueryMessage tags(List<String> tags)

addTagsItem

public TimeseriesQueryMessage addTagsItem(String tagsItem)

getTags

public List<String> getTags()

List of labels of entities that you want to fetch data for.

Returns:

tags

setTags

public TimeseriesQueryMessage setTags(List<String> tags)

filters

public TimeseriesQueryMessage filters(Map<String,String> filters)

putFiltersItem

public TimeseriesQueryMessage putFiltersItem(String key,
                                             String filtersItem)

getFilters

public Map<String,String> getFilters()

A filter is an object, containing map of filter keys and its values. Valid filter keys are: processType: Filters by process type. See Process types for allowed values. osType: Filters by operating system. See OS types for allowed values. serviceType: Filters by service type. See Service types for allowed values. technology: Filters by technology type. See Technology types for allowed values. webServiceName: Filters by web service name. webServiceNamespace: Filters by the web service namespace. host: Filters by entity ID of the host, for example HOST-007.

Returns:

filters

setFilters

public void setFilters(Map<String,String> filters)

percentile

public TimeseriesQueryMessage percentile(Integer percentile)

getPercentile

public Integer getPercentile()

In case of the percentile aggregation type, this parameter specifies which percentile of the selected response time metric should be delivered. Valid values for percentile are between 1 and 99. Please keep in mind that percentile export is only possible for response-time based metrics such as application and service response times.

Returns:

percentile

setPercentile

public void setPercentile(Integer percentile)

toString

public String toString()

Overrides:

toString in class Object