SearchIndexerSkillset Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexerSkillset

Implements

JsonSerializable<SearchIndexerSkillset>

public final class SearchIndexerSkillset
implements JsonSerializable<SearchIndexerSkillset>

A list of skills.

Constructor Summary

Constructor Description
SearchIndexerSkillset(String name)

Creates an instance of SearchIndexerSkillset class.
SearchIndexerSkillset(String name, List<SearchIndexerSkill> skills)

/** Creates an instance of SearchIndexerSkillset class.

Method Summary

Modifier and Type Method and Description
static SearchIndexerSkillset fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexerSkillset from the JsonReader.
CognitiveServicesAccount getCognitiveServicesAccount()

Get the cognitiveServicesAccount property: Details about the Azure AI service to be used when running skills.
String getDescription()

Get the description property: The description of the skillset.
String getETag()

Get the eTag property: The ETag of the skillset.
SearchResourceEncryptionKey getEncryptionKey()

Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
SearchIndexerIndexProjection getIndexProjection()

Get the indexProjection property: Definition of additional projections to secondary search index(es).
SearchIndexerKnowledgeStore getKnowledgeStore()

Get the knowledgeStore property: Definition of additional projections to Azure blob, table, or files, of enriched data.
String getName()

Get the name property: The name of the skillset.
List<SearchIndexerSkill> getSkills()

Get the skills property: A list of skills in the skillset.
SearchIndexerSkillset setCognitiveServicesAccount(CognitiveServicesAccount cognitiveServicesAccount)

Set the cognitiveServicesAccount property: Details about the Azure AI service to be used when running skills.
SearchIndexerSkillset setDescription(String description)

Set the description property: The description of the skillset.
SearchIndexerSkillset setETag(String eTag)

Set the eTag property: The ETag of the skillset.
SearchIndexerSkillset setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
SearchIndexerSkillset setIndexProjection(SearchIndexerIndexProjection indexProjection)

Set the indexProjection property: Definition of additional projections to secondary search index(es).
SearchIndexerSkillset setKnowledgeStore(SearchIndexerKnowledgeStore knowledgeStore)

Set the knowledgeStore property: Definition of additional projections to Azure blob, table, or files, of enriched data.
SearchIndexerSkillset setSkills(SearchIndexerSkill[] skills)

Set the skills property: A list of skills in the skillset.
SearchIndexerSkillset setSkills(List<SearchIndexerSkill> skills)

Set the skills property: A list of skills in the skillset.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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 skills)

/** Creates an instance of SearchIndexerSkillset class.

Parameters:

name - The name of the skillset.
skills - The skills in the skillset. /

Method Details

fromJson

public static SearchIndexerSkillset fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

getCognitiveServicesAccount

public CognitiveServicesAccount getCognitiveServicesAccount()

Get the cognitiveServicesAccount property: Details about the Azure AI service to be used when running skills.

Returns:

the cognitiveServicesAccount value.

getDescription

public String getDescription()

Get the description property: The description of the skillset.

Returns:

the description value.

getETag

public String getETag()

Get the eTag property: The ETag of the skillset.

Returns:

the eTag value.

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.

getIndexProjection

public SearchIndexerIndexProjection getIndexProjection()

Get the indexProjection property: Definition of additional projections to secondary search index(es).

Returns:

the indexProjection value.

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.

getName

public String getName()

Get the name property: The name of the skillset.

Returns:

the name value.

getSkills

public List getSkills()

Get the skills property: A list of skills in the skillset.

Returns:

the skills 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.

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.

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.

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.

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.

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.

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.

setSkills

public SearchIndexerSkillset setSkills(List skills)

Set the skills property: A list of skills in the skillset.

Parameters:

skills - the skills value to set.

Returns:

the SearchIndexerSkillset object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to