water.api

Class H2OErrorV1

java.lang.Object

water.Iced

water.api.Schema<H2OError,H2OErrorV1>

water.api.H2OErrorV1

All Implemented Interfaces:

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

public class H2OErrorV1
extends Schema<H2OError,H2OErrorV1>
implements SpecifiesHttpResponseCode

Schema which represents a back-end error which will be returned to the client. Such errors may be caused by the user (specifying an object which has been removed) or due to a failure which is out of the user's control.

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	dev_msg
java.lang.String	exception_msg
java.lang.String	exception_type
int	http_status
java.lang.String	msg
java.lang.String[]	stacktrace
long	timestamp
IcedHashMap	values

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

Constructor Summary

Constructors

Constructor and Description
H2OErrorV1()

Method Summary

Methods

Modifier and Type	Method and Description
int	httpStatus()
DocGen.HTML	writeHTML_impl(DocGen.HTML ab) Implementation of the Iced serialization protocol, only called by auto-genned code.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromImpl, fillFromParms, fillImpl, 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, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

timestamp

@API(help="Milliseconds since the epoch for the time that this H2OError instance was created.  Generally this is a short time since the underlying error ocurred.",
     direction=OUTPUT)
public long timestamp

msg

@API(help="Message intended for the end user (a data scientist).",
     direction=OUTPUT)
public java.lang.String msg

dev_msg

@API(help="Potentially more detailed message intended for a developer (e.g. a front end engineer or someone designing a language binding).",
     direction=OUTPUT)
public java.lang.String dev_msg

http_status

@API(help="HTTP status code for this error.",
     direction=OUTPUT)
public int http_status

values

@API(help="Any values that are relevant to reporting or handling this error.  Examples are a key name if the error is on a key, or a field name and object name if it\'s on a specific field.",
     direction=OUTPUT)
public IcedHashMap values

exception_type

@API(help="Exception type, if any.",
     direction=OUTPUT)
public java.lang.String exception_type

exception_msg

@API(help="Raw exception message, if any.",
     direction=OUTPUT)
public java.lang.String exception_msg

stacktrace

@API(help="Stacktrace, if any.",
     direction=OUTPUT)
public java.lang.String[] stacktrace

Constructor Detail

H2OErrorV1

public H2OErrorV1()

Method Detail

httpStatus

public int httpStatus()

Specified by:

httpStatus in interface SpecifiesHttpResponseCode

writeHTML_impl

public DocGen.HTML writeHTML_impl(DocGen.HTML ab)

Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

writeHTML_impl in interface Freezable

Overrides:

writeHTML_impl in class Iced

Parameters:

ab - html to write object to.

Returns:

Returns the instance of HTML object.