water.api.schemas3

Class H2OErrorV3<I extends H2OError,S extends H2OErrorV3<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

H2OModelBuilderErrorV3

public class H2OErrorV3<I extends H2OError,S extends H2OErrorV3<I,S>>
extends SchemaV3<I,S>
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.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	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
IcedHashMapGeneric.IcedHashMapStringObject	values

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
H2OErrorV3()

Method Summary

Modifier and Type	Method and Description
int	httpStatus()

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

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 IcedHashMapGeneric.IcedHashMapStringObject 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

H2OErrorV3

public H2OErrorV3()

Method Detail

httpStatus

public int httpStatus()

Specified by:

httpStatus in interface SpecifiesHttpResponseCode