water.api.schemas4

Class EndpointV4

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas4.OutputSchemaV4<Route,EndpointV4>

water.api.schemas4.EndpointV4

All Implemented Interfaces:

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

public class EndpointV4
extends OutputSchemaV4<Route,EndpointV4>

See Also:

Serialized Form

Nested Class Summary

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

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	description
java.lang.String	input_schema
java.lang.String	name
java.lang.String	output_schema
java.lang.String	url

Fields inherited from class water.api.schemas4.OutputSchemaV4

__schema

Constructor Summary

Constructors

Constructor and Description
EndpointV4()

Method Summary

Modifier and Type	Method and Description
EndpointV4	fillFromImpl(Route route) Fill this Schema from the given implementation object.

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, 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, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

url

@API(help="Method+Url of the request; variable parts are enclosed in curly braces. For example: /4/schemas/{schema_name}")
public java.lang.String url

description

@API(help="Short description of the functionality provided by the endpoint.")
public java.lang.String description

name

@API(help="Unique name of the endpoint. These names can be used to look up the endpoint\'s info via GET /4/endpoints/{name}.")
public java.lang.String name

input_schema

@API(help="Input schema.")
public java.lang.String input_schema

output_schema

@API(help="Schema for the result returned by the endpoint.")
public java.lang.String output_schema

Constructor Detail

EndpointV4

public EndpointV4()

Method Detail

fillFromImpl

public EndpointV4 fillFromImpl(Route route)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

fillFromImpl in class Schema<Route,EndpointV4>