water.bindings.pojos

Class FieldMetadataBase

java.lang.Object

water.bindings.pojos.Schema

water.bindings.pojos.FieldMetadataBase

Direct Known Subclasses:

FieldMetadataV3

public class FieldMetadataBase
extends Schema

Field Summary

Fields

Modifier and Type	Field and Description
ApiAPIDirection	direction Is this field an input, output or inout?
java.lang.String	help A short help description to appear alongside the field in a UI
java.lang.String	inherited_from If this field is inherited from a class higher in the hierarchy which one?
boolean	is_gridable Is the field gridable (i.e., it can be used in grid call)
boolean	is_inherited Is the field inherited from the parent schema?
java.lang.String[]	is_member_of_frames 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
java.lang.String[]	is_mutually_exclusive_with 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
boolean	is_schema Type for this field is itself a Schema.
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
ApiAPILevel	level How important is this field? The web UI uses the level to do a slow reveal of the parameters
java.lang.String	name Field name in the Schema
boolean	required Is this field required, or is the default value generally sufficient?
java.lang.String	schema_name Schema name for this field, if it is_schema, or the name of the enum, if it's an enum.
java.lang.String	type Type for this field
java.lang.Object	value Value for this field
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

Constructor Summary

Constructors

Constructor and Description
FieldMetadataBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	toString() Return the contents of this object as a JSON String.

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

Field name in the Schema

type

public java.lang.String type

Type for this field

is_schema

public boolean is_schema

Type for this field is itself a Schema.

schema_name

public java.lang.String schema_name

Schema name for this field, if it is_schema, or the name of the enum, if it's an enum.

value

public java.lang.Object value

Value for this field

help

public java.lang.String help

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

label

public java.lang.String label

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

required

public boolean required

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

level

public ApiAPILevel level

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

direction

public ApiAPIDirection direction

Is this field an input, output or inout?

is_inherited

public boolean is_inherited

Is the field inherited from the parent schema?

inherited_from

public java.lang.String inherited_from

If this field is inherited from a class higher in the hierarchy which one?

is_gridable

public boolean is_gridable

Is the field gridable (i.e., it can be used in grid call)

values

public 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

json

public boolean json

Should this field be rendered in the JSON representation?

is_member_of_frames

public java.lang.String[] is_member_of_frames

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

is_mutually_exclusive_with

public java.lang.String[] is_mutually_exclusive_with

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

Constructor Detail

FieldMetadataBase

public FieldMetadataBase()

Method Detail

toString

public java.lang.String toString()

Return the contents of this object as a JSON String.

Overrides:

toString in class Schema