io.sphere.sdk.client.metrics

Class ObservedDeserializationDuration

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.client.metrics.ObservedDeserializationDuration

All Implemented Interfaces:

ObservedDuration

public final class ObservedDeserializationDuration
extends Base

Message for the duration of transforming the http response body into a Java object.

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	durationInMilliseconds
protected SphereRequest<?>	request
protected String	requestId

Method Summary

Modifier and Type	Method and Description
String	getCorrelationId()
Long	getDurationInMilliseconds() The duration in milliseconds.
HttpResponse	getHttpResponse()
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..
Object	getResult()
String	getTopic() A String to describe the topic associated with the observed duration (e.g.
static ObservedDeserializationDuration	of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId)
static ObservedDeserializationDuration	of(long durationInMilliseconds, String sphereRequestId, SphereRequest<?> request, String correlationId, HttpResponse httpResponse, Object result)

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

requestId

protected final String requestId

durationInMilliseconds

protected final Long durationInMilliseconds

request

protected final SphereRequest<?> request

Method Detail

of

public static ObservedDeserializationDuration of(long durationInMilliseconds,
                                                 String sphereRequestId,
                                                 SphereRequest<?> request,
                                                 @Nullable
                                                 String correlationId)

of

public static ObservedDeserializationDuration of(long durationInMilliseconds,
                                                 String sphereRequestId,
                                                 SphereRequest<?> request,
                                                 @Nullable
                                                 String correlationId,
                                                 @Nullable
                                                 HttpResponse httpResponse,
                                                 @Nullable
                                                 Object result)

getCorrelationId

@Nullable
public String getCorrelationId()

getHttpResponse

@Nullable
public HttpResponse getHttpResponse()

getResult

@Nullable
public Object getResult()

getDurationInMilliseconds

public Long getDurationInMilliseconds()

Description copied from interface: ObservedDuration

The duration in milliseconds.

Specified by:

getDurationInMilliseconds in interface ObservedDuration

Returns:

duration

getRequestId

public String getRequestId()

Description copied from interface: ObservedDuration

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.

Specified by:

getRequestId in interface ObservedDuration

Returns:

ID for one execution of the client

getRequest

public SphereRequest<?> getRequest()

Description copied from interface: ObservedDuration

The sphere request related to the observed duration.

Specified by:

getRequest in interface ObservedDuration

Returns:

request

getTopic

public final String getTopic()

Description copied from interface: ObservedDuration

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

Specified by:

getTopic in interface ObservedDuration

Returns:

topic