JobVertexMetricsHeaders (Flink : Runtime 2.0-preview1 API)

java.lang.Object
- org.apache.flink.runtime.rest.messages.job.metrics.AbstractMetricsHeaders<JobVertexMetricsMessageParameters>
- - org.apache.flink.runtime.rest.messages.job.metrics.JobVertexMetricsHeaders

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,JobVertexMetricsMessageParameters>, RuntimeMessageHeaders<EmptyRequestBody,MetricCollectionResponseBody,JobVertexMetricsMessageParameters>, UntypedResponseMessageHeaders<EmptyRequestBody,JobVertexMetricsMessageParameters>
```
public final class JobVertexMetricsHeaders
extends AbstractMetricsHeaders<JobVertexMetricsMessageParameters>
```
MessageHeaders for JobVertexMetricsHandler.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Returns the description for this header.
`static JobVertexMetricsHeaders`	`getInstance()`
`String`	`getTargetRestEndpointURL()`	Returns the generalized endpoint url that this request should be sent to, for example `/job/:jobid`.
`JobVertexMetricsMessageParameters`	`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 Detail
  - getUnresolvedMessageParameters
```
public JobVertexMetricsMessageParameters getUnresolvedMessageParameters()
```
    Description copied from interface: UntypedResponseMessageHeaders
    
    Returns a new MessageParameters object.
    
    Specified by:
    
    getUnresolvedMessageParameters in interface UntypedResponseMessageHeaders<EmptyRequestBody,JobVertexMetricsMessageParameters>
    
    Specified by:
    
    getUnresolvedMessageParameters in class AbstractMetricsHeaders<JobVertexMetricsMessageParameters>
    
    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<JobVertexMetricsMessageParameters>
    
    Returns:
    
    endpoint url that this request should be sent to
  - getInstance
```
public static JobVertexMetricsHeaders getInstance()
```
  - getDescription
```
public String getDescription()
```
    Description copied from interface: MessageHeaders
    
    Returns the description for this header.
    
    Returns:
    
    description for the header