SearchIndexKnowledgeSource Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.9.0-beta.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.KnowledgeSource
  • • com.azure.search.documents.indexes.models.SearchIndexKnowledgeSource

public final class SearchIndexKnowledgeSource
extends KnowledgeSource

Knowledge Source targeting a search index.

Constructor Summary

Constructor	Description
SearchIndexKnowledgeSource(String name, SearchIndexKnowledgeSourceParameters searchIndexParameters)	Creates an instance of SearchIndexKnowledgeSource class.

Method Summary

Modifier and Type	Method and Description
static SearchIndexKnowledgeSource	fromJson(JsonReader jsonReader) Reads an instance of SearchIndexKnowledgeSource from the JsonReader.
KnowledgeSourceKind	getKind() Get the kind property: The type of the knowledge source.
SearchIndexKnowledgeSourceParameters	getSearchIndexParameters() Get the searchIndexParameters property: The parameters for the knowledge source.
SearchIndexKnowledgeSource	setDescription(String description) Set the description property: Optional user-defined description.
SearchIndexKnowledgeSource	setEncryptionKey(SearchResourceEncryptionKey encryptionKey) Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
SearchIndexKnowledgeSource	setETag(String eTag) Set the eTag property: The ETag of the knowledge base.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from KnowledgeSource

fromJson getDescription getETag getEncryptionKey getKind getName setDescription setETag setEncryptionKey toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexKnowledgeSource

public SearchIndexKnowledgeSource(String name, SearchIndexKnowledgeSourceParameters searchIndexParameters)

Creates an instance of SearchIndexKnowledgeSource class.

Parameters:

name - the name value to set.

searchIndexParameters - the searchIndexParameters value to set.

Method Details

fromJson

public static SearchIndexKnowledgeSource fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexKnowledgeSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexKnowledgeSource 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.

getKind

public KnowledgeSourceKind getKind()

Get the kind property: The type of the knowledge source.

Overrides:

SearchIndexKnowledgeSource.getKind()

Returns:

the kind value.

getSearchIndexParameters

public SearchIndexKnowledgeSourceParameters getSearchIndexParameters()

Get the searchIndexParameters property: The parameters for the knowledge source.

Returns:

the searchIndexParameters value.

setDescription

public SearchIndexKnowledgeSource setDescription(String description)

Set the description property: Optional user-defined description.

Overrides:

SearchIndexKnowledgeSource.setDescription(String description)

Parameters:

description

setEncryptionKey

public SearchIndexKnowledgeSource 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.

Overrides:

SearchIndexKnowledgeSource.setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Parameters:

encryptionKey

setETag

public SearchIndexKnowledgeSource setETag(String eTag)

Set the eTag property: The ETag of the knowledge base.

Overrides:

SearchIndexKnowledgeSource.setETag(String eTag)

Parameters:

eTag

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SearchIndexKnowledgeSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException