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

Class KnowledgeAgentReference

java.lang.Object
com.azure.search.documents.agents.models.KnowledgeAgentReference
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeAgentReference>
Direct Known Subclasses:
KnowledgeAgentAzureSearchDocReference
public class KnowledgeAgentReference extends Object implements com.azure.json.JsonSerializable<KnowledgeAgentReference>
Base type for references.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KnowledgeAgentReference(String id, int activitySource)
    Creates an instance of KnowledgeAgentReference class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static KnowledgeAgentReference
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of KnowledgeAgentReference from the JsonReader.
    int
    getActivitySource()
    Get the activitySource property: The source activity ID for the reference.
    String
    getId()
    Get the id property: The ID of the reference.
    String
    getType()
    Get the type property: The type of the reference.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.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

    • KnowledgeAgentReference

      public KnowledgeAgentReference(String id, int activitySource)
      Creates an instance of KnowledgeAgentReference 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.
      Returns:
      the type value.

    • getId

      public String getId()
      Get the id property: The ID of the reference.
      Returns:
      the id value.

    • getActivitySource

      public int getActivitySource()
      Get the activitySource property: The source activity ID for the reference.
      Returns:
      the activitySource value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<KnowledgeAgentReference>
      Throws:
      IOException

    • fromJson

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