Freigeben über

ContentFieldSchema Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.ContentFieldSchema

Implements

JsonSerializable<ContentFieldSchema>

public final class ContentFieldSchema
implements JsonSerializable<ContentFieldSchema>

Schema of fields to be extracted from documents.

Constructor Summary

Constructor Description
ContentFieldSchema()

Creates an instance of ContentFieldSchema class.

Method Summary

Modifier and Type Method and Description
static ContentFieldSchema fromJson(JsonReader jsonReader)

Reads an instance of ContentFieldSchema from the JsonReader.
Map<String,ContentFieldDefinition> getDefinitions()

Get the definitions property: Additional definitions referenced by the fields in the schema.
String getDescription()

Get the description property: A description of the field schema.
Map<String,ContentFieldDefinition> getFields()

Get the fields property: The fields defined in the schema.
String getName()

Get the name property: The name of the field schema.
ContentFieldSchema setDefinitions(Map<String,ContentFieldDefinition> definitions)

Set the definitions property: Additional definitions referenced by the fields in the schema.
ContentFieldSchema setDescription(String description)

Set the description property: A description of the field schema.
ContentFieldSchema setFields(Map<String,ContentFieldDefinition> fields)

Set the fields property: The fields defined in the schema.
ContentFieldSchema setName(String name)

Set the name property: The name of the field schema.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ContentFieldSchema

public ContentFieldSchema()

Creates an instance of ContentFieldSchema class.

Method Details

fromJson

public static ContentFieldSchema fromJson(JsonReader jsonReader)

Reads an instance of ContentFieldSchema from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ContentFieldSchema if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the ContentFieldSchema.

getDefinitions

public Map<String,ContentFieldDefinition> getDefinitions()

Get the definitions property: Additional definitions referenced by the fields in the schema.

Returns:

the definitions value.

getDescription

public String getDescription()

Get the description property: A description of the field schema.

Returns:

the description value.

getFields

public Map<String,ContentFieldDefinition> getFields()

Get the fields property: The fields defined in the schema.

Returns:

the fields value.

getName

public String getName()

Get the name property: The name of the field schema.

Returns:

the name value.

setDefinitions

public ContentFieldSchema setDefinitions(Map<String,ContentFieldDefinition> definitions)

Set the definitions property: Additional definitions referenced by the fields in the schema.

Parameters:

definitions - the definitions value to set.

Returns:

the ContentFieldSchema object itself.

setDescription

public ContentFieldSchema setDescription(String description)

Set the description property: A description of the field schema.

Parameters:

description - the description value to set.

Returns:

the ContentFieldSchema object itself.

setFields

public ContentFieldSchema setFields(Map<String,ContentFieldDefinition> fields)

Set the fields property: The fields defined in the schema.

Required when create the resource.

Parameters:

fields - the fields value to set.

Returns:

the ContentFieldSchema object itself.

setName

public ContentFieldSchema setName(String name)

Set the name property: The name of the field schema.

Parameters:

name - the name value to set.

Returns:

the ContentFieldSchema object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to