300 строки
19 KiB
YAML
300 строки
19 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.models.Indexer"
|
|
fullName: "com.azure.search.models.Indexer"
|
|
name: "Indexer"
|
|
nameWithType: "Indexer"
|
|
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 **Indexer**"
|
|
constructors:
|
|
- uid: "com.azure.search.models.Indexer.Indexer()"
|
|
fullName: "com.azure.search.models.Indexer.Indexer()"
|
|
name: "Indexer()"
|
|
nameWithType: "Indexer.Indexer()"
|
|
syntax: "public Indexer()"
|
|
methods:
|
|
- uid: "com.azure.search.models.Indexer.getDataSourceName()"
|
|
fullName: "com.azure.search.models.Indexer.getDataSourceName()"
|
|
name: "getDataSourceName()"
|
|
nameWithType: "Indexer.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.models.Indexer.getDescription()"
|
|
fullName: "com.azure.search.models.Indexer.getDescription()"
|
|
name: "getDescription()"
|
|
nameWithType: "Indexer.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.models.Indexer.getETag()"
|
|
fullName: "com.azure.search.models.Indexer.getETag()"
|
|
name: "getETag()"
|
|
nameWithType: "Indexer.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.models.Indexer.getFieldMappings()"
|
|
fullName: "com.azure.search.models.Indexer.getFieldMappings()"
|
|
name: "getFieldMappings()"
|
|
nameWithType: "Indexer.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><<xref href=\"com.azure.search.models.FieldMapping?alt=com.azure.search.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.models.Indexer.getName()"
|
|
fullName: "com.azure.search.models.Indexer.getName()"
|
|
name: "getName()"
|
|
nameWithType: "Indexer.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.models.Indexer.getOutputFieldMappings()"
|
|
fullName: "com.azure.search.models.Indexer.getOutputFieldMappings()"
|
|
name: "getOutputFieldMappings()"
|
|
nameWithType: "Indexer.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><<xref href=\"com.azure.search.models.FieldMapping?alt=com.azure.search.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.models.Indexer.getParameters()"
|
|
fullName: "com.azure.search.models.Indexer.getParameters()"
|
|
name: "getParameters()"
|
|
nameWithType: "Indexer.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.models.IndexingParameters?alt=com.azure.search.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.getSchedule()"
|
|
fullName: "com.azure.search.models.Indexer.getSchedule()"
|
|
name: "getSchedule()"
|
|
nameWithType: "Indexer.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.models.IndexingSchedule?alt=com.azure.search.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.getSkillsetName()"
|
|
fullName: "com.azure.search.models.Indexer.getSkillsetName()"
|
|
name: "getSkillsetName()"
|
|
nameWithType: "Indexer.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.models.Indexer.getTargetIndexName()"
|
|
fullName: "com.azure.search.models.Indexer.getTargetIndexName()"
|
|
name: "getTargetIndexName()"
|
|
nameWithType: "Indexer.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.models.Indexer.isDisabled()"
|
|
fullName: "com.azure.search.models.Indexer.isDisabled()"
|
|
name: "isDisabled()"
|
|
nameWithType: "Indexer.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.models.Indexer.setDataSourceName(java.lang.String)"
|
|
fullName: "com.azure.search.models.Indexer.setDataSourceName(String dataSourceName)"
|
|
name: "setDataSourceName(String dataSourceName)"
|
|
nameWithType: "Indexer.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 Indexer setDataSourceName(String dataSourceName)"
|
|
desc: "Set the dataSourceName property: The name of the datasource from which this indexer reads data."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setDescription(java.lang.String)"
|
|
fullName: "com.azure.search.models.Indexer.setDescription(String description)"
|
|
name: "setDescription(String description)"
|
|
nameWithType: "Indexer.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 Indexer setDescription(String description)"
|
|
desc: "Set the description property: The description of the indexer."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setETag(java.lang.String)"
|
|
fullName: "com.azure.search.models.Indexer.setETag(String eTag)"
|
|
name: "setETag(String eTag)"
|
|
nameWithType: "Indexer.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 Indexer setETag(String eTag)"
|
|
desc: "Set the eTag property: The ETag of the Indexer."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setFieldMappings(java.util.List<com.azure.search.models.FieldMapping>)"
|
|
fullName: "com.azure.search.models.Indexer.setFieldMappings(List<FieldMapping> fieldMappings)"
|
|
name: "setFieldMappings(List<FieldMapping> fieldMappings)"
|
|
nameWithType: "Indexer.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><<xref href=\"com.azure.search.models.FieldMapping?alt=com.azure.search.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public Indexer 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 Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setIsDisabled(java.lang.Boolean)"
|
|
fullName: "com.azure.search.models.Indexer.setIsDisabled(Boolean isDisabled)"
|
|
name: "setIsDisabled(Boolean isDisabled)"
|
|
nameWithType: "Indexer.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 Indexer setIsDisabled(Boolean isDisabled)"
|
|
desc: "Set the isDisabled property: A value indicating whether the indexer is disabled. Default is false."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setName(java.lang.String)"
|
|
fullName: "com.azure.search.models.Indexer.setName(String name)"
|
|
name: "setName(String name)"
|
|
nameWithType: "Indexer.setName(String name)"
|
|
summary: "Set the name property: The name of the indexer."
|
|
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 Indexer setName(String name)"
|
|
desc: "Set the name property: The name of the indexer."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setOutputFieldMappings(java.util.List<com.azure.search.models.FieldMapping>)"
|
|
fullName: "com.azure.search.models.Indexer.setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
|
|
name: "setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
|
|
nameWithType: "Indexer.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><<xref href=\"com.azure.search.models.FieldMapping?alt=com.azure.search.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public Indexer setOutputFieldMappings(List<FieldMapping> outputFieldMappings)"
|
|
desc: "Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setParameters(com.azure.search.models.IndexingParameters)"
|
|
fullName: "com.azure.search.models.Indexer.setParameters(IndexingParameters parameters)"
|
|
name: "setParameters(IndexingParameters parameters)"
|
|
nameWithType: "Indexer.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.models.IndexingParameters?alt=com.azure.search.models.IndexingParameters&text=IndexingParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Indexer setParameters(IndexingParameters parameters)"
|
|
desc: "Set the parameters property: Parameters for indexer execution."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setSchedule(com.azure.search.models.IndexingSchedule)"
|
|
fullName: "com.azure.search.models.Indexer.setSchedule(IndexingSchedule schedule)"
|
|
name: "setSchedule(IndexingSchedule schedule)"
|
|
nameWithType: "Indexer.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.models.IndexingSchedule?alt=com.azure.search.models.IndexingSchedule&text=IndexingSchedule\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Indexer setSchedule(IndexingSchedule schedule)"
|
|
desc: "Set the schedule property: The schedule for this indexer."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setSkillsetName(java.lang.String)"
|
|
fullName: "com.azure.search.models.Indexer.setSkillsetName(String skillsetName)"
|
|
name: "setSkillsetName(String skillsetName)"
|
|
nameWithType: "Indexer.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 Indexer setSkillsetName(String skillsetName)"
|
|
desc: "Set the skillsetName property: The name of the skillset executing with this indexer."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.Indexer.setTargetIndexName(java.lang.String)"
|
|
fullName: "com.azure.search.models.Indexer.setTargetIndexName(String targetIndexName)"
|
|
name: "setTargetIndexName(String targetIndexName)"
|
|
nameWithType: "Indexer.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 Indexer setTargetIndexName(String targetIndexName)"
|
|
desc: "Set the targetIndexName property: The name of the index to which this indexer writes data."
|
|
returns:
|
|
description: "the Indexer object itself."
|
|
type: "<xref href=\"com.azure.search.models.Indexer?alt=com.azure.search.models.Indexer&text=Indexer\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents an indexer."
|
|
metadata: {}
|
|
package: "com.azure.search.models"
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|