AzureBlobKnowledgeSource Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0

public final class AzureBlobKnowledgeSource
extends KnowledgeSource

Configuration for Azure Blob Storage knowledge source.

Constructor Summary

Constructor Description
AzureBlobKnowledgeSource(String name, AzureBlobKnowledgeSourceParameters azureBlobParameters)

Creates an instance of AzureBlobKnowledgeSource class.

Method Summary

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

Reads an instance of AzureBlobKnowledgeSource from the JsonReader.
AzureBlobKnowledgeSourceParameters getAzureBlobParameters()

Get the azureBlobParameters property: The type of the knowledge source.
KnowledgeSourceKind getKind()

Get the kind property: The type of the knowledge source.
AzureBlobKnowledgeSource setDescription(String description)

Set the description property: Optional user-defined description.
AzureBlobKnowledgeSource setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
AzureBlobKnowledgeSource 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

AzureBlobKnowledgeSource

public AzureBlobKnowledgeSource(String name, AzureBlobKnowledgeSourceParameters azureBlobParameters)

Creates an instance of AzureBlobKnowledgeSource class.

Parameters:

name - the name value to set.
azureBlobParameters - the azureBlobParameters value to set.

Method Details

fromJson

public static AzureBlobKnowledgeSource fromJson(JsonReader jsonReader)

Reads an instance of AzureBlobKnowledgeSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAzureBlobParameters

public AzureBlobKnowledgeSourceParameters getAzureBlobParameters()

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

Returns:

the azureBlobParameters value.

getKind

public KnowledgeSourceKind getKind()

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

Overrides:

AzureBlobKnowledgeSource.getKind()

Returns:

the kind value.

setDescription

public AzureBlobKnowledgeSource setDescription(String description)

Set the description property: Optional user-defined description.

Overrides:

AzureBlobKnowledgeSource.setDescription(String description)

Parameters:

description

setEncryptionKey

public AzureBlobKnowledgeSource 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:

AzureBlobKnowledgeSource.setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Parameters:

encryptionKey

setETag

public AzureBlobKnowledgeSource setETag(String eTag)

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

Overrides:

AzureBlobKnowledgeSource.setETag(String eTag)

Parameters:

eTag

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AzureBlobKnowledgeSource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to