Package org.apache.flink.runtime.rest.messages.checkpoints

Class CheckpointStatusHeaders

java.lang.Object

org.apache.flink.runtime.rest.handler.async.AsynchronousOperationStatusMessageHeaders<CheckpointInfo,CheckpointStatusMessageParameters>

org.apache.flink.runtime.rest.messages.checkpoints.CheckpointStatusHeaders

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,AsynchronousOperationResult<CheckpointInfo>,CheckpointStatusMessageParameters>, RuntimeMessageHeaders<EmptyRequestBody,AsynchronousOperationResult<CheckpointInfo>,CheckpointStatusMessageParameters>, UntypedResponseMessageHeaders<EmptyRequestBody,CheckpointStatusMessageParameters>

public class CheckpointStatusHeaders
extends AsynchronousOperationStatusMessageHeaders<CheckpointInfo,CheckpointStatusMessageParameters>

These headers define the protocol for querying the status of a checkpoint operation.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description for this header.
HttpMethodWrapper	getHttpMethod()	Returns the HttpMethodWrapper to be used for the request.
static CheckpointStatusHeaders	getInstance()
Class<EmptyRequestBody>	getRequestClass()	Returns the class of the request message.
org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus	getResponseStatusCode()	Returns the http status code for the response.
String	getTargetRestEndpointURL()	Returns the generalized endpoint url that this request should be sent to, for example /job/:jobid.
CheckpointStatusMessageParameters	getUnresolvedMessageParameters()	Returns a new MessageParameters object.
Class<CheckpointInfo>	getValueClass()	Returns the class of the value wrapped in the AsynchronousOperationResult.

Methods inherited from class org.apache.flink.runtime.rest.handler.async.AsynchronousOperationStatusMessageHeaders

getResponseClass, getResponseTypeParameters

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

getRequestClass

public Class<EmptyRequestBody> getRequestClass()

Description copied from interface: UntypedResponseMessageHeaders

Returns the class of the request message.

Returns:

class of the request 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.

Returns:

http status code of the response

getUnresolvedMessageParameters

public CheckpointStatusMessageParameters getUnresolvedMessageParameters()

Description copied from interface: UntypedResponseMessageHeaders

Returns a new MessageParameters object.

Returns:

new message parameters object

getHttpMethod

public HttpMethodWrapper getHttpMethod()

Description copied from interface: RestHandlerSpecification

Returns the HttpMethodWrapper to be used for the request.

Returns:

http method to be used for the request

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.

Returns:

endpoint url that this request should be sent to

getValueClass

public Class<CheckpointInfo> getValueClass()

Description copied from class: AsynchronousOperationStatusMessageHeaders

Returns the class of the value wrapped in the AsynchronousOperationResult.

Specified by:

getValueClass in class AsynchronousOperationStatusMessageHeaders<CheckpointInfo,CheckpointStatusMessageParameters>

Returns:

value class

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Returns:

description for the header

getInstance

public static CheckpointStatusHeaders getInstance()