water.api

Class RestApiHandler<IS extends Schema,OS extends Schema>

java.lang.Object

jsr166y.ForkJoinTask<java.lang.Void>

jsr166y.CountedCompleter

water.H2O.H2OCountedCompleter<Handler>

water.api.Handler

water.api.RestApiHandler<IS,OS>

Type Parameters:

IS - input schema class

OS - output schema class

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.concurrent.Future<java.lang.Void>, Freezable<Handler>

Direct Known Subclasses:

CreateFrameHandler.CreateSimpleFrame, JobsHandler.FetchJob, RapidsHandler.StartSession4

public abstract class RestApiHandler<IS extends Schema,OS extends Schema>
extends Handler

Common interface for all some REST endpoint handlers.

This class is a preferred way for adding new REST endpoints.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RestApiHandler()

Method Summary

Modifier and Type	Method and Description
abstract OS	exec(int ignored, IS input) Execute the endpoint, returning the result as the output schema.
abstract java.lang.String	help() Help for this endpoint (will be used in generated bindings).
abstract java.lang.String	name() Suggested name for the endpoint in external libraries.

Methods inherited from class water.api.Handler

getFromDKV, getFromDKV, getHandlerMethodInputSchema, getHandlerMethodOutputSchema, handle, markdown

Methods inherited from class water.H2O.H2OCountedCompleter

asBytes, clone, compute, compute1, compute2, currThrPriority, frozenType, icer, priority, read, readJSON, reloadFromBytes, write, writeJSON

Methods inherited from class jsr166y.CountedCompleter

__tryComplete, addToPendingCount, compareAndSetPendingCount, complete, exec, getCompleter, getPendingCount, getRawResult, onCompletion, onExceptionalCompletion, setCompleter, setPendingCount, setRawResult, tryComplete

Methods inherited from class jsr166y.ForkJoinTask

adapt, adapt, adapt, cancel, compareAndSetForkJoinTaskTag, completeExceptionally, fork, get, get, get, getException, getForkJoinTaskTag, getPool, getQueuedTaskCount, getSurplusQueuedTaskCount, helpQuiesce, inForkJoinPool, invoke, invokeAll, invokeAll, invokeAll, isCancelled, isCompletedAbnormally, isCompletedNormally, isDone, join, peekNextLocalTask, pollNextLocalTask, pollTask, quietlyComplete, quietlyInvoke, quietlyJoin, reinitialize, setForkJoinTaskTag, tryUnfork

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestApiHandler

public RestApiHandler()

Method Detail

name

public abstract java.lang.String name()

Suggested name for the endpoint in external libraries.

help

public abstract java.lang.String help()

Help for this endpoint (will be used in generated bindings).

exec

public abstract OS exec(int ignored,
                        IS input)

Execute the endpoint, returning the result as the output schema.

Parameters:

ignored - TODO: remove this parameter

input - input schema object

Returns:

output schema object