Class IndexingParameters
- java.lang.Object
-
- com.azure.search.documents.indexes.models.IndexingParameters
-
public final class IndexingParameters extends Object
Represents parameters for indexer execution.
-
-
Constructor Summary
Constructors Constructor Description IndexingParameters()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.
-
-
-
Method Detail
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
getConfiguration
public Map<String,Object> 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.
-
setConfiguration
public IndexingParameters setConfiguration(Map<String,Object> 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.
-
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.
-
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.
-
-