water.api

Annotation Type API

@Retention(value=RUNTIME)
@Target(value=FIELD)
@Documented
public @interface API

API Annotation API annotations are used to document field behaviors for the external REST API. Each field is described by a matching Java field, plus these annotations.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	help A short help description to appear alongside the field in a UI.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
API.Direction	direction Is this field an input, output or inout?
boolean	gridable Identify grid-able parameter.
java.lang.String[]	is_member_of_frames For Vec-type fields this is the set of Frame-type fields which must contain the named column.
java.lang.String[]	is_mutually_exclusive_with For Vec-type fields this is the set of other Vec-type fields which must contain mutually exclusive values.
boolean	json Should this field be rendered in the JSON representation?
java.lang.String	label The label that should be displayed for the field if the name is insufficient.
API.Level	level How important is this field? The web UI uses the level to do a slow reveal of the parameters.
boolean	required Is this field required, or is the default value generally sufficient?
java.lang.String[]	values For enum-type fields the allowed values are specified using the values annotation.
java.lang.Class<? extends ValuesProvider>	valuesProvider Proovide values for enum-like types if it cannot be provided as a constant in annotation.

Element Detail

help

public abstract java.lang.String help

A short help description to appear alongside the field in a UI.

label

public abstract java.lang.String label

The label that should be displayed for the field if the name is insufficient.

Default:

""

required

public abstract boolean required

Is this field required, or is the default value generally sufficient?

Default:

false

level

public abstract API.Level level

How important is this field? The web UI uses the level to do a slow reveal of the parameters.

Default:

water.api.API.Level.critical

direction

public abstract API.Direction direction

Is this field an input, output or inout?

Default:

water.api.API.Direction.INPUT

values

public abstract java.lang.String[] values

For enum-type fields the allowed values are specified using the values annotation. This is used in UIs to tell the user the allowed values, and for validation.

Default:

{}

valuesProvider

public abstract java.lang.Class<? extends ValuesProvider> valuesProvider

Proovide values for enum-like types if it cannot be provided as a constant in annotation.

Default:

water.api.ValuesProvider.class

json

public abstract boolean json

Should this field be rendered in the JSON representation?

Default:

true

is_member_of_frames

public abstract java.lang.String[] is_member_of_frames

For Vec-type fields this is the set of Frame-type fields which must contain the named column. For example, for a SupervisedModel the response_column must be in both the training_frame and (if it's set) the validation_frame.

Default:

{}

is_mutually_exclusive_with

public abstract java.lang.String[] is_mutually_exclusive_with

For Vec-type fields this is the set of other Vec-type fields which must contain mutually exclusive values. For example, for a SupervisedModel the response_column must be mutually exclusive with the weights_column.

Default:

{}

gridable

public abstract boolean gridable

Identify grid-able parameter.

Default:

false