water.api

Class RequestSchema<I extends Iced,S extends Schema<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.RequestSchema<I,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

AboutHandler.AboutV3, CloudV3, DownloadDataV3, InitIDV3, JobsV3, JStackV3, KillMinus3V3, LogAndEchoV3, LogsV3, MetadataBase, ModelBuilderSchema, ModelBuildersV3, ModelExportV3, ModelImportV3, NetworkTestV3, NodePersistentStorageV3, ParseSetupV3, ParseV3, ProfilerV3, RapidsV3, RemoveAllV3, RemoveV3, ShutdownV3, TimelineV3, TutorialsV3, TypeaheadV3, UnlockKeysV3, WaterMeterCpuTicksV3, WaterMeterIoV3

public class RequestSchema<I extends Iced,S extends Schema<I,S>>
extends Schema<I,S>

Base Schema class for all REST API requests, gathering up common behavior such as the __exclude_fields/__include_fields query params.

See Also:

Serialized Form

Nested Class Summary

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_exclude_fields

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
RequestSchema()

Method Summary

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromImpl, fillFromParms, fillImpl, getExperimentalVersion, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, markdown, markdown, markdown, markdown, newInstance, register, registerAllSchemasIfNecessary, schema, schema, schema, schema, schema, schemaClass, schemaClass, schemaClass, schemaClass, schemas

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

_exclude_fields

@API(help="Comma-separated list of JSON field paths to exclude from the result, used like: \"/3/Frames?_exclude_fields=frames/frame_id/URL,__meta\"",
     direction=INPUT)
public java.lang.String _exclude_fields

Constructor Detail

RequestSchema

public RequestSchema()