IndexingParameters Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.7.3

• java.lang.Object
• • com.azure.search.documents.indexes.models.IndexingParameters

Implements

JsonSerializable<IndexingParameters>

public final class IndexingParameters
implements JsonSerializable<IndexingParameters>

Represents parameters for indexer execution.

Constructor Summary

Constructor	Description
IndexingParameters()	Creates an instance of IndexingParameters class.

Method Summary

Modifier and Type	Method and Description
static IndexingParameters	fromJson(JsonReader jsonReader) Reads an instance of IndexingParameters from the JsonReader.
Integer	getBatchSize() Get the batchSize property: The number of items that are read from the data source and indexed as a single batch in order to improve performance.
Map<String,Object>	getConfiguration() Get the configuration property: A dictionary of indexer-specific configuration properties.
IndexingParametersConfiguration	getIndexingParametersConfiguration() Get the configuration property: A dictionary of indexer-specific configuration properties.
Integer	getMaxFailedItems() Get the maxFailedItems property: The maximum number of items that can fail indexing for indexer execution to still be considered successful.
Integer	getMaxFailedItemsPerBatch() Get the maxFailedItemsPerBatch property: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful.
IndexingParameters	setBatchSize(Integer batchSize) Set the batchSize property: The number of items that are read from the data source and indexed as a single batch in order to improve performance.
IndexingParameters	setConfiguration(Map<String,Object> configuration) Set the configuration property: A dictionary of indexer-specific configuration properties.
IndexingParameters	setIndexingParametersConfiguration(IndexingParametersConfiguration configuration) Set the configuration property: A dictionary of indexer-specific configuration properties.
IndexingParameters	setMaxFailedItems(Integer maxFailedItems) Set the maxFailedItems property: The maximum number of items that can fail indexing for indexer execution to still be considered successful.
IndexingParameters	setMaxFailedItemsPerBatch(Integer maxFailedItemsPerBatch) Set the maxFailedItemsPerBatch property: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IndexingParameters

public IndexingParameters()

Creates an instance of IndexingParameters class.

Method Details

fromJson

public static IndexingParameters fromJson(JsonReader jsonReader)

Reads an instance of IndexingParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of IndexingParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the IndexingParameters.

getBatchSize

public Integer getBatchSize()

Get the batchSize property: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type.

Returns:

the batchSize value.

getConfiguration

public Map getConfiguration()

Get the configuration property: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Returns:

the configuration value.

getIndexingParametersConfiguration

public IndexingParametersConfiguration getIndexingParametersConfiguration()

Get the configuration property: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Returns:

the configuration value.

getMaxFailedItems

public Integer getMaxFailedItems()

Get the maxFailedItems property: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0.

Returns:

the maxFailedItems value.

getMaxFailedItemsPerBatch

public Integer getMaxFailedItemsPerBatch()

Get the maxFailedItemsPerBatch property: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0.

Returns:

the maxFailedItemsPerBatch value.

setBatchSize

public IndexingParameters setBatchSize(Integer batchSize)

Set the batchSize property: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type.

Parameters:

batchSize - the batchSize value to set.

Returns:

the IndexingParameters object itself.

setConfiguration

public IndexingParameters setConfiguration(Map configuration)

Set the configuration property: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Parameters:

configuration - the configuration value to set.

Returns:

the IndexingParameters object itself.

setIndexingParametersConfiguration

public IndexingParameters setIndexingParametersConfiguration(IndexingParametersConfiguration configuration)

Set the configuration property: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Parameters:

configuration - the configuration value to set.

Returns:

the IndexingParameters object itself.

setMaxFailedItems

public IndexingParameters setMaxFailedItems(Integer maxFailedItems)

Set the maxFailedItems property: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0.

Parameters:

maxFailedItems - the maxFailedItems value to set.

Returns:

the IndexingParameters object itself.

setMaxFailedItemsPerBatch

public IndexingParameters setMaxFailedItemsPerBatch(Integer maxFailedItemsPerBatch)

Set the maxFailedItemsPerBatch property: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0.

Parameters:

maxFailedItemsPerBatch - the maxFailedItemsPerBatch value to set.

Returns:

the IndexingParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException