IndexedOneLakeKnowledgeSource Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:12.0.0

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

public final class IndexedOneLakeKnowledgeSource
extends KnowledgeSource

Configuration for OneLake knowledge source.

Constructor Summary

Constructor	Description
IndexedOneLakeKnowledgeSource(String name, IndexedOneLakeKnowledgeSourceParameters indexedOneLakeParameters)	Creates an instance of IndexedOneLakeKnowledgeSource class.

Method Summary

Modifier and Type	Method and Description
static IndexedOneLakeKnowledgeSource	fromJson(JsonReader jsonReader) Reads an instance of IndexedOneLakeKnowledgeSource from the JsonReader.
IndexedOneLakeKnowledgeSourceParameters	getIndexedOneLakeParameters() Get the indexedOneLakeParameters property: The parameters for the knowledge source.
KnowledgeSourceKind	getKind() Get the kind property: The type of the knowledge source.
IndexedOneLakeKnowledgeSource	setDescription(String description) Set the description property: Optional user-defined description.
IndexedOneLakeKnowledgeSource	setEncryptionKey(SearchResourceEncryptionKey encryptionKey) Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
IndexedOneLakeKnowledgeSource	setETag(String eTag) Set the eTag property: The ETag of the knowledge source.
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

IndexedOneLakeKnowledgeSource

public IndexedOneLakeKnowledgeSource(String name, IndexedOneLakeKnowledgeSourceParameters indexedOneLakeParameters)

Creates an instance of IndexedOneLakeKnowledgeSource class.

Parameters:

name - the name value to set.

indexedOneLakeParameters - the indexedOneLakeParameters value to set.

Method Details

fromJson

public static IndexedOneLakeKnowledgeSource fromJson(JsonReader jsonReader)

Reads an instance of IndexedOneLakeKnowledgeSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getIndexedOneLakeParameters

public IndexedOneLakeKnowledgeSourceParameters getIndexedOneLakeParameters()

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

Returns:

the indexedOneLakeParameters value.

getKind

public KnowledgeSourceKind getKind()

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

Overrides:

IndexedOneLakeKnowledgeSource.getKind()

Returns:

the kind value.

setDescription

public IndexedOneLakeKnowledgeSource setDescription(String description)

Set the description property: Optional user-defined description.

Overrides:

IndexedOneLakeKnowledgeSource.setDescription(String description)

Parameters:

description

setEncryptionKey

public IndexedOneLakeKnowledgeSource 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 source definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge source 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 source 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:

IndexedOneLakeKnowledgeSource.setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Parameters:

encryptionKey

setETag

public IndexedOneLakeKnowledgeSource setETag(String eTag)

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

Overrides:

IndexedOneLakeKnowledgeSource.setETag(String eTag)

Parameters:

eTag

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

IndexedOneLakeKnowledgeSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException