AnalyzeBatchDocumentsRequest Class

Package:
com.azure.ai.documentintelligence.models
Maven Artifact:
com.azure:azure-ai-documentintelligence:1.0.0-beta.4
  • java.lang.Object
    • com.azure.ai.documentintelligence.models.AnalyzeBatchDocumentsRequest

Implements

JsonSerializable<AnalyzeBatchDocumentsRequest>

public final class AnalyzeBatchDocumentsRequest
implements JsonSerializable<AnalyzeBatchDocumentsRequest>

Batch document analysis parameters.

Constructor Summary

Constructor Description
AnalyzeBatchDocumentsRequest(String resultContainerUrl)

Creates an instance of AnalyzeBatchDocumentsRequest class.

Method Summary

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

Reads an instance of AnalyzeBatchDocumentsRequest from the JsonReader.
AzureBlobFileListContentSource getAzureBlobFileListSource()

Get the azureBlobFileListSource property: Azure Blob Storage file list specifying the batch documents.
AzureBlobContentSource getAzureBlobSource()

Get the azureBlobSource property: Azure Blob Storage location containing the batch documents.
String getResultContainerUrl()

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

Get the resultPrefix property: Blob name prefix of result files.
Boolean isOverwriteExisting()

Get the overwriteExisting property: Overwrite existing analyze result files?.
AnalyzeBatchDocumentsRequest setAzureBlobFileListSource(AzureBlobFileListContentSource azureBlobFileListSource)

Set the azureBlobFileListSource property: Azure Blob Storage file list specifying the batch documents.
AnalyzeBatchDocumentsRequest setAzureBlobSource(AzureBlobContentSource azureBlobSource)

Set the azureBlobSource property: Azure Blob Storage location containing the batch documents.
AnalyzeBatchDocumentsRequest setOverwriteExisting(Boolean overwriteExisting)

Set the overwriteExisting property: Overwrite existing analyze result files?.
AnalyzeBatchDocumentsRequest setResultPrefix(String resultPrefix)

Set the resultPrefix property: Blob name prefix of result files.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AnalyzeBatchDocumentsRequest

public AnalyzeBatchDocumentsRequest(String resultContainerUrl)

Creates an instance of AnalyzeBatchDocumentsRequest class.

Parameters:

resultContainerUrl - the resultContainerUrl value to set.

Method Details

fromJson

public static AnalyzeBatchDocumentsRequest fromJson(JsonReader jsonReader)

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:

IOException

 - If the deserialized JSON object was missing any required properties.

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.

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.

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.

isOverwriteExisting

public Boolean isOverwriteExisting()

Get the overwriteExisting property: Overwrite existing analyze result files?.

Returns:

the overwriteExisting 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.

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.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to