water.api.schemas3

Class MetadataV3

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<I,S>

water.api.schemas3.RequestSchemaV3<Iced,MetadataV3>

water.api.schemas3.MetadataV3

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

public final class MetadataV3
extends RequestSchemaV3<Iced,MetadataV3>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.schemas3.SchemaV3

SchemaV3.Meta

Nested classes/interfaces inherited from class water.api.Schema

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	classname
java.lang.String	http_method
java.lang.String	markdown
int	num
java.lang.String	path
RouteV3[]	routes
java.lang.String	schemaname
SchemaMetadataV3[]	schemas

Fields inherited from class water.api.schemas3.RequestSchemaV3

_exclude_fields

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
MetadataV3()

Method Summary

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

num

@API(help="Number for specifying an endpoint",
     json=false)
public int num

http_method

@API(help="HTTP method (GET, POST, DELETE) if fetching by path",
     json=false)
public java.lang.String http_method

path

@API(help="Path for specifying an endpoint",
     json=false)
public java.lang.String path

classname

@API(help="Class name, for fetching docs for a schema (DEPRECATED)",
     json=false)
public java.lang.String classname

schemaname

@API(help="Schema name (e.g., DocsV1), for fetching docs for a schema",
     json=false)
public java.lang.String schemaname

routes

@API(help="List of endpoint routes",
     direction=OUTPUT)
public RouteV3[] routes

schemas

@API(help="List of schemas",
     direction=OUTPUT)
public SchemaMetadataV3[] schemas

markdown

@API(help="Table of Contents Markdown",
     direction=OUTPUT)
public java.lang.String markdown

Constructor Detail

MetadataV3

public MetadataV3()