Class KnowledgeSource

java.lang.Object
com.azure.search.documents.indexes.models.KnowledgeSource
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeSource>
Direct Known Subclasses:
AzureBlobKnowledgeSource, IndexedOneLakeKnowledgeSource, IndexedSharePointKnowledgeSource, RemoteSharePointKnowledgeSource, SearchIndexKnowledgeSource, WebKnowledgeSource
public class KnowledgeSource extends Object implements com.azure.json.JsonSerializable<KnowledgeSource>
Represents a knowledge source definition.

  • Constructor Details

    • KnowledgeSource

      public KnowledgeSource(String name)
      Creates an instance of KnowledgeSource class.
      Parameters:
      name - the name value to set.

  • Method Details

    • getKind

      public KnowledgeSourceKind getKind()
      Get the kind property: The type of the knowledge source.
      Returns:
      the kind value.

    • getName

      public String getName()
      Get the name property: The name of the knowledge source.
      Returns:
      the name value.

    • getDescription

      public String getDescription()
      Get the description property: Optional user-defined description.
      Returns:
      the description value.

    • setDescription

      public KnowledgeSource setDescription(String description)
      Set the description property: Optional user-defined description.
      Parameters:
      description - the description value to set.
      Returns:
      the KnowledgeSource object itself.

    • getETag

      public String getETag()
      Get the eTag property: The ETag of the knowledge base.
      Returns:
      the eTag value.

    • setETag

      public KnowledgeSource setETag(String eTag)
      Set the eTag property: The ETag of the knowledge base.
      Parameters:
      eTag - the eTag value to set.
      Returns:
      the KnowledgeSource object itself.

    • getEncryptionKey

      public SearchResourceEncryptionKey getEncryptionKey()
      Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
      Returns:
      the encryptionKey value.

    • setEncryptionKey

      public KnowledgeSource setEncryptionKey(SearchResourceEncryptionKey encryptionKey)
      Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
      Parameters:
      encryptionKey - the encryptionKey value to set.
      Returns:
      the KnowledgeSource 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<KnowledgeSource>
      Throws:
      IOException

    • fromJson

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