AzureBlobKnowledgeSourceParameters 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.AzureBlobKnowledgeSourceParameters

Implements

JsonSerializable<AzureBlobKnowledgeSourceParameters>

public final class AzureBlobKnowledgeSourceParameters
implements JsonSerializable<AzureBlobKnowledgeSourceParameters>

Parameters for Azure Blob Storage knowledge source.

Constructor Summary

Constructor	Description
AzureBlobKnowledgeSourceParameters(String connectionString, String containerName)	Creates an instance of AzureBlobKnowledgeSourceParameters class.

Method Summary

Modifier and Type	Method and Description
static AzureBlobKnowledgeSourceParameters	fromJson(JsonReader jsonReader) Reads an instance of AzureBlobKnowledgeSourceParameters from the JsonReader.
String	getConnectionString() Get the connectionString property: Key-based connection string or the ResourceId format if using a managed identity.
String	getContainerName() Get the containerName property: The name of the blob storage container.
CreatedResources	getCreatedResources() Get the createdResources property: Resources created by the knowledge source.
String	getFolderPath() Get the folderPath property: Optional folder path within the container.
KnowledgeSourceIngestionParameters	getIngestionParameters() Get the ingestionParameters property: Consolidates all general ingestion settings.
Boolean	isAdlsGen2() Get the adlsGen2 property: Set to true if connecting to an ADLS Gen2 storage account.
AzureBlobKnowledgeSourceParameters	setAdlsGen2(Boolean adlsGen2) Set the adlsGen2 property: Set to true if connecting to an ADLS Gen2 storage account.
AzureBlobKnowledgeSourceParameters	setFolderPath(String folderPath) Set the folderPath property: Optional folder path within the container.
AzureBlobKnowledgeSourceParameters	setIngestionParameters(KnowledgeSourceIngestionParameters ingestionParameters) Set the ingestionParameters property: Consolidates all general ingestion settings.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureBlobKnowledgeSourceParameters

public AzureBlobKnowledgeSourceParameters(String connectionString, String containerName)

Creates an instance of AzureBlobKnowledgeSourceParameters class.

Parameters:

connectionString - the connectionString value to set.

containerName - the containerName value to set.

Method Details

fromJson

public static AzureBlobKnowledgeSourceParameters fromJson(JsonReader jsonReader)

Reads an instance of AzureBlobKnowledgeSourceParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getConnectionString

public String getConnectionString()

Get the connectionString property: Key-based connection string or the ResourceId format if using a managed identity.

Returns:

the connectionString value.

getContainerName

public String getContainerName()

Get the containerName property: The name of the blob storage container.

Returns:

the containerName value.

getCreatedResources

public CreatedResources getCreatedResources()

Get the createdResources property: Resources created by the knowledge source.

Returns:

the createdResources value.

getFolderPath

public String getFolderPath()

Get the folderPath property: Optional folder path within the container.

Returns:

the folderPath value.

getIngestionParameters

public KnowledgeSourceIngestionParameters getIngestionParameters()

Get the ingestionParameters property: Consolidates all general ingestion settings.

Returns:

the ingestionParameters value.

isAdlsGen2

public Boolean isAdlsGen2()

Get the adlsGen2 property: Set to true if connecting to an ADLS Gen2 storage account. Default is false.

Returns:

the adlsGen2 value.

setAdlsGen2

public AzureBlobKnowledgeSourceParameters setAdlsGen2(Boolean adlsGen2)

Set the adlsGen2 property: Set to true if connecting to an ADLS Gen2 storage account. Default is false.

Parameters:

adlsGen2 - the adlsGen2 value to set.

Returns:

the AzureBlobKnowledgeSourceParameters object itself.

setFolderPath

public AzureBlobKnowledgeSourceParameters setFolderPath(String folderPath)

Set the folderPath property: Optional folder path within the container.

Parameters:

folderPath - the folderPath value to set.

Returns:

the AzureBlobKnowledgeSourceParameters object itself.

setIngestionParameters

public AzureBlobKnowledgeSourceParameters setIngestionParameters(KnowledgeSourceIngestionParameters ingestionParameters)

Set the ingestionParameters property: Consolidates all general ingestion settings.

Parameters:

ingestionParameters - the ingestionParameters value to set.

Returns:

the AzureBlobKnowledgeSourceParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException