KnowledgeSourceSynchronizationError 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.KnowledgeSourceSynchronizationError

Implements

JsonSerializable<KnowledgeSourceSynchronizationError>

public final class KnowledgeSourceSynchronizationError
implements JsonSerializable<KnowledgeSourceSynchronizationError>

Represents a document-level indexing error encountered during a knowledge source synchronization run.

Constructor Summary

Constructor	Description
KnowledgeSourceSynchronizationError(String errorMessage)	Creates an instance of KnowledgeSourceSynchronizationError class.

Method Summary

Modifier and Type	Method and Description
static KnowledgeSourceSynchronizationError	fromJson(JsonReader jsonReader) Reads an instance of KnowledgeSourceSynchronizationError from the JsonReader.
String	getDetails() Get the details property: Additional contextual information about the failure.
String	getDocId() Get the docId property: The unique identifier for the failed document or item within the synchronization run.
String	getDocumentationLink() Get the documentationLink property: A link to relevant troubleshooting documentation.
String	getErrorMessage() Get the errorMessage property: Human-readable, customer-visible error message.
String	getName() Get the name property: Name of the ingestion or processing component reporting the error.
Integer	getStatusCode() Get the statusCode property: HTTP-like status code representing the failure category (e.g., 400).
KnowledgeSourceSynchronizationError	setDetails(String details) Set the details property: Additional contextual information about the failure.
KnowledgeSourceSynchronizationError	setDocId(String docId) Set the docId property: The unique identifier for the failed document or item within the synchronization run.
KnowledgeSourceSynchronizationError	setDocumentationLink(String documentationLink) Set the documentationLink property: A link to relevant troubleshooting documentation.
KnowledgeSourceSynchronizationError	setName(String name) Set the name property: Name of the ingestion or processing component reporting the error.
KnowledgeSourceSynchronizationError	setStatusCode(Integer statusCode) Set the statusCode property: HTTP-like status code representing the failure category (e.g., 400).
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeSourceSynchronizationError

public KnowledgeSourceSynchronizationError(String errorMessage)

Creates an instance of KnowledgeSourceSynchronizationError class.

Parameters:

errorMessage - the errorMessage value to set.

Method Details

fromJson

public static KnowledgeSourceSynchronizationError fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeSourceSynchronizationError from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDetails

public String getDetails()

Get the details property: Additional contextual information about the failure.

Returns:

the details value.

getDocId

public String getDocId()

Get the docId property: The unique identifier for the failed document or item within the synchronization run.

Returns:

the docId value.

getDocumentationLink

public String getDocumentationLink()

Get the documentationLink property: A link to relevant troubleshooting documentation.

Returns:

the documentationLink value.

getErrorMessage

public String getErrorMessage()

Get the errorMessage property: Human-readable, customer-visible error message.

Returns:

the errorMessage value.

getName

public String getName()

Get the name property: Name of the ingestion or processing component reporting the error.

Returns:

the name value.

getStatusCode

public Integer getStatusCode()

Get the statusCode property: HTTP-like status code representing the failure category (e.g., 400).

Returns:

the statusCode value.

setDetails

public KnowledgeSourceSynchronizationError setDetails(String details)

Set the details property: Additional contextual information about the failure.

Parameters:

details - the details value to set.

Returns:

the KnowledgeSourceSynchronizationError object itself.

setDocId

public KnowledgeSourceSynchronizationError setDocId(String docId)

Set the docId property: The unique identifier for the failed document or item within the synchronization run.

Parameters:

docId - the docId value to set.

Returns:

the KnowledgeSourceSynchronizationError object itself.

setDocumentationLink

public KnowledgeSourceSynchronizationError setDocumentationLink(String documentationLink)

Set the documentationLink property: A link to relevant troubleshooting documentation.

Parameters:

documentationLink - the documentationLink value to set.

Returns:

the KnowledgeSourceSynchronizationError object itself.

setName

public KnowledgeSourceSynchronizationError setName(String name)

Set the name property: Name of the ingestion or processing component reporting the error.

Parameters:

name - the name value to set.

Returns:

the KnowledgeSourceSynchronizationError object itself.

setStatusCode

public KnowledgeSourceSynchronizationError setStatusCode(Integer statusCode)

Set the statusCode property: HTTP-like status code representing the failure category (e.g., 400).

Parameters:

statusCode - the statusCode value to set.

Returns:

the KnowledgeSourceSynchronizationError object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException