Package com.azure.search.documents.indexes.models

Class IndexingParameters

java.lang.Object
com.azure.search.documents.indexes.models.IndexingParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<IndexingParameters>
public final class IndexingParameters extends Object implements com.azure.json.JsonSerializable<IndexingParameters>
Represents parameters for indexer execution.

  • Constructor Details

    • IndexingParameters

      public IndexingParameters()
      Creates an instance of IndexingParameters class.

  • Method Details

    • 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.

    • 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.

    • toJson

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

    • fromJson

      public static IndexingParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.

    • 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.