Package com.faunadb.client.types

Class MetricsResponse

java.lang.Object

com.faunadb.client.types.MetricsResponse

public class MetricsResponse
extends Object

An aggregation type which consists of Value instance and extra information of response. Extra information is stored in the metricsMap and can be retrieved by using getMetric(Metrics) method

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsResponse.Metrics	Different header names that indicate the resources used in any query to faunadb server

Method Summary

Modifier and Type	Method	Description
Optional<String>	getMetric(MetricsResponse.Metrics metric)	Gets a specified metric
Value	getValue()	Gets the Value part
static MetricsResponse	of(Value value, Map<MetricsResponse.Metrics,String> metricsMap)

Methods inherited from class java.lang.Object

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

Method Detail

of

public static MetricsResponse of(Value value,
                                 Map<MetricsResponse.Metrics,String> metricsMap)

getValue

public Value getValue()

Gets the Value part

Returns:

the root node of the response tree

getMetric

public Optional<String> getMetric(MetricsResponse.Metrics metric)

Gets a specified metric

Parameters:

metric - a metric user wants to retrieve

Returns:

the metric value