Package com.azure.maps.search.models

Class BatchSearchResult

java.lang.Object

com.azure.maps.search.models.BatchSearchResult

public final class BatchSearchResult
extends Object

This object is returned from a successful Search Address Batch service call.

Constructor Summary

Constructors

Constructor	Description
BatchSearchResult()	Creates a new BatchSearchResult with default properties.
BatchSearchResult(BatchResultSummary batchSummary, List<SearchAddressBatchItem> batchItems)	Creates a new BatchSearchResult with a summary and batch items.

Method Summary

Modifier and Type	Method	Description
String	getBatchId()	Return this id for this batch.
List<SearchAddressBatchItem>	getBatchItems()	Get the batchItems property: Array containing the batch results.
BatchResultSummary	getBatchSummary()	Get the batchSummary property: Summary of the results for the batch request.
void	setBatchId(String batchId)	Sets the if of this batch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BatchSearchResult

public BatchSearchResult()

Creates a new BatchSearchResult with default properties.

BatchSearchResult

public BatchSearchResult(BatchResultSummary batchSummary,
 List<SearchAddressBatchItem> batchItems)

Creates a new BatchSearchResult with a summary and batch items.

Parameters:

batchSummary - the summary of this batch's search results.

batchItems - the items returned in this search.

Method Details

getBatchSummary

public BatchResultSummary getBatchSummary()

Get the batchSummary property: Summary of the results for the batch request.

Returns:

the batchSummary value.

getBatchItems

public List<SearchAddressBatchItem> getBatchItems()

Get the batchItems property: Array containing the batch results.

Returns:

the batchItems value.

getBatchId

public String getBatchId()

Return this id for this batch. Only available when the batch is cached.

Returns:

the batch id

setBatchId

public void setBatchId(String batchId)

Sets the if of this batch.

Parameters:

batchId - the id of this batch, returned from the asynchronous API.