public class FieldMetadataV3 extends SchemaV3
| Modifier and Type | Field and Description |
|---|---|
APIDirection |
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 |
inheritedFrom
If this field is inherited from a class higher in the hierarchy which one?
|
boolean |
isGridable
Is the field gridable (i.e., it can be used in grid call)
|
boolean |
isInherited
Is the field inherited from the parent schema?
|
java.lang.String[] |
isMemberOfFrames
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[] |
isMutuallyExclusiveWith
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 |
isSchema
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
|
APILevel |
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 |
schemaName
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 and Description |
|---|
FieldMetadataV3()
Public constructor
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
toString()
Return the contents of this object as a JSON String.
|
public java.lang.String name
public java.lang.String type
public boolean isSchema
public java.lang.String schemaName
public java.lang.Object value
public java.lang.String help
public java.lang.String label
public boolean required
public APILevel level
public APIDirection direction
public boolean isInherited
public java.lang.String inheritedFrom
public boolean isGridable
public java.lang.String[] values
public boolean json
public java.lang.String[] isMemberOfFrames
public java.lang.String[] isMutuallyExclusiveWith