Package org.apache.flink.runtime.rest.handler.job.rescaling

Class RescalingHandlers.RescalingTriggerHandler

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler<RoutedRequest>

org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler<T>

org.apache.flink.runtime.rest.handler.AbstractHandler<T,R,M>

org.apache.flink.runtime.rest.handler.AbstractRestHandler<T,B,TriggerResponse,M>

AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.TriggerHandler<RestfulGateway,EmptyRequestBody,RescalingTriggerMessageParameters>

org.apache.flink.runtime.rest.handler.job.rescaling.RescalingHandlers.RescalingTriggerHandler

All Implemented Interfaces:

AutoCloseable, org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler, org.apache.flink.util.AutoCloseableAsync

Enclosing class:

RescalingHandlers

public class RescalingHandlers.RescalingTriggerHandler
extends AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.TriggerHandler<RestfulGateway,EmptyRequestBody,RescalingTriggerMessageParameters>

Handler which triggers the rescaling of the specified job.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

Fields inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

Constructor Summary

Constructors

Constructor	Description
RescalingTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders)

Method Summary

Modifier and Type	Method	Description
protected AsynchronousJobOperationKey	createOperationKey(HandlerRequest<EmptyRequestBody> request)	Create the operation key under which the result future of the asynchronous operation will be stored.
CompletableFuture<TriggerResponse>	handleRequest(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)	This method is called for every incoming request and returns a CompletableFuture containing a the response.
protected CompletableFuture<Acknowledge>	triggerOperation(HandlerRequest<EmptyRequestBody> request, RestfulGateway gateway)	Trigger the asynchronous operation and return its future result.

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractRestHandler

getMessageHeaders, respondToRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

Methods inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0, getTimeout

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

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.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Details

RescalingTriggerHandler

public RescalingTriggerHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
 Duration timeout,
 Map<String,String> responseHeaders)

Method Details

handleRequest

public CompletableFuture<TriggerResponse> handleRequest(@Nonnull
 HandlerRequest<EmptyRequestBody> request,
 @Nonnull
 RestfulGateway gateway)
                                                 throws RestHandlerException

Description copied from class: AbstractRestHandler

This method is called for every incoming request and returns a CompletableFuture containing a the response.

Implementations may decide whether to throw RestHandlerExceptions or fail the returned CompletableFuture with a RestHandlerException.

Failing the future with another exception type or throwing unchecked exceptions is regarded as an implementation error as it does not allow us to provide a meaningful HTTP status code. In this case a HttpResponseStatus.INTERNAL_SERVER_ERROR will be returned.

Overrides:

handleRequest in class AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.TriggerHandler<RestfulGateway,EmptyRequestBody,RescalingTriggerMessageParameters>

Parameters:

request - request that should be handled

gateway - leader gateway

Returns:

future containing a handler response

Throws:

RestHandlerException - if the handling failed

triggerOperation

protected CompletableFuture<Acknowledge> triggerOperation(HandlerRequest<EmptyRequestBody> request,
 RestfulGateway gateway)

Description copied from class: AbstractAsynchronousOperationHandlers.TriggerHandler

Trigger the asynchronous operation and return its future result.

Specified by:

triggerOperation in class AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.TriggerHandler<RestfulGateway,EmptyRequestBody,RescalingTriggerMessageParameters>

Parameters:

request - with which the trigger handler has been called

gateway - to the leader

Returns:

Future result of the asynchronous operation

createOperationKey

protected AsynchronousJobOperationKey createOperationKey(HandlerRequest<EmptyRequestBody> request)

Description copied from class: AbstractAsynchronousOperationHandlers.TriggerHandler

Create the operation key under which the result future of the asynchronous operation will be stored.

Specified by:

createOperationKey in class AbstractAsynchronousOperationHandlers<AsynchronousJobOperationKey,Acknowledge>.TriggerHandler<RestfulGateway,EmptyRequestBody,RescalingTriggerMessageParameters>

Parameters:

request - with which the trigger handler has been called.

Returns:

Operation key under which the result future will be stored