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

Class AbstractMetricsHeaders<M extends MessageParameters>

java.lang.Object

org.apache.flink.runtime.rest.messages.job.metrics.AbstractMetricsHeaders<M>

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,M>, RuntimeMessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,M>, UntypedResponseMessageHeaders<EmptyRequestBody,M>

Direct Known Subclasses:

JobManagerMetricsHeaders, JobMetricsHeaders, JobVertexMetricsHeaders, SubtaskMetricsHeaders, TaskManagerMetricsHeaders

public abstract class AbstractMetricsHeaders<M extends MessageParameters>
extends Object
implements RuntimeMessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,M>

MessageHeaders for AbstractMetricsHandler.

Constructor Summary

Constructors

Constructor and Description
AbstractMetricsHeaders()

Method Summary

Modifier and Type	Method and Description
HttpMethodWrapper	getHttpMethod() Returns the HttpMethodWrapper to be used for the request.
Class<EmptyRequestBody>	getRequestClass() Returns the class of the request message.
Class<MetricCollectionResponseBody>	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.
abstract String	getTargetRestEndpointURL() Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.
abstract M	getUnresolvedMessageParameters() Returns a new MessageParameters object.

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.RuntimeMessageHeaders

getSupportedAPIVersions

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

getCustomHeaders, getDescription, getResponseTypeParameters, operationId

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

acceptsFileUploads

Constructor Detail

AbstractMetricsHeaders

public AbstractMetricsHeaders()

Method Detail

getRequestClass

public Class<EmptyRequestBody> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Specified by:

getRequestClass in interface UntypedResponseMessageHeaders<EmptyRequestBody,M extends MessageParameters>

Returns:

class of the request message

getResponseClass

public Class<MetricCollectionResponseBody> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,M extends MessageParameters>

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,MetricCollectionResponseBody,M extends MessageParameters>

Returns:

http status code of the response

getUnresolvedMessageParameters

public abstract M getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Specified by:

getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<EmptyRequestBody,M extends MessageParameters>

Returns:

new message parameters object

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

getTargetRestEndpointURL

public abstract String getTargetRestEndpointURL()

Description copied from interface: RestHandlerSpecification

Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.

Specified by:

getTargetRestEndpointURL in interface RestHandlerSpecification

Returns:

endpoint url that this request should be sent to