FieldMetadataV3 (h2o-bindings 3.44.0 API)

java.lang.Object
- water.bindings.pojos.SchemaV3
- - water.bindings.pojos.FieldMetadataV3

public class FieldMetadataV3
extends SchemaV3

Field Summary

Fields
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 Summary

Constructors
Constructor and Description

FieldMetadataV3()
Public constructor

Constructors
Constructor and Description
`FieldMetadataV3()` Public constructor

Method Summary

All Methods Instance Methods Concrete 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

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

- Field Detail
  - name
```
public java.lang.String name
```
    Field name in the Schema
  - type
```
public java.lang.String type
```
    Type for this field
  - isSchema
```
@SerializedName(value="is_schema")
public boolean isSchema
```
    Type for this field is itself a Schema.
  - schemaName
```
@SerializedName(value="schema_name")
public java.lang.String schemaName
```
    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 APILevel level
```
    How important is this field? The web UI uses the level to do a slow reveal of the parameters
  - direction
```
public APIDirection direction
```
    Is this field an input, output or inout?
  - isInherited
```
@SerializedName(value="is_inherited")
public boolean isInherited
```
    Is the field inherited from the parent schema?
  - inheritedFrom
```
@SerializedName(value="inherited_from")
public java.lang.String inheritedFrom
```
    If this field is inherited from a class higher in the hierarchy which one?
  - isGridable
```
@SerializedName(value="is_gridable")
public boolean isGridable
```
    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?
  - isMemberOfFrames
```
@SerializedName(value="is_member_of_frames")
public 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
  - isMutuallyExclusiveWith
```
@SerializedName(value="is_mutually_exclusive_with")
public 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
- Constructor Detail
  - FieldMetadataV3
```
public FieldMetadataV3()
```
    Public constructor
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Return the contents of this object as a JSON String.
    
    Overrides:
    
    toString in class SchemaV3

Class FieldMetadataV3

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

type

isSchema

schemaName

value

help

label

required

level

direction

isInherited

inheritedFrom

isGridable

values

json

isMemberOfFrames

isMutuallyExclusiveWith

Constructor Detail

FieldMetadataV3

Method Detail

toString