Class KnowledgeBaseAzureBlobActivityRecord

java.lang.Object

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

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

com.azure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityRecord

All Implemented Interfaces:

com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>

public final class KnowledgeBaseAzureBlobActivityRecord
extends KnowledgeBaseRetrievalActivityRecord

Represents a azure blob retrieval activity record.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static KnowledgeBaseAzureBlobActivityRecord	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of KnowledgeBaseAzureBlobActivityRecord from the JsonReader.
KnowledgeBaseAzureBlobActivityArguments	getAzureBlobArguments()	Get the azureBlobArguments property: The azure blob arguments for the retrieval activity.
String	getType()	Get the type property: The type of the activity record.
KnowledgeBaseAzureBlobActivityRecord	setAzureBlobArguments(KnowledgeBaseAzureBlobActivityArguments azureBlobArguments)	Set the azureBlobArguments property: The azure blob arguments for the retrieval activity.
KnowledgeBaseAzureBlobActivityRecord	setCount(Integer count)	Set the count property: The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
KnowledgeBaseAzureBlobActivityRecord	setElapsedMs(Integer elapsedMs)	Set the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
KnowledgeBaseAzureBlobActivityRecord	setError(KnowledgeBaseErrorDetail error)	Set the error property: The error detail explaining why the operation failed.
KnowledgeBaseAzureBlobActivityRecord	setKnowledgeSourceName(String knowledgeSourceName)	Set the knowledgeSourceName property: The knowledge source for the retrieval activity.
KnowledgeBaseAzureBlobActivityRecord	setQueryTime(OffsetDateTime queryTime)	Set the queryTime property: The query time for this 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

KnowledgeBaseAzureBlobActivityRecord

public KnowledgeBaseAzureBlobActivityRecord(int id)

Creates an instance of KnowledgeBaseAzureBlobActivityRecord 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.

getAzureBlobArguments

public KnowledgeBaseAzureBlobActivityArguments getAzureBlobArguments()

Get the azureBlobArguments property: The azure blob arguments for the retrieval activity.

Returns:

the azureBlobArguments value.

setAzureBlobArguments

public KnowledgeBaseAzureBlobActivityRecord setAzureBlobArguments(KnowledgeBaseAzureBlobActivityArguments azureBlobArguments)

Set the azureBlobArguments property: The azure blob arguments for the retrieval activity.

Parameters:

azureBlobArguments - the azureBlobArguments value to set.

Returns:

the KnowledgeBaseAzureBlobActivityRecord object itself.

setKnowledgeSourceName

public KnowledgeBaseAzureBlobActivityRecord 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 KnowledgeBaseAzureBlobActivityRecord 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 KnowledgeBaseAzureBlobActivityRecord 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 KnowledgeBaseAzureBlobActivityRecord 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 KnowledgeBaseAzureBlobActivityRecord 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 KnowledgeBaseAzureBlobActivityRecord fromJson(com.azure.json.JsonReader jsonReader)
                                                     throws IOException

Reads an instance of KnowledgeBaseAzureBlobActivityRecord from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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