Package org.apache.flink.runtime.rest.messages.job.metrics

Class AbstractAggregatedMetricsHeaders<P extends AbstractAggregatedMetricsParameters<?>>

java.lang.Object

org.apache.flink.runtime.rest.messages.job.metrics.AbstractAggregatedMetricsHeaders<P>

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,AggregatedMetricsResponseBody,P>, RuntimeMessageHeaders<EmptyRequestBody,AggregatedMetricsResponseBody,P>, UntypedResponseMessageHeaders<EmptyRequestBody,P>

Direct Known Subclasses:

AggregatedJobMetricsHeaders, AggregatedSubtaskMetricsHeaders, AggregatedTaskManagerMetricsHeaders

public abstract class AbstractAggregatedMetricsHeaders<P extends AbstractAggregatedMetricsParameters<?>>
extends Object
implements RuntimeMessageHeaders<EmptyRequestBody,AggregatedMetricsResponseBody,P>

Based MessageHeaders class for aggregating metrics.

Constructor Summary

Constructors

Constructor	Description
AbstractAggregatedMetricsHeaders()

Method Summary

Modifier and Type	Method	Description
HttpMethodWrapper	getHttpMethod()	Returns the HttpMethodWrapper to be used for the request.
Class<EmptyRequestBody>	getRequestClass()	Returns the class of the request message.
Class<AggregatedMetricsResponseBody>	getResponseClass()	Returns the class of the response message.
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode()	Returns the http status code for the response.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.runtime.rest.messages.MessageHeaders

getCustomHeaders, getDescription, getResponseTypeParameters, operationId

Methods inherited from interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification

getTargetRestEndpointURL

Methods inherited from interface org.apache.flink.runtime.rest.messages.RuntimeMessageHeaders

getSupportedAPIVersions

Methods inherited from interface org.apache.flink.runtime.rest.messages.UntypedResponseMessageHeaders

acceptsFileUploads, getUnresolvedMessageParameters

Constructor Details

AbstractAggregatedMetricsHeaders

public AbstractAggregatedMetricsHeaders()

Method Details

getResponseClass

public Class<AggregatedMetricsResponseBody> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<EmptyRequestBody,AggregatedMetricsResponseBody,P extends AbstractAggregatedMetricsParameters<?>>

Returns:

class of the response message

getResponseStatusCode

public org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus getResponseStatusCode()

Description copied from interface: MessageHeaders

Returns the http status code for the response.

Specified by:

getResponseStatusCode in interface MessageHeaders<EmptyRequestBody,AggregatedMetricsResponseBody,P extends AbstractAggregatedMetricsParameters<?>>

Returns:

http status code of the response

getRequestClass

public Class<EmptyRequestBody> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Specified by:

getRequestClass in interface UntypedResponseMessageHeaders<EmptyRequestBody,P extends AbstractAggregatedMetricsParameters<?>>

Returns:

class of the request message

getHttpMethod

public HttpMethodWrapper getHttpMethod()

Description copied from interface: RestHandlerSpecification

Returns the HttpMethodWrapper to be used for the request.

Specified by:

getHttpMethod in interface RestHandlerSpecification

Returns:

http method to be used for the request