io.sphere.sdk.client.metrics

Interface ObservedDuration

All Known Implementing Classes:

ObservedDeserializationDuration, ObservedSerializationDuration, ObservedTotalDuration

public interface ObservedDuration

Contains duration information for a particular aspect of one execution of a SimpleMetricsSphereClient.execute(SphereRequest).

See Also:

SimpleMetricsSphereClient

Method Summary

Modifier and Type	Method and Description
Long	getDurationInMilliseconds() The duration in milliseconds.
SphereRequest<?>	getRequest() The sphere request related to the observed duration.
String	getRequestId() The SimpleMetricsSphereClient adds a request ID to each SphereRequest, so that ObservedDurations belonging to the same request can be associated..
String	getTopic() A String to describe the topic associated with the observed duration (e.g.

Method Detail

getDurationInMilliseconds

Long getDurationInMilliseconds()

The duration in milliseconds.

Returns:

duration

getRequestId

String getRequestId()

The SimpleMetricsSphereClient adds a request ID to each SphereRequest, so that ObservedDurations belonging to the same request can be associated..

This is necessary since a SphereRequest can be reused for multiple requests.

Returns:

ID for one execution of the client

getTopic

String getTopic()

A String to describe the topic associated with the observed duration (e.g. "ObservedSerializationDuration" for the deserialization of JSON).

Returns:

topic

getRequest

SphereRequest<?> getRequest()

The sphere request related to the observed duration.

Returns:

request