KnowledgeBaseFileReference Class

public final class KnowledgeBaseFileReference
extends KnowledgeBaseReference

Represents a file document reference.

Method Summary

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

Reads an instance of KnowledgeBaseFileReference from the JsonReader.

String getDocName()

Get the docName property: The document name for the reference.

KnowledgeBaseReferenceType getType()

Get the type property: The type of the reference.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from KnowledgeBaseReference

Methods inherited from java.lang.Object

Method Details

fromJson

public static KnowledgeBaseFileReference fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseFileReference from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getDocName

public String getDocName()

Get the docName property: The document name for the reference.

Returns:

the docName value.

getType

public KnowledgeBaseReferenceType getType()

Get the type property: The type of the reference.

Overrides:

KnowledgeBaseFileReference.getType()

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KnowledgeBaseFileReference.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to