com.azure.search.documents.indexes.models.IndexingParameters.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.IndexingParameters"
fullName: "com.azure.search.documents.indexes.models.IndexingParameters"
name: "IndexingParameters"
nameWithType: "IndexingParameters"
summary: "Represents parameters for indexer execution."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **IndexingParameters**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.IndexingParameters()"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.IndexingParameters()"
  name: "IndexingParameters()"
  nameWithType: "IndexingParameters.IndexingParameters()"
  summary: "Creates an instance of Indexing<wbr>Parameters class."
  syntax: "public IndexingParameters()"
  desc: "Creates an instance of IndexingParameters class."
methods:
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "IndexingParameters.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Indexing<wbr>Parameters from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static IndexingParameters fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the IndexingParameters."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of IndexingParameters from the JsonReader."
  returns:
    description: "An instance of IndexingParameters if the JsonReader was pointing to an instance of it, or null if it was\n     pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.getBatchSize()"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.getBatchSize()"
  name: "getBatchSize()"
  nameWithType: "IndexingParameters.getBatchSize()"
  summary: "Get the batch<wbr>Size property: The number of items that are read from the data source and indexed as a single batch in order to improve performance."
  syntax: "public Integer getBatchSize()"
  desc: "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:
    description: "the batchSize value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.getConfiguration()"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.getConfiguration()"
  name: "getConfiguration()"
  nameWithType: "IndexingParameters.getConfiguration()"
  summary: "Get the configuration property: A dictionary of indexer-specific configuration properties."
  syntax: "public Map<String,Object> getConfiguration()"
  desc: "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:
    description: "the configuration value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.getIndexingParametersConfiguration()"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.getIndexingParametersConfiguration()"
  name: "getIndexingParametersConfiguration()"
  nameWithType: "IndexingParameters.getIndexingParametersConfiguration()"
  summary: "Get the configuration property: A dictionary of indexer-specific configuration properties."
  syntax: "public IndexingParametersConfiguration getIndexingParametersConfiguration()"
  desc: "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:
    description: "the configuration value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParametersConfiguration?alt=com.azure.search.documents.indexes.models.IndexingParametersConfiguration&text=IndexingParametersConfiguration\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.getMaxFailedItems()"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.getMaxFailedItems()"
  name: "getMaxFailedItems()"
  nameWithType: "IndexingParameters.getMaxFailedItems()"
  summary: "Get the max<wbr>Failed<wbr>Items property: The maximum number of items that can fail indexing for indexer execution to still be considered successful."
  syntax: "public Integer getMaxFailedItems()"
  desc: "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:
    description: "the maxFailedItems value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.getMaxFailedItemsPerBatch()"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.getMaxFailedItemsPerBatch()"
  name: "getMaxFailedItemsPerBatch()"
  nameWithType: "IndexingParameters.getMaxFailedItemsPerBatch()"
  summary: "Get the max<wbr>Failed<wbr>Items<wbr>Per<wbr>Batch property: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful."
  syntax: "public Integer getMaxFailedItemsPerBatch()"
  desc: "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:
    description: "the maxFailedItemsPerBatch value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.setBatchSize(java.lang.Integer)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.setBatchSize(Integer batchSize)"
  name: "setBatchSize(Integer batchSize)"
  nameWithType: "IndexingParameters.setBatchSize(Integer batchSize)"
  summary: "Set the batch<wbr>Size property: The number of items that are read from the data source and indexed as a single batch in order to improve performance."
  parameters:
  - description: "the batchSize value to set."
    name: "batchSize"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public IndexingParameters setBatchSize(Integer batchSize)"
  desc: "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."
  returns:
    description: "the IndexingParameters object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.setConfiguration(java.util.Map<java.lang.String,java.lang.Object>)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.setConfiguration(Map<String,Object> configuration)"
  name: "setConfiguration(Map<String,Object> configuration)"
  nameWithType: "IndexingParameters.setConfiguration(Map<String,Object> configuration)"
  summary: "Set the configuration property: A dictionary of indexer-specific configuration properties."
  parameters:
  - description: "the configuration value to set."
    name: "configuration"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
  syntax: "public IndexingParameters setConfiguration(Map<String,Object> configuration)"
  desc: "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."
  returns:
    description: "the IndexingParameters object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.setIndexingParametersConfiguration(com.azure.search.documents.indexes.models.IndexingParametersConfiguration)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.setIndexingParametersConfiguration(IndexingParametersConfiguration configuration)"
  name: "setIndexingParametersConfiguration(IndexingParametersConfiguration configuration)"
  nameWithType: "IndexingParameters.setIndexingParametersConfiguration(IndexingParametersConfiguration configuration)"
  summary: "Set the configuration property: A dictionary of indexer-specific configuration properties."
  parameters:
  - description: "the configuration value to set."
    name: "configuration"
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParametersConfiguration?alt=com.azure.search.documents.indexes.models.IndexingParametersConfiguration&text=IndexingParametersConfiguration\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public IndexingParameters setIndexingParametersConfiguration(IndexingParametersConfiguration configuration)"
  desc: "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."
  returns:
    description: "the IndexingParameters object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.setMaxFailedItems(java.lang.Integer)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.setMaxFailedItems(Integer maxFailedItems)"
  name: "setMaxFailedItems(Integer maxFailedItems)"
  nameWithType: "IndexingParameters.setMaxFailedItems(Integer maxFailedItems)"
  summary: "Set the max<wbr>Failed<wbr>Items property: The maximum number of items that can fail indexing for indexer execution to still be considered successful."
  parameters:
  - description: "the maxFailedItems value to set."
    name: "maxFailedItems"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public IndexingParameters setMaxFailedItems(Integer maxFailedItems)"
  desc: "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."
  returns:
    description: "the IndexingParameters object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.setMaxFailedItemsPerBatch(java.lang.Integer)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.setMaxFailedItemsPerBatch(Integer maxFailedItemsPerBatch)"
  name: "setMaxFailedItemsPerBatch(Integer maxFailedItemsPerBatch)"
  nameWithType: "IndexingParameters.setMaxFailedItemsPerBatch(Integer maxFailedItemsPerBatch)"
  summary: "Set the max<wbr>Failed<wbr>Items<wbr>Per<wbr>Batch property: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful."
  parameters:
  - description: "the maxFailedItemsPerBatch value to set."
    name: "maxFailedItemsPerBatch"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public IndexingParameters setMaxFailedItemsPerBatch(Integer maxFailedItemsPerBatch)"
  desc: "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."
  returns:
    description: "the IndexingParameters object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.IndexingParameters.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.IndexingParameters.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "IndexingParameters.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents parameters for indexer execution."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.IndexingParameters?alt=com.azure.search.documents.indexes.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.6.6