org.apache.flink.runtime.rest.handler.async

Class AsynchronousOperationTriggerMessageHeaders<R extends RequestBody,M extends MessageParameters>

java.lang.Object

org.apache.flink.runtime.rest.handler.async.AsynchronousOperationTriggerMessageHeaders<R,M>

Type Parameters:

R - type of the request

M - type of the message parameters

All Implemented Interfaces:

RestHandlerSpecification, MessageHeaders<R,TriggerResponse,M>, RuntimeMessageHeaders<R,TriggerResponse,M>, UntypedResponseMessageHeaders<R,M>

Direct Known Subclasses:

CheckpointTriggerHeaders, ClusterDataSetDeleteTriggerHeaders, RescalingTriggerHeaders, SavepointDisposalTriggerHeaders, SavepointTriggerHeaders, StopWithSavepointTriggerHeaders

public abstract class AsynchronousOperationTriggerMessageHeaders<R extends RequestBody,M extends MessageParameters>
extends Object
implements RuntimeMessageHeaders<R,TriggerResponse,M>

Message headers for the triggering of an asynchronous operation.

Constructor Summary

Constructors

Constructor and Description
AsynchronousOperationTriggerMessageHeaders()

Method Summary

Modifier and Type	Method and Description
protected abstract String	getAsyncOperationDescription() Returns the description for this async operation header.
String	getDescription() Returns the description for this header.
Class<TriggerResponse>	getResponseClass() Returns the class of the response message.

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.RuntimeMessageHeaders

getSupportedAPIVersions

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

getCustomHeaders, getResponseStatusCode, getResponseTypeParameters, operationId

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

acceptsFileUploads, getRequestClass, getUnresolvedMessageParameters

Methods inherited from interface org.apache.flink.runtime.rest.handler.RestHandlerSpecification

getHttpMethod, getTargetRestEndpointURL

Constructor Detail

AsynchronousOperationTriggerMessageHeaders

public AsynchronousOperationTriggerMessageHeaders()

Method Detail

getResponseClass

public Class<TriggerResponse> getResponseClass()

Description copied from interface: MessageHeaders

Returns the class of the response message.

Specified by:

getResponseClass in interface MessageHeaders<R extends RequestBody,TriggerResponse,M extends MessageParameters>

Returns:

class of the response message

getDescription

public String getDescription()

Description copied from interface: MessageHeaders

Returns the description for this header.

Specified by:

getDescription in interface MessageHeaders<R extends RequestBody,TriggerResponse,M extends MessageParameters>

Returns:

description for the header

getAsyncOperationDescription

protected abstract String getAsyncOperationDescription()

Returns the description for this async operation header.

Returns:

the description for this async operation header.