KnowledgeBaseActivityRecord Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord

Implements

JsonSerializable<KnowledgeBaseActivityRecord>

public class KnowledgeBaseActivityRecord
implements JsonSerializable<KnowledgeBaseActivityRecord>

Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations.

Constructor Summary

Modifier Constructor Description
protected KnowledgeBaseActivityRecord(int id)

Creates an instance of KnowledgeBaseActivityRecord class.

Method Summary

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

Reads an instance of KnowledgeBaseActivityRecord from the JsonReader.
Integer getElapsedMs()

Get the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
KnowledgeBaseErrorDetail getError()

Get the error property: The error detail explaining why the operation failed.
int getId()

Get the id property: The ID of the activity record.
KnowledgeBaseActivityRecordType getType()

Get the type property: The type of the activity record.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeBaseActivityRecord

protected KnowledgeBaseActivityRecord(int id)

Creates an instance of KnowledgeBaseActivityRecord class.

Parameters:

id - the id value to set.

Method Details

fromJson

public static KnowledgeBaseActivityRecord fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseActivityRecord from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of KnowledgeBaseActivityRecord 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.

getElapsedMs

public Integer getElapsedMs()

Get the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.

Returns:

the elapsedMs value.

getError

public KnowledgeBaseErrorDetail getError()

Get the error property: The error detail explaining why the operation failed. This property is only included when the activity does not succeed.

Returns:

the error value.

getId

public int getId()

Get the id property: The ID of the activity record.

Returns:

the id value.

getType

public KnowledgeBaseActivityRecordType getType()

Get the type property: The type of the activity record.

Returns:

the type value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to