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

Class KnowledgeAgentAzureSearchDocReference

java.lang.Object
com.azure.search.documents.agents.models.KnowledgeAgentReference
com.azure.search.documents.agents.models.KnowledgeAgentAzureSearchDocReference
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeAgentReference>
public final class KnowledgeAgentAzureSearchDocReference extends KnowledgeAgentReference
Represents an Azure Search document reference.

  • Constructor Details

    • KnowledgeAgentAzureSearchDocReference

      public KnowledgeAgentAzureSearchDocReference(String id, int activitySource)
      Creates an instance of KnowledgeAgentAzureSearchDocReference class.
      Parameters:
      id - the id value to set.
      activitySource - the activitySource value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the reference.
      Overrides:
      getType in class KnowledgeAgentReference
      Returns:
      the type value.

    • getDocKey

      public String getDocKey()
      Get the docKey property: The document key for the reference.
      Returns:
      the docKey value.

    • setDocKey

      public KnowledgeAgentAzureSearchDocReference setDocKey(String docKey)
      Set the docKey property: The document key for the reference.
      Parameters:
      docKey - the docKey value to set.
      Returns:
      the KnowledgeAgentAzureSearchDocReference object itself.

    • getSourceData

      public Map<String,Object> getSourceData()
      Get the sourceData property: Dictionary of <any>.
      Returns:
      the sourceData value.

    • setSourceData

      public KnowledgeAgentAzureSearchDocReference setSourceData(Map<String,Object> sourceData)
      Set the sourceData property: Dictionary of <any>.
      Parameters:
      sourceData - the sourceData value to set.
      Returns:
      the KnowledgeAgentAzureSearchDocReference 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<KnowledgeAgentReference>
      Overrides:
      toJson in class KnowledgeAgentReference
      Throws:
      IOException

    • fromJson

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