SearchIndexResponse Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SearchIndexResponse

Implements

JsonSerializable<SearchIndexResponse>

public final class SearchIndexResponse
implements JsonSerializable<SearchIndexResponse>

Represents a search index definition, which describes the fields and search behavior of an index.

Method Summary

Modifier and Type Method and Description
static SearchIndexResponse fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexResponse from the JsonReader.
List<LexicalAnalyzer> getAnalyzers()

Get the analyzers property: The analyzers for the index.
List<CharFilter> getCharFilters()

Get the charFilters property: The character filters for the index.
CorsOptions getCorsOptions()

Get the corsOptions property: Options to control Cross-Origin Resource Sharing (CORS) for the index.
String getDefaultScoringProfile()

Get the defaultScoringProfile property: The name of the scoring profile to use if none is specified in the query.
String getDescription()

Get the description property: The description of the index.
SearchResourceEncryptionKey getEncryptionKey()

Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
String getETag()

Get the eTag property: The ETag of the index.
List<SearchField> getFields()

Get the fields property: The fields of the index.
String getName()

Get the name property: The name of the index.
List<LexicalNormalizer> getNormalizers()

Get the normalizers property: The normalizers for the index.
List<ScoringProfile> getScoringProfiles()

Get the scoringProfiles property: The scoring profiles for the index.
SemanticSearch getSemanticSearch()

Get the semanticSearch property: Defines parameters for a search index that influence semantic capabilities.
SimilarityAlgorithm getSimilarity()

Get the similarity property: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query.
List<SearchSuggester> getSuggesters()

Get the suggesters property: The suggesters for the index.
List<TokenFilter> getTokenFilters()

Get the tokenFilters property: The token filters for the index.
List<LexicalTokenizer> getTokenizers()

Get the tokenizers property: The tokenizers for the index.
VectorSearch getVectorSearch()

Get the vectorSearch property: Contains configuration options related to vector search.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static SearchIndexResponse fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexResponse from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexResponse if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAnalyzers

public List<LexicalAnalyzer> getAnalyzers()

Get the analyzers property: The analyzers for the index.

Returns:

the analyzers value.

getCharFilters

public List<CharFilter> getCharFilters()

Get the charFilters property: The character filters for the index.

Returns:

the charFilters value.

getCorsOptions

public CorsOptions getCorsOptions()

Get the corsOptions property: Options to control Cross-Origin Resource Sharing (CORS) for the index.

Returns:

the corsOptions value.

getDefaultScoringProfile

public String getDefaultScoringProfile()

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:

the defaultScoringProfile value.

getDescription

public String getDescription()

Get the description property: The description of the index.

Returns:

the description value.

getEncryptionKey

public SearchResourceEncryptionKey getEncryptionKey()

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. Once you have encrypted your data, 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 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:

the encryptionKey value.

getETag

public String getETag()

Get the eTag property: The ETag of the index.

Returns:

the eTag value.

getFields

public List<SearchField> getFields()

Get the fields property: The fields of the index.

Returns:

the fields value.

getName

public String getName()

Get the name property: The name of the index.

Returns:

the name value.

getNormalizers

public List<LexicalNormalizer> getNormalizers()

Get the normalizers property: The normalizers for the index.

Returns:

the normalizers value.

getScoringProfiles

public List<ScoringProfile> getScoringProfiles()

Get the scoringProfiles property: The scoring profiles for the index.

Returns:

the scoringProfiles value.

getSemanticSearch

public SemanticSearch getSemanticSearch()

Get the semanticSearch property: Defines parameters for a search index that influence semantic capabilities.

Returns:

the semanticSearch value.

getSimilarity

public SimilarityAlgorithm getSimilarity()

Get the similarity property: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.

Returns:

the similarity value.

getSuggesters

public List<SearchSuggester> getSuggesters()

Get the suggesters property: The suggesters for the index.

Returns:

the suggesters value.

getTokenFilters

public List<TokenFilter> getTokenFilters()

Get the tokenFilters property: The token filters for the index.

Returns:

the tokenFilters value.

getTokenizers

public List<LexicalTokenizer> getTokenizers()

Get the tokenizers property: The tokenizers for the index.

Returns:

the tokenizers value.

getVectorSearch

public VectorSearch getVectorSearch()

Get the vectorSearch property: Contains configuration options related to vector search.

Returns:

the vectorSearch value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to