Package com.azure.search.documents.indexes.models

Class SearchIndexerSkillset

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkillset
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkillset>
public final class SearchIndexerSkillset extends Object implements com.azure.json.JsonSerializable<SearchIndexerSkillset>
A list of skills.

  • Constructor Details

    • SearchIndexerSkillset

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

    • SearchIndexerSkillset

      public SearchIndexerSkillset(String name, List<SearchIndexerSkill> skills)
      /** Creates an instance of SearchIndexerSkillset class.
      Parameters:
      name - The name of the skillset.
      skills - The skills in the skillset. /

  • Method Details

    • getName

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

    • getDescription

      public String getDescription()
      Get the description property: The description of the skillset.
      Returns:
      the description value.

    • setDescription

      public SearchIndexerSkillset setDescription(String description)
      Set the description property: The description of the skillset.
      Parameters:
      description - the description value to set.
      Returns:
      the SearchIndexerSkillset object itself.

    • getSkills

      public List<SearchIndexerSkill> getSkills()
      Get the skills property: A list of skills in the skillset.
      Returns:
      the skills value.

    • setSkills

      public SearchIndexerSkillset setSkills(List<SearchIndexerSkill> skills)
      Set the skills property: A list of skills in the skillset.
      Parameters:
      skills - the skills value to set.
      Returns:
      the SearchIndexerSkillset object itself.

    • getCognitiveServicesAccount

      public CognitiveServicesAccount getCognitiveServicesAccount()
      Get the cognitiveServicesAccount property: Details about the Azure AI service to be used when running skills.
      Returns:
      the cognitiveServicesAccount value.

    • setCognitiveServicesAccount

      public SearchIndexerSkillset setCognitiveServicesAccount(CognitiveServicesAccount cognitiveServicesAccount)
      Set the cognitiveServicesAccount property: Details about the Azure AI service to be used when running skills.
      Parameters:
      cognitiveServicesAccount - the cognitiveServicesAccount value to set.
      Returns:
      the SearchIndexerSkillset object itself.

    • getKnowledgeStore

      public SearchIndexerKnowledgeStore getKnowledgeStore()
      Get the knowledgeStore property: Definition of additional projections to Azure blob, table, or files, of enriched data.
      Returns:
      the knowledgeStore value.

    • setKnowledgeStore

      public SearchIndexerSkillset setKnowledgeStore(SearchIndexerKnowledgeStore knowledgeStore)
      Set the knowledgeStore property: Definition of additional projections to Azure blob, table, or files, of enriched data.
      Parameters:
      knowledgeStore - the knowledgeStore value to set.
      Returns:
      the SearchIndexerSkillset object itself.

    • getIndexProjection

      public SearchIndexerIndexProjection getIndexProjection()
      Get the indexProjection property: Definition of additional projections to secondary search index(es).
      Returns:
      the indexProjection value.

    • setIndexProjection

      public SearchIndexerSkillset setIndexProjection(SearchIndexerIndexProjection indexProjection)
      Set the indexProjection property: Definition of additional projections to secondary search index(es).
      Parameters:
      indexProjection - the indexProjection value to set.
      Returns:
      the SearchIndexerSkillset object itself.

    • getETag

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

    • setETag

      public SearchIndexerSkillset setETag(String eTag)
      Set the eTag property: The ETag of the skillset.
      Parameters:
      eTag - the eTag value to set.
      Returns:
      the SearchIndexerSkillset 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 skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset 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 skillset 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 SearchIndexerSkillset 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 skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset 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 skillset 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 SearchIndexerSkillset 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<SearchIndexerSkillset>
      Throws:
      IOException

    • fromJson

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

    • setSkills

      public SearchIndexerSkillset setSkills(SearchIndexerSkill... skills)
      Set the skills property: A list of skills in the skillset.
      Parameters:
      skills - the skills value to set.
      Returns:
      the SearchIndexerSkillset object itself.