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

Class JobMetricsHeaders

java.lang.Object

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

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

All Implemented Interfaces:

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

public final class JobMetricsHeaders
extends AbstractMetricsHeaders<JobMetricsMessageParameters>

MessageHeaders for JobMetricsHandler.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description for this header.
static JobMetricsHeaders	getInstance()
String	getTargetRestEndpointURL()	Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.
JobMetricsMessageParameters	getUnresolvedMessageParameters()	Returns a new MessageParameters object.

Methods inherited from class org.apache.flink.runtime.rest.messages.job.metrics.AbstractMetricsHeaders

getHttpMethod, getRequestClass, getResponseClass, getResponseStatusCode

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, getResponseTypeParameters, operationId

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

getSupportedAPIVersions

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

acceptsFileUploads

Method Details

getUnresolvedMessageParameters

public JobMetricsMessageParameters getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Specified by:

getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<EmptyRequestBody,JobMetricsMessageParameters>

Specified by:

getUnresolvedMessageParameters in class AbstractMetricsHeaders<JobMetricsMessageParameters>

Returns:

new message parameters object

getTargetRestEndpointURL

public 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

Specified by:

getTargetRestEndpointURL in class AbstractMetricsHeaders<JobMetricsMessageParameters>

Returns:

endpoint url that this request should be sent to

getInstance

public static JobMetricsHeaders getInstance()

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Returns:

description for the header