133 строки
9.9 KiB
YAML
133 строки
9.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.FieldMapping"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping"
|
|
name: "FieldMapping"
|
|
nameWithType: "FieldMapping"
|
|
summary: "Defines a mapping between a field in a data source and a target field in an index."
|
|
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 **FieldMapping**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<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\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.FieldMapping.FieldMapping(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.FieldMapping(String sourceFieldName)"
|
|
name: "FieldMapping(String sourceFieldName)"
|
|
nameWithType: "FieldMapping.FieldMapping(String sourceFieldName)"
|
|
summary: "Creates an instance of Field<wbr>Mapping class."
|
|
parameters:
|
|
- description: "the sourceFieldName value to set."
|
|
name: "sourceFieldName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public FieldMapping(String sourceFieldName)"
|
|
desc: "Creates an instance of FieldMapping class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.FieldMapping.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "FieldMapping.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Field<wbr>Mapping 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 FieldMapping 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 FieldMapping from the JsonReader."
|
|
returns:
|
|
description: "An instance of FieldMapping 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.FieldMapping?alt=com.azure.search.documents.indexes.models.FieldMapping&text=FieldMapping\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.FieldMapping.getMappingFunction()"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.getMappingFunction()"
|
|
name: "getMappingFunction()"
|
|
nameWithType: "FieldMapping.getMappingFunction()"
|
|
summary: "Get the mapping<wbr>Function property: A function to apply to each source field value before indexing."
|
|
syntax: "public FieldMappingFunction getMappingFunction()"
|
|
desc: "Get the mappingFunction property: A function to apply to each source field value before indexing."
|
|
returns:
|
|
description: "the mappingFunction value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.FieldMappingFunction?alt=com.azure.search.documents.indexes.models.FieldMappingFunction&text=FieldMappingFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.FieldMapping.getSourceFieldName()"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.getSourceFieldName()"
|
|
name: "getSourceFieldName()"
|
|
nameWithType: "FieldMapping.getSourceFieldName()"
|
|
summary: "Get the source<wbr>Field<wbr>Name property: The name of the field in the data source."
|
|
syntax: "public String getSourceFieldName()"
|
|
desc: "Get the sourceFieldName property: The name of the field in the data source."
|
|
returns:
|
|
description: "the sourceFieldName 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.FieldMapping.getTargetFieldName()"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.getTargetFieldName()"
|
|
name: "getTargetFieldName()"
|
|
nameWithType: "FieldMapping.getTargetFieldName()"
|
|
summary: "Get the target<wbr>Field<wbr>Name property: The name of the target field in the index."
|
|
syntax: "public String getTargetFieldName()"
|
|
desc: "Get the targetFieldName property: The name of the target field in the index. Same as the source field name by default."
|
|
returns:
|
|
description: "the targetFieldName 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.FieldMapping.setMappingFunction(com.azure.search.documents.indexes.models.FieldMappingFunction)"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.setMappingFunction(FieldMappingFunction mappingFunction)"
|
|
name: "setMappingFunction(FieldMappingFunction mappingFunction)"
|
|
nameWithType: "FieldMapping.setMappingFunction(FieldMappingFunction mappingFunction)"
|
|
summary: "Set the mapping<wbr>Function property: A function to apply to each source field value before indexing."
|
|
parameters:
|
|
- description: "the mappingFunction value to set."
|
|
name: "mappingFunction"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.FieldMappingFunction?alt=com.azure.search.documents.indexes.models.FieldMappingFunction&text=FieldMappingFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FieldMapping setMappingFunction(FieldMappingFunction mappingFunction)"
|
|
desc: "Set the mappingFunction property: A function to apply to each source field value before indexing."
|
|
returns:
|
|
description: "the FieldMapping object itself."
|
|
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\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.FieldMapping.setTargetFieldName(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.setTargetFieldName(String targetFieldName)"
|
|
name: "setTargetFieldName(String targetFieldName)"
|
|
nameWithType: "FieldMapping.setTargetFieldName(String targetFieldName)"
|
|
summary: "Set the target<wbr>Field<wbr>Name property: The name of the target field in the index."
|
|
parameters:
|
|
- description: "the targetFieldName value to set."
|
|
name: "targetFieldName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public FieldMapping setTargetFieldName(String targetFieldName)"
|
|
desc: "Set the targetFieldName property: The name of the target field in the index. Same as the source field name by default."
|
|
returns:
|
|
description: "the FieldMapping object itself."
|
|
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\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.FieldMapping.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.FieldMapping.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "FieldMapping.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: "Defines a mapping between a field in a data source and a target field in an index."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<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\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|