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

Class SavepointStatusHeaders

java.lang.Object

org.apache.flink.runtime.rest.handler.async.AsynchronousOperationStatusMessageHeaders<SavepointInfo,SavepointStatusMessageParameters>

org.apache.flink.runtime.rest.messages.job.savepoints.SavepointStatusHeaders

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<EmptyRequestBody,AsynchronousOperationResult<SavepointInfo>,SavepointStatusMessageParameters>, RuntimeMessageHeaders<EmptyRequestBody,AsynchronousOperationResult<SavepointInfo>,SavepointStatusMessageParameters>, UntypedResponseMessageHeaders<EmptyRequestBody,SavepointStatusMessageParameters>

public class SavepointStatusHeaders
extends AsynchronousOperationStatusMessageHeaders<SavepointInfo,SavepointStatusMessageParameters>

These headers define the protocol for triggering a savepoint.

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 SavepointStatusHeaders	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.
SavepointStatusMessageParameters	getUnresolvedMessageParameters()	Returns a new MessageParameters object.
Class<SavepointInfo>	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 Details

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

getInstance

public static SavepointStatusHeaders getInstance()

getValueClass

public Class<SavepointInfo> getValueClass()

Description copied from class: AsynchronousOperationStatusMessageHeaders

Returns the class of the value wrapped in the AsynchronousOperationResult.

Specified by:

getValueClass in class AsynchronousOperationStatusMessageHeaders<SavepointInfo,SavepointStatusMessageParameters>

Returns:

value class

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Returns:

description for the header