Package com.azure.ai.documentintelligence.models

Class AnalyzeBatchDocumentsRequest

java.lang.Object
com.azure.ai.documentintelligence.models.AnalyzeBatchDocumentsRequest
All Implemented Interfaces:
com.azure.json.JsonSerializable<AnalyzeBatchDocumentsRequest>
public final class AnalyzeBatchDocumentsRequest extends Object implements com.azure.json.JsonSerializable<AnalyzeBatchDocumentsRequest>
Batch document analysis parameters.

  • Constructor Details

    • AnalyzeBatchDocumentsRequest

      public AnalyzeBatchDocumentsRequest(String resultContainerUrl)
      Creates an instance of AnalyzeBatchDocumentsRequest class.
      Parameters:
      resultContainerUrl - the resultContainerUrl value to set.

  • Method Details

    • getAzureBlobSource

      public AzureBlobContentSource getAzureBlobSource()
      Get the azureBlobSource property: Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
      Returns:
      the azureBlobSource value.

    • setAzureBlobSource

      public AnalyzeBatchDocumentsRequest setAzureBlobSource(AzureBlobContentSource azureBlobSource)
      Set the azureBlobSource property: Azure Blob Storage location containing the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
      Parameters:
      azureBlobSource - the azureBlobSource value to set.
      Returns:
      the AnalyzeBatchDocumentsRequest object itself.

    • getAzureBlobFileListSource

      public AzureBlobFileListContentSource getAzureBlobFileListSource()
      Get the azureBlobFileListSource property: Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
      Returns:
      the azureBlobFileListSource value.

    • setAzureBlobFileListSource

      public AnalyzeBatchDocumentsRequest setAzureBlobFileListSource(AzureBlobFileListContentSource azureBlobFileListSource)
      Set the azureBlobFileListSource property: Azure Blob Storage file list specifying the batch documents. Either azureBlobSource or azureBlobFileListSource must be specified.
      Parameters:
      azureBlobFileListSource - the azureBlobFileListSource value to set.
      Returns:
      the AnalyzeBatchDocumentsRequest object itself.

    • getResultContainerUrl

      public String getResultContainerUrl()
      Get the resultContainerUrl property: Azure Blob Storage container URL where analyze result files will be stored.
      Returns:
      the resultContainerUrl value.

    • getResultPrefix

      public String getResultPrefix()
      Get the resultPrefix property: Blob name prefix of result files.
      Returns:
      the resultPrefix value.

    • setResultPrefix

      public AnalyzeBatchDocumentsRequest setResultPrefix(String resultPrefix)
      Set the resultPrefix property: Blob name prefix of result files.
      Parameters:
      resultPrefix - the resultPrefix value to set.
      Returns:
      the AnalyzeBatchDocumentsRequest object itself.

    • isOverwriteExisting

      public Boolean isOverwriteExisting()
      Get the overwriteExisting property: Overwrite existing analyze result files?.
      Returns:
      the overwriteExisting value.

    • setOverwriteExisting

      public AnalyzeBatchDocumentsRequest setOverwriteExisting(Boolean overwriteExisting)
      Set the overwriteExisting property: Overwrite existing analyze result files?.
      Parameters:
      overwriteExisting - the overwriteExisting value to set.
      Returns:
      the AnalyzeBatchDocumentsRequest object itself.

    • toJson

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

    • fromJson

      public static AnalyzeBatchDocumentsRequest fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AnalyzeBatchDocumentsRequest from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AnalyzeBatchDocumentsRequest 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 AnalyzeBatchDocumentsRequest.