Package com.azure.search.documents.agents.models

Class KnowledgeAgentSearchActivityRecord

java.lang.Object
com.azure.search.documents.agents.models.KnowledgeAgentActivityRecord
com.azure.search.documents.agents.models.KnowledgeAgentSearchActivityRecord
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeAgentActivityRecord>
public final class KnowledgeAgentSearchActivityRecord extends KnowledgeAgentActivityRecord
Represents a retrieval activity record.

  • Constructor Details

    • KnowledgeAgentSearchActivityRecord

      public KnowledgeAgentSearchActivityRecord(int id)
      Creates an instance of KnowledgeAgentSearchActivityRecord 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 KnowledgeAgentActivityRecord
      Returns:
      the type value.

    • getTargetIndex

      public String getTargetIndex()
      Get the targetIndex property: The target index for the retrieval activity.
      Returns:
      the targetIndex value.

    • setTargetIndex

      public KnowledgeAgentSearchActivityRecord setTargetIndex(String targetIndex)
      Set the targetIndex property: The target index for the retrieval activity.
      Parameters:
      targetIndex - the targetIndex value to set.
      Returns:
      the KnowledgeAgentSearchActivityRecord object itself.

    • getQuery

      public KnowledgeAgentSearchActivityRecordQuery getQuery()
      Get the query property: The query details for the retrieval activity.
      Returns:
      the query value.

    • setQuery

      public KnowledgeAgentSearchActivityRecord setQuery(KnowledgeAgentSearchActivityRecordQuery query)
      Set the query property: The query details for the retrieval activity.
      Parameters:
      query - the query value to set.
      Returns:
      the KnowledgeAgentSearchActivityRecord object itself.

    • getQueryTime

      public OffsetDateTime getQueryTime()
      Get the queryTime property: The query time for this retrieval activity.
      Returns:
      the queryTime value.

    • setQueryTime

      public KnowledgeAgentSearchActivityRecord setQueryTime(OffsetDateTime queryTime)
      Set the queryTime property: The query time for this retrieval activity.
      Parameters:
      queryTime - the queryTime value to set.
      Returns:
      the KnowledgeAgentSearchActivityRecord object itself.

    • getCount

      public Integer getCount()
      Get the count property: The count of documents retrieved.
      Returns:
      the count value.

    • setCount

      public KnowledgeAgentSearchActivityRecord setCount(Integer count)
      Set the count property: The count of documents retrieved.
      Parameters:
      count - the count value to set.
      Returns:
      the KnowledgeAgentSearchActivityRecord object itself.

    • getElapsedMs

      public Integer getElapsedMs()
      Get the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
      Returns:
      the elapsedMs value.

    • setElapsedMs

      public KnowledgeAgentSearchActivityRecord setElapsedMs(Integer elapsedMs)
      Set the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
      Parameters:
      elapsedMs - the elapsedMs value to set.
      Returns:
      the KnowledgeAgentSearchActivityRecord 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<KnowledgeAgentActivityRecord>
      Overrides:
      toJson in class KnowledgeAgentActivityRecord
      Throws:
      IOException

    • fromJson

      public static KnowledgeAgentSearchActivityRecord fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KnowledgeAgentSearchActivityRecord from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KnowledgeAgentSearchActivityRecord 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 KnowledgeAgentSearchActivityRecord.