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

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.SearchIndexer"
fullName: "com.azure.search.documents.indexes.models.SearchIndexer"
name: "SearchIndexer"
nameWithType: "SearchIndexer"
summary: "Represents an indexer."
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 **SearchIndexer**</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.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.SearchIndexer(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.SearchIndexer(String name)"
  name: "SearchIndexer(String name)"
  nameWithType: "SearchIndexer.SearchIndexer(String name)"
  summary: "Creates an instance of Search<wbr>Indexer class."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer(String name)"
  desc: "Creates an instance of SearchIndexer class."
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.SearchIndexer(java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.SearchIndexer(String name, String dataSourceName, String targetIndexName)"
  name: "SearchIndexer(String name, String dataSourceName, String targetIndexName)"
  nameWithType: "SearchIndexer.SearchIndexer(String name, String dataSourceName, String targetIndexName)"
  summary: "Constructor of <xref uid=\"com.azure.search.documents.indexes.models.SearchIndexer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexer\"></xref>."
  parameters:
  - description: "The name of the indexer."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The name of the datasource from which this indexer reads data."
    name: "dataSourceName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The name of the index to which this indexer writes data."
    name: "targetIndexName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer(String name, String dataSourceName, String targetIndexName)"
  desc: "Constructor of <xref uid=\"com.azure.search.documents.indexes.models.SearchIndexer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SearchIndexer\"></xref>."
methods:
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "SearchIndexer.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Search<wbr>Indexer 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 SearchIndexer fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of SearchIndexer from the JsonReader."
  returns:
    description: "An instance of SearchIndexer 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.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getDataSourceName()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getDataSourceName()"
  name: "getDataSourceName()"
  nameWithType: "SearchIndexer.getDataSourceName()"
  summary: "Get the data<wbr>Source<wbr>Name property: The name of the datasource from which this indexer reads data."
  syntax: "public String getDataSourceName()"
  desc: "Get the dataSourceName property: The name of the datasource from which this indexer reads data."
  returns:
    description: "the dataSourceName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getDescription()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getDescription()"
  name: "getDescription()"
  nameWithType: "SearchIndexer.getDescription()"
  summary: "Get the description property: The description of the indexer."
  syntax: "public String getDescription()"
  desc: "Get the description property: The description of the indexer."
  returns:
    description: "the description value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getETag()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getETag()"
  name: "getETag()"
  nameWithType: "SearchIndexer.getETag()"
  summary: "Get the e<wbr>Tag property: The ETag of the indexer."
  syntax: "public String getETag()"
  desc: "Get the eTag property: The ETag of the indexer."
  returns:
    description: "the eTag value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getEncryptionKey()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getEncryptionKey()"
  name: "getEncryptionKey()"
  nameWithType: "SearchIndexer.getEncryptionKey()"
  summary: "Get the encryption<wbr>Key property: A description of an encryption key that you create in Azure Key Vault."
  syntax: "public SearchResourceEncryptionKey getEncryptionKey()"
  desc: "Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019."
  returns:
    description: "the encryptionKey value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getFieldMappings()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getFieldMappings()"
  name: "getFieldMappings()"
  nameWithType: "SearchIndexer.getFieldMappings()"
  summary: "Get the field<wbr>Mappings property: Defines mappings between fields in the data source and corresponding target fields in the index."
  syntax: "public List<FieldMapping> getFieldMappings()"
  desc: "Get the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index."
  returns:
    description: "the fieldMappings value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getName()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getName()"
  name: "getName()"
  nameWithType: "SearchIndexer.getName()"
  summary: "Get the name property: The name of the indexer."
  syntax: "public String getName()"
  desc: "Get the name property: The name of the indexer."
  returns:
    description: "the name value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getOutputFieldMappings()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getOutputFieldMappings()"
  name: "getOutputFieldMappings()"
  nameWithType: "SearchIndexer.getOutputFieldMappings()"
  summary: "Get the output<wbr>Field<wbr>Mappings property: Output field mappings are applied after enrichment and immediately before indexing."
  syntax: "public List<FieldMapping> getOutputFieldMappings()"
  desc: "Get the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing."
  returns:
    description: "the outputFieldMappings value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getParameters()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getParameters()"
  name: "getParameters()"
  nameWithType: "SearchIndexer.getParameters()"
  summary: "Get the parameters property: Parameters for indexer execution."
  syntax: "public IndexingParameters getParameters()"
  desc: "Get the parameters property: Parameters for indexer execution."
  returns:
    description: "the parameters value."
    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.SearchIndexer.getSchedule()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getSchedule()"
  name: "getSchedule()"
  nameWithType: "SearchIndexer.getSchedule()"
  summary: "Get the schedule property: The schedule for this indexer."
  syntax: "public IndexingSchedule getSchedule()"
  desc: "Get the schedule property: The schedule for this indexer."
  returns:
    description: "the schedule value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingSchedule?alt=com.azure.search.documents.indexes.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getSkillsetName()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getSkillsetName()"
  name: "getSkillsetName()"
  nameWithType: "SearchIndexer.getSkillsetName()"
  summary: "Get the skillset<wbr>Name property: The name of the skillset executing with this indexer."
  syntax: "public String getSkillsetName()"
  desc: "Get the skillsetName property: The name of the skillset executing with this indexer."
  returns:
    description: "the skillsetName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.getTargetIndexName()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.getTargetIndexName()"
  name: "getTargetIndexName()"
  nameWithType: "SearchIndexer.getTargetIndexName()"
  summary: "Get the target<wbr>Index<wbr>Name property: The name of the index to which this indexer writes data."
  syntax: "public String getTargetIndexName()"
  desc: "Get the targetIndexName property: The name of the index to which this indexer writes data."
  returns:
    description: "the targetIndexName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.isDisabled()"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.isDisabled()"
  name: "isDisabled()"
  nameWithType: "SearchIndexer.isDisabled()"
  summary: "Get the is<wbr>Disabled property: A value indicating whether the indexer is disabled."
  syntax: "public Boolean isDisabled()"
  desc: "Get the isDisabled property: A value indicating whether the indexer is disabled. Default is false."
  returns:
    description: "the isDisabled value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setDataSourceName(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setDataSourceName(String dataSourceName)"
  name: "setDataSourceName(String dataSourceName)"
  nameWithType: "SearchIndexer.setDataSourceName(String dataSourceName)"
  summary: "Set the data<wbr>Source<wbr>Name property: The name of the datasource from which this indexer reads data."
  parameters:
  - description: "the dataSourceName value to set."
    name: "dataSourceName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer setDataSourceName(String dataSourceName)"
  desc: "Set the dataSourceName property: The name of the datasource from which this indexer reads data."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setDescription(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setDescription(String description)"
  name: "setDescription(String description)"
  nameWithType: "SearchIndexer.setDescription(String description)"
  summary: "Set the description property: The description of the indexer."
  parameters:
  - description: "the description value to set."
    name: "description"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer setDescription(String description)"
  desc: "Set the description property: The description of the indexer."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setETag(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setETag(String eTag)"
  name: "setETag(String eTag)"
  nameWithType: "SearchIndexer.setETag(String eTag)"
  summary: "Set the e<wbr>Tag property: The ETag of the indexer."
  parameters:
  - description: "the eTag value to set."
    name: "eTag"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer setETag(String eTag)"
  desc: "Set the eTag property: The ETag of the indexer."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setEncryptionKey(com.azure.search.documents.indexes.models.SearchResourceEncryptionKey)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setEncryptionKey(SearchResourceEncryptionKey encryptionKey)"
  name: "setEncryptionKey(SearchResourceEncryptionKey encryptionKey)"
  nameWithType: "SearchIndexer.setEncryptionKey(SearchResourceEncryptionKey encryptionKey)"
  summary: "Set the encryption<wbr>Key property: A description of an encryption key that you create in Azure Key Vault."
  parameters:
  - description: "the encryptionKey value to set."
    name: "encryptionKey"
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchResourceEncryptionKey?alt=com.azure.search.documents.indexes.models.SearchResourceEncryptionKey&text=SearchResourceEncryptionKey\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public SearchIndexer setEncryptionKey(SearchResourceEncryptionKey encryptionKey)"
  desc: "Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setFieldMappings(com.azure.search.documents.indexes.models.FieldMapping...)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setFieldMappings(FieldMapping[] fieldMappings)"
  name: "setFieldMappings(FieldMapping[] fieldMappings)"
  nameWithType: "SearchIndexer.setFieldMappings(FieldMapping[] fieldMappings)"
  summary: "Set the field<wbr>Mappings property: Defines mappings between fields in the data source and corresponding target fields in the index."
  parameters:
  - description: "the fieldMappings value to set."
    name: "fieldMappings"
    type: "<xref href=\"com.azure.search.documents.indexes.models.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "public SearchIndexer setFieldMappings(FieldMapping[] fieldMappings)"
  desc: "Set the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setFieldMappings(java.util.List<com.azure.search.documents.indexes.models.FieldMapping>)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setFieldMappings(List<FieldMapping> fieldMappings)"
  name: "setFieldMappings(List<FieldMapping> fieldMappings)"
  nameWithType: "SearchIndexer.setFieldMappings(List<FieldMapping> fieldMappings)"
  summary: "Set the field<wbr>Mappings property: Defines mappings between fields in the data source and corresponding target fields in the index."
  parameters:
  - description: "the fieldMappings value to set."
    name: "fieldMappings"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public SearchIndexer setFieldMappings(List<FieldMapping> fieldMappings)"
  desc: "Set the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setIsDisabled(java.lang.Boolean)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setIsDisabled(Boolean isDisabled)"
  name: "setIsDisabled(Boolean isDisabled)"
  nameWithType: "SearchIndexer.setIsDisabled(Boolean isDisabled)"
  summary: "Set the is<wbr>Disabled property: A value indicating whether the indexer is disabled."
  parameters:
  - description: "the isDisabled value to set."
    name: "isDisabled"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public SearchIndexer setIsDisabled(Boolean isDisabled)"
  desc: "Set the isDisabled property: A value indicating whether the indexer is disabled. Default is false."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setOutputFieldMappings(com.azure.search.documents.indexes.models.FieldMapping...)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setOutputFieldMappings(FieldMapping[] outputFieldMappings)"
  name: "setOutputFieldMappings(FieldMapping[] outputFieldMappings)"
  nameWithType: "SearchIndexer.setOutputFieldMappings(FieldMapping[] outputFieldMappings)"
  summary: "Set the output<wbr>Field<wbr>Mappings property: Output field mappings are applied after enrichment and immediately before indexing."
  parameters:
  - description: "the outputFieldMappings value to set."
    name: "outputFieldMappings"
    type: "<xref href=\"com.azure.search.documents.indexes.models.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "public SearchIndexer setOutputFieldMappings(FieldMapping[] outputFieldMappings)"
  desc: "Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setOutputFieldMappings(java.util.List<com.azure.search.documents.indexes.models.FieldMapping>)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
  name: "setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
  nameWithType: "SearchIndexer.setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
  summary: "Set the output<wbr>Field<wbr>Mappings property: Output field mappings are applied after enrichment and immediately before indexing."
  parameters:
  - description: "the outputFieldMappings value to set."
    name: "outputFieldMappings"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public SearchIndexer setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
  desc: "Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setParameters(com.azure.search.documents.indexes.models.IndexingParameters)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setParameters(IndexingParameters parameters)"
  name: "setParameters(IndexingParameters parameters)"
  nameWithType: "SearchIndexer.setParameters(IndexingParameters parameters)"
  summary: "Set the parameters property: Parameters for indexer execution."
  parameters:
  - description: "the parameters value to set."
    name: "parameters"
    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\" />"
  syntax: "public SearchIndexer setParameters(IndexingParameters parameters)"
  desc: "Set the parameters property: Parameters for indexer execution."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setSchedule(com.azure.search.documents.indexes.models.IndexingSchedule)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setSchedule(IndexingSchedule schedule)"
  name: "setSchedule(IndexingSchedule schedule)"
  nameWithType: "SearchIndexer.setSchedule(IndexingSchedule schedule)"
  summary: "Set the schedule property: The schedule for this indexer."
  parameters:
  - description: "the schedule value to set."
    name: "schedule"
    type: "<xref href=\"com.azure.search.documents.indexes.models.IndexingSchedule?alt=com.azure.search.documents.indexes.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public SearchIndexer setSchedule(IndexingSchedule schedule)"
  desc: "Set the schedule property: The schedule for this indexer."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setSkillsetName(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setSkillsetName(String skillsetName)"
  name: "setSkillsetName(String skillsetName)"
  nameWithType: "SearchIndexer.setSkillsetName(String skillsetName)"
  summary: "Set the skillset<wbr>Name property: The name of the skillset executing with this indexer."
  parameters:
  - description: "the skillsetName value to set."
    name: "skillsetName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer setSkillsetName(String skillsetName)"
  desc: "Set the skillsetName property: The name of the skillset executing with this indexer."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.setTargetIndexName(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.setTargetIndexName(String targetIndexName)"
  name: "setTargetIndexName(String targetIndexName)"
  nameWithType: "SearchIndexer.setTargetIndexName(String targetIndexName)"
  summary: "Set the target<wbr>Index<wbr>Name property: The name of the index to which this indexer writes data."
  parameters:
  - description: "the targetIndexName value to set."
    name: "targetIndexName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public SearchIndexer setTargetIndexName(String targetIndexName)"
  desc: "Set the targetIndexName property: The name of the index to which this indexer writes data."
  returns:
    description: "the SearchIndexer object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SearchIndexer.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.SearchIndexer.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "SearchIndexer.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 an indexer."
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.SearchIndexer?alt=com.azure.search.documents.indexes.models.SearchIndexer&text=SearchIndexer\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.0