Class KnowledgeBaseRemoteSharePointActivityRecord

java.lang.Object

com.azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord

com.azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalActivityRecord

com.azure.search.documents.knowledgebases.models.KnowledgeBaseRemoteSharePointActivityRecord

All Implemented Interfaces:

com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>

public final class KnowledgeBaseRemoteSharePointActivityRecord
extends KnowledgeBaseRetrievalActivityRecord

Represents a remote SharePoint retrieval activity record.

Constructor Summary

Constructors

Constructor	Description
KnowledgeBaseRemoteSharePointActivityRecord(int id)	Creates an instance of KnowledgeBaseRemoteSharePointActivityRecord class.

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseRemoteSharePointActivityRecord	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of KnowledgeBaseRemoteSharePointActivityRecord from the JsonReader.
KnowledgeBaseRemoteSharePointActivityArguments	getRemoteSharePointArguments()	Get the remoteSharePointArguments property: The remote SharePoint arguments for the retrieval activity.
String	getType()	Get the type property: The type of the activity record.
KnowledgeBaseRemoteSharePointActivityRecord	setCount(Integer count)	Set the count property: The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
KnowledgeBaseRemoteSharePointActivityRecord	setElapsedMs(Integer elapsedMs)	Set the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
KnowledgeBaseRemoteSharePointActivityRecord	setError(KnowledgeBaseErrorDetail error)	Set the error property: The error detail explaining why the operation failed.
KnowledgeBaseRemoteSharePointActivityRecord	setKnowledgeSourceName(String knowledgeSourceName)	Set the knowledgeSourceName property: The knowledge source for the retrieval activity.
KnowledgeBaseRemoteSharePointActivityRecord	setQueryTime(OffsetDateTime queryTime)	Set the queryTime property: The query time for this retrieval activity.
KnowledgeBaseRemoteSharePointActivityRecord	setRemoteSharePointArguments(KnowledgeBaseRemoteSharePointActivityArguments remoteSharePointArguments)	Set the remoteSharePointArguments property: The remote SharePoint arguments for the retrieval activity.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class KnowledgeBaseRetrievalActivityRecord

getCount, getKnowledgeSourceName, getQueryTime

Methods inherited from class KnowledgeBaseActivityRecord

getElapsedMs, getError, getId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

KnowledgeBaseRemoteSharePointActivityRecord

public KnowledgeBaseRemoteSharePointActivityRecord(int id)

Creates an instance of KnowledgeBaseRemoteSharePointActivityRecord class.

Parameters:

id - the id value to set.

Method Details

getType

public String getType()

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

Overrides:

getType in class KnowledgeBaseRetrievalActivityRecord

Returns:

the type value.

getRemoteSharePointArguments

public KnowledgeBaseRemoteSharePointActivityArguments getRemoteSharePointArguments()

Get the remoteSharePointArguments property: The remote SharePoint arguments for the retrieval activity.

Returns:

the remoteSharePointArguments value.

setRemoteSharePointArguments

public KnowledgeBaseRemoteSharePointActivityRecord setRemoteSharePointArguments(KnowledgeBaseRemoteSharePointActivityArguments remoteSharePointArguments)

Set the remoteSharePointArguments property: The remote SharePoint arguments for the retrieval activity.

Parameters:

remoteSharePointArguments - the remoteSharePointArguments value to set.

Returns:

the KnowledgeBaseRemoteSharePointActivityRecord object itself.

setKnowledgeSourceName

public KnowledgeBaseRemoteSharePointActivityRecord setKnowledgeSourceName(String knowledgeSourceName)

Set the knowledgeSourceName property: The knowledge source for the retrieval activity.

Overrides:

setKnowledgeSourceName in class KnowledgeBaseRetrievalActivityRecord

Parameters:

knowledgeSourceName - the knowledgeSourceName value to set.

Returns:

the KnowledgeBaseRetrievalActivityRecord object itself.

setQueryTime

public KnowledgeBaseRemoteSharePointActivityRecord setQueryTime(OffsetDateTime queryTime)

Set the queryTime property: The query time for this retrieval activity.

Overrides:

setQueryTime in class KnowledgeBaseRetrievalActivityRecord

Parameters:

queryTime - the queryTime value to set.

Returns:

the KnowledgeBaseRetrievalActivityRecord object itself.

setCount

public KnowledgeBaseRemoteSharePointActivityRecord setCount(Integer count)

Set the count property: The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.

Overrides:

setCount in class KnowledgeBaseRetrievalActivityRecord

Parameters:

count - the count value to set.

Returns:

the KnowledgeBaseRetrievalActivityRecord object itself.

setElapsedMs

public KnowledgeBaseRemoteSharePointActivityRecord setElapsedMs(Integer elapsedMs)

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

Overrides:

setElapsedMs in class KnowledgeBaseRetrievalActivityRecord

Parameters:

elapsedMs - the elapsedMs value to set.

Returns:

the KnowledgeBaseActivityRecord object itself.

setError

public KnowledgeBaseRemoteSharePointActivityRecord setError(KnowledgeBaseErrorDetail error)

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

Overrides:

setError in class KnowledgeBaseRetrievalActivityRecord

Parameters:

error - the error value to set.

Returns:

the KnowledgeBaseActivityRecord object itself.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>

Overrides:

toJson in class KnowledgeBaseRetrievalActivityRecord

Throws:

IOException

fromJson

public static KnowledgeBaseRemoteSharePointActivityRecord fromJson(com.azure.json.JsonReader jsonReader)
                                                            throws IOException

Reads an instance of KnowledgeBaseRemoteSharePointActivityRecord from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

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

IOException - If an error occurs while reading the KnowledgeBaseRemoteSharePointActivityRecord.