AiExtractStructuredFieldsField (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - AiExtractStructuredFieldsField

All Implemented Interfaces:: Serializable

public class AiExtractStructuredFieldsField
extends SerializableObject

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AiExtractStructuredFieldsField.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`AiExtractStructuredFieldsField.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description` A description of the field.
`protected String`	`displayName` The display name of the field.
`protected List<AiExtractSubField>`	`fields` The nested fields for this field.
`protected String`	`key` A unique identifier for the field.
`protected String`	`namespace` The namespace of the taxonomy source.
`protected List<AiExtractStructuredFieldsOptionsField>`	`options` A list of options for this field.
`protected AiOptionsRules`	`optionsRules`
`protected String`	`prompt` The context about the key that may include how to find and format it.
`protected String`	`taxonomyKey` The identifier for a taxonomy, which corresponds to the `key` of the taxonomy source.
`protected String`	`type` The type of the field.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AiExtractStructuredFieldsField(AiExtractStructuredFieldsField.Builder builder)`
	`AiExtractStructuredFieldsField(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getDescription()`
`String`	`getDisplayName()`
`List<AiExtractSubField>`	`getFields()`
`String`	`getKey()`
`String`	`getNamespace()`
`List<AiExtractStructuredFieldsOptionsField>`	`getOptions()`
`AiOptionsRules`	`getOptionsRules()`
`String`	`getPrompt()`
`String`	`getTaxonomyKey()`
`String`	`getType()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - key
```
protected final String key
```
    A unique identifier for the field.
  - description
```
protected String description
```
    A description of the field.
  - displayName
```
protected String displayName
```
    The display name of the field.
  - prompt
```
protected String prompt
```
    The context about the key that may include how to find and format it.
  - type
```
protected String type
```
    The type of the field. It can include but is not limited to `string`, `float`, `date`, `enum`, `multiSelect`,`taxonomy`, `struct`, and `table`.
  - options
```
protected List<AiExtractStructuredFieldsOptionsField> options
```
    A list of options for this field. This is most often used in combination with the `enum` and `multiSelect` field types.
  - fields
```
protected List<AiExtractSubField> fields
```
    The nested fields for this field. Used with `struct` and `table` field types to define the nested structure.
  - taxonomyKey
```
protected String taxonomyKey
```
    The identifier for a taxonomy, which corresponds to the `key` of the taxonomy source. Required if using `taxonomy` type field.
  - namespace
```
protected String namespace
```
    The namespace of the taxonomy source. Required if using `taxonomy` type field from an existing taxonomy.
  - optionsRules
```
protected AiOptionsRules optionsRules
```
- Constructor Detail
  - AiExtractStructuredFieldsField
```
public AiExtractStructuredFieldsField(String key)
```
  - AiExtractStructuredFieldsField
```
protected AiExtractStructuredFieldsField(AiExtractStructuredFieldsField.Builder builder)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - getDescription
```
public String getDescription()
```
  - getDisplayName
```
public String getDisplayName()
```
  - getPrompt
```
public String getPrompt()
```
  - getType
```
public String getType()
```
  - getOptions
```
public List<AiExtractStructuredFieldsOptionsField> getOptions()
```
  - getFields
```
public List<AiExtractSubField> getFields()
```
  - getTaxonomyKey
```
public String getTaxonomyKey()
```
  - getNamespace
```
public String getNamespace()
```
  - getOptionsRules
```
public AiOptionsRules getOptionsRules()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AiExtractStructuredFieldsField

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

key

description

displayName

prompt

type

options

fields

taxonomyKey

namespace

optionsRules

Constructor Detail

AiExtractStructuredFieldsField

AiExtractStructuredFieldsField

Method Detail

getKey

getDescription

getDisplayName

getPrompt

getType

getOptions

getFields

getTaxonomyKey

getNamespace

getOptionsRules

equals

hashCode

toString