Class AzureBlobKnowledgeSourceParameters

java.lang.Object
com.azure.search.documents.indexes.models.AzureBlobKnowledgeSourceParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureBlobKnowledgeSourceParameters>
public final class AzureBlobKnowledgeSourceParameters extends Object implements com.azure.json.JsonSerializable<AzureBlobKnowledgeSourceParameters>
Parameters for Azure Blob Storage knowledge source.

  • 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

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

    • getFolderPath

      public String getFolderPath()
      Get the folderPath property: Optional folder path within the container.
      Returns:
      the folderPath value.

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

    • isAdlsGen2

      public Boolean isAdlsGen2()
      Get the isAdlsGen2 property: Set to true if connecting to an ADLS Gen2 storage account. Default is false.
      Returns:
      the isAdlsGen2 value.

    • setIsAdlsGen2

      public AzureBlobKnowledgeSourceParameters setIsAdlsGen2(Boolean isAdlsGen2)
      Set the isAdlsGen2 property: Set to true if connecting to an ADLS Gen2 storage account. Default is false.
      Parameters:
      isAdlsGen2 - the isAdlsGen2 value to set.
      Returns:
      the AzureBlobKnowledgeSourceParameters object itself.

    • getIngestionParameters

      public KnowledgeSourceIngestionParameters getIngestionParameters()
      Get the ingestionParameters property: Consolidates all general ingestion settings.
      Returns:
      the ingestionParameters value.

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

    • getCreatedResources

      public Map<String,String> getCreatedResources()
      Get the createdResources property: Resources created by the knowledge source.
      Returns:
      the createdResources value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AzureBlobKnowledgeSourceParameters>
      Throws:
      IOException

    • fromJson

      public static AzureBlobKnowledgeSourceParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AzureBlobKnowledgeSourceParameters.