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

Class StopWithSavepointTriggerHeaders

java.lang.Object

org.apache.flink.runtime.rest.handler.async.AsynchronousOperationTriggerMessageHeaders<StopWithSavepointRequestBody,SavepointTriggerMessageParameters>

org.apache.flink.runtime.rest.messages.job.savepoints.stop.StopWithSavepointTriggerHeaders

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<StopWithSavepointRequestBody,TriggerResponse,SavepointTriggerMessageParameters>, RuntimeMessageHeaders<StopWithSavepointRequestBody,TriggerResponse,SavepointTriggerMessageParameters>, UntypedResponseMessageHeaders<StopWithSavepointRequestBody,SavepointTriggerMessageParameters>

public class StopWithSavepointTriggerHeaders
extends AsynchronousOperationTriggerMessageHeaders<StopWithSavepointRequestBody,SavepointTriggerMessageParameters>

These headers define the protocol for triggering a "stop" action.

Method Summary

Modifier and Type	Method	Description
protected String	getAsyncOperationDescription()	Returns the description for this async operation header.
HttpMethodWrapper	getHttpMethod()	Returns the HttpMethodWrapper to be used for the request.
static StopWithSavepointTriggerHeaders	getInstance()
Class<StopWithSavepointRequestBody>	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.
SavepointTriggerMessageParameters	getUnresolvedMessageParameters()	Returns a new MessageParameters object.
String	operationId()	Returns a short description for this header suitable for method code generation.

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

getDescription, getResponseClass

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

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<StopWithSavepointRequestBody> 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 SavepointTriggerMessageParameters 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 StopWithSavepointTriggerHeaders getInstance()

getAsyncOperationDescription

protected String getAsyncOperationDescription()

Description copied from class: AsynchronousOperationTriggerMessageHeaders

Returns the description for this async operation header.

Specified by:

getAsyncOperationDescription in class AsynchronousOperationTriggerMessageHeaders<StopWithSavepointRequestBody,SavepointTriggerMessageParameters>

Returns:

the description for this async operation header.

operationId

public String operationId()

Description copied from interface: MessageHeaders

Returns a short description for this header suitable for method code generation.

Returns:

short description