water.api

Class MetadataHandler

java.lang.Object

jsr166y.ForkJoinTask<java.lang.Void>

jsr166y.CountedCompleter

water.H2O.H2OCountedCompleter<Handler>

water.api.Handler

water.api.MetadataHandler

All Implemented Interfaces:

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

public class MetadataHandler
extends Handler

Docs REST API handler, which provides endpoint handlers for the autogeneration of Markdown (and in the future perhaps HTML and PDF) documentation for REST API endpoints and payload entities (aka Schemas).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataHandler()

Method Summary

Modifier and Type	Method and Description
MetadataV3	fetchRoute(int version, MetadataV3 docs) Return the metadata for a REST API Route, specified either by number or path.
MetadataV3	fetchSchemaMetadata(int version, MetadataV3 docs) Fetch the metadata for a Schema by its simple Schema name (e.g., "DeepLearningParametersV2").
MetadataV3	fetchSchemaMetadataByClass(int version, MetadataV3 docs) Deprecated.
MetadataV3	listRoutes(int version, MetadataV3 docs) Return a list of all REST API Routes and a Markdown Table of Contents.
EndpointsListV4	listRoutes4(int version, ListRequestV4 inp)
MetadataV3	listSchemas(int version, MetadataV3 docs) Fetch the metadata for all the Schemas.

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

MetadataHandler

public MetadataHandler()

Method Detail

listRoutes

public MetadataV3 listRoutes(int version,
                             MetadataV3 docs)

Return a list of all REST API Routes and a Markdown Table of Contents.

listRoutes4

public EndpointsListV4 listRoutes4(int version,
                                   ListRequestV4 inp)

fetchRoute

public MetadataV3 fetchRoute(int version,
                             MetadataV3 docs)

Return the metadata for a REST API Route, specified either by number or path.

fetchSchemaMetadataByClass

@Deprecated
public MetadataV3 fetchSchemaMetadataByClass(int version,
                                                         MetadataV3 docs)

Deprecated.

Fetch the metadata for a Schema by its full internal classname, e.g. "hex.schemas.DeepLearningV2.DeepLearningParametersV2". TODO: Do we still need this?

fetchSchemaMetadata

public MetadataV3 fetchSchemaMetadata(int version,
                                      MetadataV3 docs)

Fetch the metadata for a Schema by its simple Schema name (e.g., "DeepLearningParametersV2").

listSchemas

public MetadataV3 listSchemas(int version,
                              MetadataV3 docs)

Fetch the metadata for all the Schemas.