com.box.sdkgen.schemas.aiextractstructured

Class AiExtractStructuredFieldsField

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

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 String	key A unique identifier for the field.
protected List<AiExtractStructuredFieldsOptionsField>	options A list of options for this field.
protected String	prompt The context about the key that may include how to find and format it.
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

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
String	getDisplayName()
String	getKey()
List<AiExtractStructuredFieldsOptionsField>	getOptions()
String	getPrompt()
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`, and `multiSelect`.

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.

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()

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