azure-docs-sdk-java/legacy/docs-ref-autogen/com.azure.search.models.Ind...

324 строки
23 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.models.Index"
fullName: "com.azure.search.models.Index"
name: "Index"
nameWithType: "Index"
summary: "Represents a search index definition, which describes the fields and search behavior of 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 **Index**"
constructors:
- uid: "com.azure.search.models.Index.Index()"
fullName: "com.azure.search.models.Index.Index()"
name: "Index()"
nameWithType: "Index.Index()"
syntax: "public Index()"
methods:
- uid: "com.azure.search.models.Index.getAnalyzers()"
fullName: "com.azure.search.models.Index.getAnalyzers()"
name: "getAnalyzers()"
nameWithType: "Index.getAnalyzers()"
summary: "Get the analyzers property: The analyzers for the index."
syntax: "public List<Analyzer> getAnalyzers()"
desc: "Get the analyzers property: The analyzers for the index."
returns:
description: "the analyzers value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Analyzer?alt=com.azure.search.models.Analyzer&text=Analyzer\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.getCharFilters()"
fullName: "com.azure.search.models.Index.getCharFilters()"
name: "getCharFilters()"
nameWithType: "Index.getCharFilters()"
summary: "Get the char<wbr>Filters property: The character filters for the index."
syntax: "public List<CharFilter> getCharFilters()"
desc: "Get the charFilters property: The character filters for the index."
returns:
description: "the charFilters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.CharFilter?alt=com.azure.search.models.CharFilter&text=CharFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.getCorsOptions()"
fullName: "com.azure.search.models.Index.getCorsOptions()"
name: "getCorsOptions()"
nameWithType: "Index.getCorsOptions()"
summary: "Get the cors<wbr>Options property: Options to control Cross-Origin Resource Sharing (CORS) for the index."
syntax: "public CorsOptions getCorsOptions()"
desc: "Get the corsOptions property: Options to control Cross-Origin Resource Sharing (CORS) for the index."
returns:
description: "the corsOptions value."
type: "<xref href=\"com.azure.search.models.CorsOptions?alt=com.azure.search.models.CorsOptions&text=CorsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.getDefaultScoringProfile()"
fullName: "com.azure.search.models.Index.getDefaultScoringProfile()"
name: "getDefaultScoringProfile()"
nameWithType: "Index.getDefaultScoringProfile()"
summary: "Get the default<wbr>Scoring<wbr>Profile property: The name of the scoring profile to use if none is specified in the query."
syntax: "public String getDefaultScoringProfile()"
desc: "Get the defaultScoringProfile property: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used."
returns:
description: "the defaultScoringProfile value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.models.Index.getETag()"
fullName: "com.azure.search.models.Index.getETag()"
name: "getETag()"
nameWithType: "Index.getETag()"
summary: "Get the e<wbr>Tag property: The ETag of the index."
syntax: "public String getETag()"
desc: "Get the eTag property: The ETag of the index."
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.Index.getEncryptionKey()"
fullName: "com.azure.search.models.Index.getEncryptionKey()"
name: "getEncryptionKey()"
nameWithType: "Index.getEncryptionKey()"
summary: "Get the encryption<wbr>Key property: A description of an encryption key that you create in Azure Key Vault."
syntax: "public EncryptionKey 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 data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search 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 data 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.models.EncryptionKey?alt=com.azure.search.models.EncryptionKey&text=EncryptionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.getFields()"
fullName: "com.azure.search.models.Index.getFields()"
name: "getFields()"
nameWithType: "Index.getFields()"
summary: "Get the fields property: The fields of the index."
syntax: "public List<Field> getFields()"
desc: "Get the fields property: The fields of the index."
returns:
description: "the fields value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Field?alt=com.azure.search.models.Field&text=Field\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.getName()"
fullName: "com.azure.search.models.Index.getName()"
name: "getName()"
nameWithType: "Index.getName()"
summary: "Get the name property: The name of the index."
syntax: "public String getName()"
desc: "Get the name property: The name of the index."
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.Index.getScoringProfiles()"
fullName: "com.azure.search.models.Index.getScoringProfiles()"
name: "getScoringProfiles()"
nameWithType: "Index.getScoringProfiles()"
summary: "Get the scoring<wbr>Profiles property: The scoring profiles for the index."
syntax: "public List<ScoringProfile> getScoringProfiles()"
desc: "Get the scoringProfiles property: The scoring profiles for the index."
returns:
description: "the scoringProfiles value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.ScoringProfile?alt=com.azure.search.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.getSuggesters()"
fullName: "com.azure.search.models.Index.getSuggesters()"
name: "getSuggesters()"
nameWithType: "Index.getSuggesters()"
summary: "Get the suggesters property: The suggesters for the index."
syntax: "public List<Suggester> getSuggesters()"
desc: "Get the suggesters property: The suggesters for the index."
returns:
description: "the suggesters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Suggester?alt=com.azure.search.models.Suggester&text=Suggester\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.getTokenFilters()"
fullName: "com.azure.search.models.Index.getTokenFilters()"
name: "getTokenFilters()"
nameWithType: "Index.getTokenFilters()"
summary: "Get the token<wbr>Filters property: The token filters for the index."
syntax: "public List<TokenFilter> getTokenFilters()"
desc: "Get the tokenFilters property: The token filters for the index."
returns:
description: "the tokenFilters value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.TokenFilter?alt=com.azure.search.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.getTokenizers()"
fullName: "com.azure.search.models.Index.getTokenizers()"
name: "getTokenizers()"
nameWithType: "Index.getTokenizers()"
summary: "Get the tokenizers property: The tokenizers for the index."
syntax: "public List<Tokenizer> getTokenizers()"
desc: "Get the tokenizers property: The tokenizers for the index."
returns:
description: "the tokenizers value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Tokenizer?alt=com.azure.search.models.Tokenizer&text=Tokenizer\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.models.Index.setAnalyzers(java.util.List<com.azure.search.models.Analyzer>)"
fullName: "com.azure.search.models.Index.setAnalyzers(List<Analyzer> analyzers)"
name: "setAnalyzers(List<Analyzer> analyzers)"
nameWithType: "Index.setAnalyzers(List<Analyzer> analyzers)"
summary: "Set the analyzers property: The analyzers for the index."
parameters:
- description: "the analyzers value to set."
name: "analyzers"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Analyzer?alt=com.azure.search.models.Analyzer&text=Analyzer\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setAnalyzers(List<Analyzer> analyzers)"
desc: "Set the analyzers property: The analyzers for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setCharFilters(java.util.List<com.azure.search.models.CharFilter>)"
fullName: "com.azure.search.models.Index.setCharFilters(List<CharFilter> charFilters)"
name: "setCharFilters(List<CharFilter> charFilters)"
nameWithType: "Index.setCharFilters(List<CharFilter> charFilters)"
summary: "Set the char<wbr>Filters property: The character filters for the index."
parameters:
- description: "the charFilters value to set."
name: "charFilters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.CharFilter?alt=com.azure.search.models.CharFilter&text=CharFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setCharFilters(List<CharFilter> charFilters)"
desc: "Set the charFilters property: The character filters for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setCorsOptions(com.azure.search.models.CorsOptions)"
fullName: "com.azure.search.models.Index.setCorsOptions(CorsOptions corsOptions)"
name: "setCorsOptions(CorsOptions corsOptions)"
nameWithType: "Index.setCorsOptions(CorsOptions corsOptions)"
summary: "Set the cors<wbr>Options property: Options to control Cross-Origin Resource Sharing (CORS) for the index."
parameters:
- description: "the corsOptions value to set."
name: "corsOptions"
type: "<xref href=\"com.azure.search.models.CorsOptions?alt=com.azure.search.models.CorsOptions&text=CorsOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Index setCorsOptions(CorsOptions corsOptions)"
desc: "Set the corsOptions property: Options to control Cross-Origin Resource Sharing (CORS) for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setDefaultScoringProfile(java.lang.String)"
fullName: "com.azure.search.models.Index.setDefaultScoringProfile(String defaultScoringProfile)"
name: "setDefaultScoringProfile(String defaultScoringProfile)"
nameWithType: "Index.setDefaultScoringProfile(String defaultScoringProfile)"
summary: "Set the default<wbr>Scoring<wbr>Profile property: The name of the scoring profile to use if none is specified in the query."
parameters:
- description: "the defaultScoringProfile value to set."
name: "defaultScoringProfile"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Index setDefaultScoringProfile(String defaultScoringProfile)"
desc: "Set the defaultScoringProfile property: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setETag(java.lang.String)"
fullName: "com.azure.search.models.Index.setETag(String eTag)"
name: "setETag(String eTag)"
nameWithType: "Index.setETag(String eTag)"
summary: "Set the e<wbr>Tag property: The ETag of the index."
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 Index setETag(String eTag)"
desc: "Set the eTag property: The ETag of the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setEncryptionKey(com.azure.search.models.EncryptionKey)"
fullName: "com.azure.search.models.Index.setEncryptionKey(EncryptionKey encryptionKey)"
name: "setEncryptionKey(EncryptionKey encryptionKey)"
nameWithType: "Index.setEncryptionKey(EncryptionKey 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.models.EncryptionKey?alt=com.azure.search.models.EncryptionKey&text=EncryptionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Index setEncryptionKey(EncryptionKey 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 data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search 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 data 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 Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setFields(java.util.List<com.azure.search.models.Field>)"
fullName: "com.azure.search.models.Index.setFields(List<Field> fields)"
name: "setFields(List<Field> fields)"
nameWithType: "Index.setFields(List<Field> fields)"
summary: "Set the fields property: The fields of the index."
parameters:
- description: "the fields value to set."
name: "fields"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Field?alt=com.azure.search.models.Field&text=Field\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setFields(List<Field> fields)"
desc: "Set the fields property: The fields of the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setName(java.lang.String)"
fullName: "com.azure.search.models.Index.setName(String name)"
name: "setName(String name)"
nameWithType: "Index.setName(String name)"
summary: "Set the name property: The name of the index."
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 Index setName(String name)"
desc: "Set the name property: The name of the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setScoringProfiles(java.util.List<com.azure.search.models.ScoringProfile>)"
fullName: "com.azure.search.models.Index.setScoringProfiles(List<ScoringProfile> scoringProfiles)"
name: "setScoringProfiles(List<ScoringProfile> scoringProfiles)"
nameWithType: "Index.setScoringProfiles(List<ScoringProfile> scoringProfiles)"
summary: "Set the scoring<wbr>Profiles property: The scoring profiles for the index."
parameters:
- description: "the scoringProfiles value to set."
name: "scoringProfiles"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.ScoringProfile?alt=com.azure.search.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setScoringProfiles(List<ScoringProfile> scoringProfiles)"
desc: "Set the scoringProfiles property: The scoring profiles for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setSuggesters(java.util.List<com.azure.search.models.Suggester>)"
fullName: "com.azure.search.models.Index.setSuggesters(List<Suggester> suggesters)"
name: "setSuggesters(List<Suggester> suggesters)"
nameWithType: "Index.setSuggesters(List<Suggester> suggesters)"
summary: "Set the suggesters property: The suggesters for the index."
parameters:
- description: "the suggesters value to set."
name: "suggesters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Suggester?alt=com.azure.search.models.Suggester&text=Suggester\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setSuggesters(List<Suggester> suggesters)"
desc: "Set the suggesters property: The suggesters for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setTokenFilters(java.util.List<com.azure.search.models.TokenFilter>)"
fullName: "com.azure.search.models.Index.setTokenFilters(List<TokenFilter> tokenFilters)"
name: "setTokenFilters(List<TokenFilter> tokenFilters)"
nameWithType: "Index.setTokenFilters(List<TokenFilter> tokenFilters)"
summary: "Set the token<wbr>Filters property: The token filters for the index."
parameters:
- description: "the tokenFilters value to set."
name: "tokenFilters"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.TokenFilter?alt=com.azure.search.models.TokenFilter&text=TokenFilter\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setTokenFilters(List<TokenFilter> tokenFilters)"
desc: "Set the tokenFilters property: The token filters for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.models.Index.setTokenizers(java.util.List<com.azure.search.models.Tokenizer>)"
fullName: "com.azure.search.models.Index.setTokenizers(List<Tokenizer> tokenizers)"
name: "setTokenizers(List<Tokenizer> tokenizers)"
nameWithType: "Index.setTokenizers(List<Tokenizer> tokenizers)"
summary: "Set the tokenizers property: The tokenizers for the index."
parameters:
- description: "the tokenizers value to set."
name: "tokenizers"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.models.Tokenizer?alt=com.azure.search.models.Tokenizer&text=Tokenizer\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public Index setTokenizers(List<Tokenizer> tokenizers)"
desc: "Set the tokenizers property: The tokenizers for the index."
returns:
description: "the Index object itself."
type: "<xref href=\"com.azure.search.models.Index?alt=com.azure.search.models.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a search index definition, which describes the fields and search behavior of an index."
metadata: {}
package: "com.azure.search.models"
artifact: com.azure:azure-search:11.0.0-beta.1