< Summary

Class:	Azure.Search.Documents.SearchOptions
Assembly:	Azure.Search.Documents
File(s):	C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Generated\Models\SearchOptions.cs C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Generated\Models\SearchOptions.Serialization.cs C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Options\SearchOptions.cs
Covered lines:	169
Uncovered lines:	37
Coverable lines:	206
Total lines:	520
Line coverage:	82% (169 of 206)
Covered branches:	58
Total branches:	78
Branch coverage:	74.3% (58 of 78)

Metrics

Method	Cyclomatic complexity	Line coverage	Branch coverage
.ctor()	-	100%	100%
.ctor(...)	-	100%	100%
get_HighlightPostTag()	-	100%	100%
get_HighlightPreTag()	-	100%	100%
get_MinimumCoverage()	-	100%	100%
get_QueryType()	-	100%	100%
get_ScoringProfile()	-	100%	100%
get_SearchMode()	-	100%	100%
get_Skip()	-	100%	100%
Azure.Core.IUtf8JsonSerializable.Write(...)	-	88.33%	89.47%
DeserializeSearchOptions(...)	-	60%	60%
.ctor(...)	-	100%	100%
get_SearchText()	-	100%	100%
get_Filter()	-	100%	100%
get_HighlightFields()	-	100%	100%
get_HighlightFieldsRaw()	-	100%	100%
set_HighlightFieldsRaw(...)	-	100%	100%
get_SearchFields()	-	100%	100%
get_SearchFieldsRaw()	-	100%	100%
set_SearchFieldsRaw(...)	-	100%	100%
get_Select()	-	100%	100%
get_SelectRaw()	-	100%	100%
set_SelectRaw(...)	-	100%	100%
get_Size()	-	100%	100%
get_OrderBy()	-	100%	100%
get_OrderByRaw()	-	100%	100%
set_OrderByRaw(...)	-	100%	100%
get_IncludeTotalCount()	-	100%	100%
get_Facets()	-	100%	100%
get_ScoringParameters()	-	100%	100%
Copy(...)	-	100%	100%
Clone()	-	100%	100%

File(s)

C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Generated\Models\SearchOptions.cs

#	Line	Line coverage
	`1`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
	`2`	`// Licensed under the MIT License.`
	`3`
	`4`	`// <auto-generated/>`
	`5`
	`6`	`#nullable disable`
	`7`
	`8`	`using System.Collections.Generic;`
	`9`	`using Azure.Core;`
	`10`	`using Azure.Search.Documents.Models;`
	`11`
	`12`	`namespace Azure.Search.Documents`
	`13`	`{`
	`14`	`/// <summary> Parameters for filtering, sorting, faceting, paging, and other search query behaviors. </summary>`
	`15`	`public partial class SearchOptions`
	`16`	`{`
	`17`	`/// <summary> Initializes a new instance of SearchOptions. </summary>`
117	`18`	`public SearchOptions()`
	`19`	`{`
117	`20`	`Facets = new ChangeTrackingList<string>();`
117	`21`	`ScoringParameters = new ChangeTrackingList<string>();`
117	`22`	`}`
	`23`
	`24`	`/// <summary> Initializes a new instance of SearchOptions. </summary>`
	`25`	`/// <param name="includeTotalCount"> A value that specifies whether to fetch the total count of results. Default`
	`26`	`/// <param name="facets"> The list of facet expressions to apply to the search query. Each facet expression cont`
	`27`	`/// <param name="filter"> The OData $filter expression to apply to the search query. </param>`
	`28`	`/// <param name="highlightFieldsRaw"> The comma-separated list of field names to use for hit highlights. Only se`
	`29`	`/// <param name="highlightPostTag"> A string tag that is appended to hit highlights. Must be set with highlightP`
	`30`	`/// <param name="highlightPreTag"> A string tag that is prepended to hit highlights. Must be set with highlightP`
	`31`	`/// <param name="minimumCoverage"> A number between 0 and 100 indicating the percentage of the index that must b`
	`32`	`/// <param name="orderByRaw"> The comma-separated list of OData $orderby expressions by which to sort the result`
	`33`	`/// <param name="queryType"> A value that specifies the syntax of the search query. The default is 'simple&`
	`34`	`/// <param name="scoringParameters"> The list of parameter values to be used in scoring functions (for example,`
	`35`	`/// <param name="scoringProfile"> The name of a scoring profile to evaluate match scores for matching documents`
	`36`	`/// <param name="searchText"> A full-text search query expression; Use "*" or omit this parameter to m`
	`37`	`/// <param name="searchFieldsRaw"> The comma-separated list of field names to which to scope the full-text searc`
	`38`	`/// <param name="searchMode"> A value that specifies whether any or all of the search terms must be matched in o`
	`39`	`/// <param name="selectRaw"> The comma-separated list of fields to retrieve. If unspecified, all fields marked a`
	`40`	`/// <param name="skip"> The number of search results to skip. This value cannot be greater than 100,000. If you`
	`41`	`/// <param name="size"> The number of search results to retrieve. This can be used in conjunction with $skip to`
42	`42`	`internal SearchOptions(bool? includeTotalCount, IList<string> facets, string filter, string highlightFieldsRaw,`
	`43`	`{`
42	`44`	`IncludeTotalCount = includeTotalCount;`
42	`45`	`Facets = facets;`
42	`46`	`Filter = filter;`
42	`47`	`HighlightFieldsRaw = highlightFieldsRaw;`
42	`48`	`HighlightPostTag = highlightPostTag;`
42	`49`	`HighlightPreTag = highlightPreTag;`
42	`50`	`MinimumCoverage = minimumCoverage;`
42	`51`	`OrderByRaw = orderByRaw;`
42	`52`	`QueryType = queryType;`
42	`53`	`ScoringParameters = scoringParameters;`
42	`54`	`ScoringProfile = scoringProfile;`
42	`55`	`SearchText = searchText;`
42	`56`	`SearchFieldsRaw = searchFieldsRaw;`
42	`57`	`SearchMode = searchMode;`
42	`58`	`SelectRaw = selectRaw;`
42	`59`	`Skip = skip;`
42	`60`	`Size = size;`
42	`61`	`}`
	`62`	`/// <summary> A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is &amp`
309	`63`	`public string HighlightPostTag { get; set; }`
	`64`	`/// <summary> A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is &a`
309	`65`	`public string HighlightPreTag { get; set; }`
	`66`	`/// <summary> A number between 0 and 100 indicating the percentage of the index that must be covered by a search`
309	`67`	`public double? MinimumCoverage { get; set; }`
	`68`	`/// <summary> A value that specifies the syntax of the search query. The default is 'simple'. Use &apo`
325	`69`	`public SearchQueryType? QueryType { get; set; }`
	`70`	`/// <summary> The name of a scoring profile to evaluate match scores for matching documents in order to sort the`
305	`71`	`public string ScoringProfile { get; set; }`
	`72`	`/// <summary> A value that specifies whether any or all of the search terms must be matched in order to count th`
309	`73`	`public SearchMode? SearchMode { get; set; }`
	`74`	`/// <summary> The number of search results to skip. This value cannot be greater than 100,000. If you need to sc`
369	`75`	`public int? Skip { get; set; }`
	`76`	`}`
	`77`	`}`

C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Generated\Models\SearchOptions.Serialization.cs

#	Line	Line coverage
	`1`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
	`2`	`// Licensed under the MIT License.`
	`3`
	`4`	`// <auto-generated/>`
	`5`
	`6`	`#nullable disable`
	`7`
	`8`	`using System.Collections.Generic;`
	`9`	`using System.Text.Json;`
	`10`	`using Azure.Core;`
	`11`	`using Azure.Search.Documents.Models;`
	`12`
	`13`	`namespace Azure.Search.Documents`
	`14`	`{`
	`15`	`public partial class SearchOptions : IUtf8JsonSerializable`
	`16`	`{`
	`17`	`void IUtf8JsonSerializable.Write(Utf8JsonWriter writer)`
	`18`	`{`
115	`19`	`writer.WriteStartObject();`
115	`20`	`if (Optional.IsDefined(IncludeTotalCount))`
	`21`	`{`
2	`22`	`writer.WritePropertyName("count");`
2	`23`	`writer.WriteBooleanValue(IncludeTotalCount.Value);`
	`24`	`}`
115	`25`	`if (Optional.IsCollectionDefined(Facets))`
	`26`	`{`
4	`27`	`writer.WritePropertyName("facets");`
4	`28`	`writer.WriteStartArray();`
40	`29`	`foreach (var item in Facets)`
	`30`	`{`
16	`31`	`writer.WriteStringValue(item);`
	`32`	`}`
4	`33`	`writer.WriteEndArray();`
	`34`	`}`
115	`35`	`if (Optional.IsDefined(Filter))`
	`36`	`{`
9	`37`	`writer.WritePropertyName("filter");`
9	`38`	`writer.WriteStringValue(Filter);`
	`39`	`}`
115	`40`	`if (Optional.IsDefined(HighlightFieldsRaw))`
	`41`	`{`
2	`42`	`writer.WritePropertyName("highlight");`
2	`43`	`writer.WriteStringValue(HighlightFieldsRaw);`
	`44`	`}`
115	`45`	`if (Optional.IsDefined(HighlightPostTag))`
	`46`	`{`
2	`47`	`writer.WritePropertyName("highlightPostTag");`
2	`48`	`writer.WriteStringValue(HighlightPostTag);`
	`49`	`}`
115	`50`	`if (Optional.IsDefined(HighlightPreTag))`
	`51`	`{`
2	`52`	`writer.WritePropertyName("highlightPreTag");`
2	`53`	`writer.WriteStringValue(HighlightPreTag);`
	`54`	`}`
115	`55`	`if (Optional.IsDefined(MinimumCoverage))`
	`56`	`{`
2	`57`	`writer.WritePropertyName("minimumCoverage");`
2	`58`	`writer.WriteNumberValue(MinimumCoverage.Value);`
	`59`	`}`
115	`60`	`if (Optional.IsDefined(OrderByRaw))`
	`61`	`{`
75	`62`	`writer.WritePropertyName("orderby");`
75	`63`	`writer.WriteStringValue(OrderByRaw);`
	`64`	`}`
115	`65`	`if (Optional.IsDefined(QueryType))`
	`66`	`{`
10	`67`	`writer.WritePropertyName("queryType");`
10	`68`	`writer.WriteStringValue(QueryType.Value.ToSerialString());`
	`69`	`}`
115	`70`	`if (Optional.IsCollectionDefined(ScoringParameters))`
	`71`	`{`
0	`72`	`writer.WritePropertyName("scoringParameters");`
0	`73`	`writer.WriteStartArray();`
0	`74`	`foreach (var item in ScoringParameters)`
	`75`	`{`
0	`76`	`writer.WriteStringValue(item);`
	`77`	`}`
0	`78`	`writer.WriteEndArray();`
	`79`	`}`
115	`80`	`if (Optional.IsDefined(ScoringProfile))`
	`81`	`{`
0	`82`	`writer.WritePropertyName("scoringProfile");`
0	`83`	`writer.WriteStringValue(ScoringProfile);`
	`84`	`}`
115	`85`	`if (Optional.IsDefined(SearchText))`
	`86`	`{`
113	`87`	`writer.WritePropertyName("search");`
113	`88`	`writer.WriteStringValue(SearchText);`
	`89`	`}`
115	`90`	`if (Optional.IsDefined(SearchFieldsRaw))`
	`91`	`{`
2	`92`	`writer.WritePropertyName("searchFields");`
2	`93`	`writer.WriteStringValue(SearchFieldsRaw);`
	`94`	`}`
115	`95`	`if (Optional.IsDefined(SearchMode))`
	`96`	`{`
2	`97`	`writer.WritePropertyName("searchMode");`
2	`98`	`writer.WriteStringValue(SearchMode.Value.ToSerialString());`
	`99`	`}`
115	`100`	`if (Optional.IsDefined(SelectRaw))`
	`101`	`{`
74	`102`	`writer.WritePropertyName("select");`
74	`103`	`writer.WriteStringValue(SelectRaw);`
	`104`	`}`
115	`105`	`if (Optional.IsDefined(Skip))`
	`106`	`{`
60	`107`	`writer.WritePropertyName("skip");`
60	`108`	`writer.WriteNumberValue(Skip.Value);`
	`109`	`}`
115	`110`	`if (Optional.IsDefined(Size))`
	`111`	`{`
46	`112`	`writer.WritePropertyName("top");`
46	`113`	`writer.WriteNumberValue(Size.Value);`
	`114`	`}`
115	`115`	`writer.WriteEndObject();`
115	`116`	`}`
	`117`
	`118`	`internal static SearchOptions DeserializeSearchOptions(JsonElement element)`
	`119`	`{`
42	`120`	`Optional<bool> count = default;`
42	`121`	`Optional<IList<string>> facets = default;`
42	`122`	`Optional<string> filter = default;`
42	`123`	`Optional<string> highlight = default;`
42	`124`	`Optional<string> highlightPostTag = default;`
42	`125`	`Optional<string> highlightPreTag = default;`
42	`126`	`Optional<double> minimumCoverage = default;`
42	`127`	`Optional<string> orderby = default;`
42	`128`	`Optional<SearchQueryType> queryType = default;`
42	`129`	`Optional<IList<string>> scoringParameters = default;`
42	`130`	`Optional<string> scoringProfile = default;`
42	`131`	`Optional<string> search = default;`
42	`132`	`Optional<string> searchFields = default;`
42	`133`	`Optional<SearchMode> searchMode = default;`
42	`134`	`Optional<string> select = default;`
42	`135`	`Optional<int> skip = default;`
42	`136`	`Optional<int> top = default;`
468	`137`	`foreach (var property in element.EnumerateObject())`
	`138`	`{`
192	`139`	`if (property.NameEquals("count"))`
	`140`	`{`
0	`141`	`count = property.Value.GetBoolean();`
0	`142`	`continue;`
	`143`	`}`
192	`144`	`if (property.NameEquals("facets"))`
	`145`	`{`
0	`146`	`List<string> array = new List<string>();`
0	`147`	`foreach (var item in property.Value.EnumerateArray())`
	`148`	`{`
0	`149`	`array.Add(item.GetString());`
	`150`	`}`
0	`151`	`facets = array;`
0	`152`	`continue;`
	`153`	`}`
192	`154`	`if (property.NameEquals("filter"))`
	`155`	`{`
0	`156`	`filter = property.Value.GetString();`
0	`157`	`continue;`
	`158`	`}`
192	`159`	`if (property.NameEquals("highlight"))`
	`160`	`{`
0	`161`	`highlight = property.Value.GetString();`
0	`162`	`continue;`
	`163`	`}`
192	`164`	`if (property.NameEquals("highlightPostTag"))`
	`165`	`{`
0	`166`	`highlightPostTag = property.Value.GetString();`
0	`167`	`continue;`
	`168`	`}`
192	`169`	`if (property.NameEquals("highlightPreTag"))`
	`170`	`{`
0	`171`	`highlightPreTag = property.Value.GetString();`
0	`172`	`continue;`
	`173`	`}`
192	`174`	`if (property.NameEquals("minimumCoverage"))`
	`175`	`{`
0	`176`	`minimumCoverage = property.Value.GetDouble();`
0	`177`	`continue;`
	`178`	`}`
192	`179`	`if (property.NameEquals("orderby"))`
	`180`	`{`
42	`181`	`orderby = property.Value.GetString();`
42	`182`	`continue;`
	`183`	`}`
150	`184`	`if (property.NameEquals("queryType"))`
	`185`	`{`
0	`186`	`queryType = property.Value.GetString().ToSearchQueryType();`
0	`187`	`continue;`
	`188`	`}`
150	`189`	`if (property.NameEquals("scoringParameters"))`
	`190`	`{`
0	`191`	`List<string> array = new List<string>();`
0	`192`	`foreach (var item in property.Value.EnumerateArray())`
	`193`	`{`
0	`194`	`array.Add(item.GetString());`
	`195`	`}`
0	`196`	`scoringParameters = array;`
0	`197`	`continue;`
	`198`	`}`
150	`199`	`if (property.NameEquals("scoringProfile"))`
	`200`	`{`
0	`201`	`scoringProfile = property.Value.GetString();`
0	`202`	`continue;`
	`203`	`}`
150	`204`	`if (property.NameEquals("search"))`
	`205`	`{`
42	`206`	`search = property.Value.GetString();`
42	`207`	`continue;`
	`208`	`}`
108	`209`	`if (property.NameEquals("searchFields"))`
	`210`	`{`
0	`211`	`searchFields = property.Value.GetString();`
0	`212`	`continue;`
	`213`	`}`
108	`214`	`if (property.NameEquals("searchMode"))`
	`215`	`{`
0	`216`	`searchMode = property.Value.GetString().ToSearchMode();`
0	`217`	`continue;`
	`218`	`}`
108	`219`	`if (property.NameEquals("select"))`
	`220`	`{`
42	`221`	`select = property.Value.GetString();`
42	`222`	`continue;`
	`223`	`}`
66	`224`	`if (property.NameEquals("skip"))`
	`225`	`{`
42	`226`	`skip = property.Value.GetInt32();`
42	`227`	`continue;`
	`228`	`}`
24	`229`	`if (property.NameEquals("top"))`
	`230`	`{`
24	`231`	`top = property.Value.GetInt32();`
	`232`	`continue;`
	`233`	`}`
	`234`	`}`
42	`235`	`return new SearchOptions(Optional.ToNullable(count), Optional.ToList(facets), filter.Value, highlight.Value,`
	`236`	`}`
	`237`	`}`
	`238`	`}`

C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Options\SearchOptions.cs

#	Line	Line coverage
	`1`	`// Copyright (c) Microsoft Corporation. All rights reserved.`
	`2`	`// Licensed under the MIT License.`
	`3`
	`4`	`using System;`
	`5`	`using System.Collections.Generic;`
	`6`	`using System.Diagnostics;`
	`7`	`using Azure.Core;`
	`8`	`using Azure.Search.Documents.Models;`
	`9`
	`10`	`namespace Azure.Search.Documents`
	`11`	`{`
	`12`	`/// <summary>`
	`13`	`/// Options for <see cref="SearchClient.SearchAsync"/> that`
	`14`	`/// allow specifying filtering, sorting, faceting, paging, and other search`
	`15`	`/// query behaviors.`
	`16`	`/// </summary>`
	`17`	`[CodeGenModel("SearchRequest")]`
	`18`	`public partial class SearchOptions`
	`19`	`{`
	`20`	`/// <summary>`
	`21`	`/// Initializes a new instance of SearchOptions from a continuation`
	`22`	`/// token to continue fetching results from a previous search.`
	`23`	`/// </summary>`
	`24`	`/// <param name="continuationToken">`
	`25`	`/// Encapsulates the state required to fetch the next page of search`
	`26`	`/// results from the index.`
	`27`	`/// </param>`
14	`28`	`internal SearchOptions(string continuationToken) =>`
14	`29`	`Copy(SearchContinuationToken.Deserialize(continuationToken), this);`
	`30`
	`31`	`/// <summary>`
	`32`	`/// A full-text search query expression; Use "*" or omit this`
	`33`	`/// parameter to match all documents.`
	`34`	`/// </summary>`
	`35`	`[CodeGenMember("search")]`
503	`36`	`internal string SearchText { get; set; }`
	`37`
	`38`	`/// <summary>`
	`39`	`/// The OData $filter expression to apply to the search query. You can`
	`40`	`/// use <see cref="SearchFilter.Create(FormattableString)"/> to help`
	`41`	`/// construct the filter expression.`
	`42`	`/// </summary>`
	`43`	`[CodeGenMember("filter")]`
323	`44`	`public string Filter { get; set; }`
	`45`
	`46`	`/// <summary>`
	`47`	`/// The list of field names to use for hit highlights. Only searchable`
	`48`	`/// fields can be used for hit highlighting.`
	`49`	`/// </summary>`
482	`50`	`public IList<string> HighlightFields { get; internal set; } = new List<string>();`
	`51`
	`52`	`#pragma warning disable CA1822 // Only (unused but required) setters are static`
	`53`	`/// <summary>`
	`54`	`/// Join HighlightFields so it can be sent as a comma separated string.`
	`55`	`/// </summary>`
	`56`	`[CodeGenMember("HighlightFields")]`
	`57`	`internal string HighlightFieldsRaw`
	`58`	`{`
117	`59`	`get => HighlightFields.CommaJoin();`
42	`60`	`set => HighlightFields = SearchExtensions.CommaSplit(value);`
	`61`	`}`
	`62`	`#pragma warning restore CA1822`
	`63`
	`64`	`/// <summary>`
	`65`	`/// The list of field names to which to scope the full-text search.`
	`66`	`/// When using fielded search (fieldName:searchExpression) in a full`
	`67`	`/// Lucene query, the field names of each fielded search expression`
	`68`	`/// take precedence over any field names listed in this parameter.`
	`69`	`/// </summary>`
482	`70`	`public IList<string> SearchFields { get; internal set; } = new List<string>();`
	`71`
	`72`	`#pragma warning disable CA1822 // Only (unused but required) setters are static`
	`73`	`/// <summary>`
	`74`	`/// Join SearchFields so it can be sent as a comma separated string.`
	`75`	`/// </summary>`
	`76`	`[CodeGenMember("searchFields")]`
	`77`	`internal string SearchFieldsRaw`
	`78`	`{`
117	`79`	`get => SearchFields.CommaJoin();`
42	`80`	`set => SearchFields = SearchExtensions.CommaSplit(value);`
	`81`	`}`
	`82`	`#pragma warning restore CA1822`
	`83`
	`84`	`/// <summary>`
	`85`	`/// The list of fields to retrieve. If unspecified, all fields marked`
	`86`	`/// as retrievable in the schema are included.`
	`87`	`/// </summary>`
570	`88`	`public IList<string> Select { get; internal set; } = new List<string>();`
	`89`
	`90`	`#pragma warning disable CA1822 // Only (unused but required) setters are static`
	`91`	`/// <summary>`
	`92`	`/// Join Select so it can be sent as a comma separated string.`
	`93`	`/// </summary>`
	`94`	`[CodeGenMember("select")]`
	`95`	`internal string SelectRaw`
	`96`	`{`
189	`97`	`get => Select.CommaJoin();`
42	`98`	`set => Select = SearchExtensions.CommaSplit(value);`
	`99`	`}`
	`100`	`#pragma warning restore CA1822`
	`101`
	`102`	`/// <summary>`
	`103`	`/// The number of search results to retrieve. This can be used in`
	`104`	`/// conjunction with <see cref="Skip"/> to implement client-side`
	`105`	`/// paging of search results. If results are truncated due to`
	`106`	`/// server-side paging, the response will include a continuation token`
	`107`	`/// that can be used to issue another Search request for the next page`
	`108`	`/// of results.`
	`109`	`/// </summary>`
	`110`	`[CodeGenMember("top")]`
363	`111`	`public int? Size { get; set; }`
	`112`
	`113`	`/// <summary>`
	`114`	`/// The list of OData $orderby expressions by which to sort the`
	`115`	`/// results. Each expression can be either a field name or a call to`
	`116`	`/// either the geo.distance() or the search.score() functions. Each`
	`117`	`/// expression can be followed by asc to indicate ascending, or desc to`
	`118`	`/// indicate descending. The default is ascending order. Ties will be`
	`119`	`/// broken by the match scores of documents. If no $orderby is`
	`120`	`/// specified, the default sort order is descending by document match`
	`121`	`/// score. There can be at most 32 $orderby clauses.`
	`122`	`/// </summary>`
570	`123`	`public IList<string> OrderBy { get; internal set; } = new List<string>();`
	`124`
	`125`	`#pragma warning disable CA1822 // Only (unused but required) setters are static`
	`126`	`/// <summary>`
	`127`	`/// Join OrderBy so it can be sent as a comma separated string.`
	`128`	`/// </summary>`
	`129`	`[CodeGenMember("orderby")]`
	`130`	`internal string OrderByRaw`
	`131`	`{`
190	`132`	`get => OrderBy.CommaJoin();`
42	`133`	`set => OrderBy = SearchExtensions.CommaSplit(value);`
	`134`	`}`
	`135`	`#pragma warning restore CA1822`
	`136`
	`137`	`/// <summary>`
	`138`	`/// A value that specifies whether to fetch the total count of results`
	`139`	`/// as the <see cref="Models.SearchResults{T}.TotalCount"/> property.`
	`140`	`/// The default value is false. Setting this value to true may have a`
	`141`	`/// performance impact. Note that the count returned is an`
	`142`	`/// approximation.`
	`143`	`/// </summary>`
	`144`	`[CodeGenMember("IncludeTotalResultCount")]`
309	`145`	`public bool? IncludeTotalCount { get; set; }`
	`146`
	`147`	`/// <summary>`
	`148`	`/// The list of facet expressions to apply to the search query. Each`
	`149`	`/// facet expression contains a field name, optionally followed by a`
	`150`	`/// comma-separated list of name:value pairs.`
	`151`	`/// </summary>`
	`152`	`[CodeGenMember("facets")]`
603	`153`	`public IList<string> Facets { get; internal set; } = new List<string>();`
	`154`
	`155`	`/// <summary>`
	`156`	`/// The list of parameter values to be used in scoring functions (for`
	`157`	`/// example, referencePointParameter) using the format name-values. For`
	`158`	`/// example, if the scoring profile defines a function with a parameter`
	`159`	`/// called 'mylocation' the parameter string would be`
	`160`	`/// "mylocation--122.2,44.8" (without the quotes).`
	`161`	`/// </summary>`
	`162`	`[CodeGenMember("scoringParameters")]`
595	`163`	`public IList<string> ScoringParameters { get; internal set; } = new List<string>();`
	`164`
	`165`	`/// <summary>`
	`166`	`/// Shallow copy one SearchOptions instance to another.`
	`167`	`/// </summary>`
	`168`	`/// <param name="source">The source options.</param>`
	`169`	`/// <param name="destination">The destination options.</param>`
	`170`	`private static void Copy(SearchOptions source, SearchOptions destination)`
	`171`	`{`
	`172`	`Debug.Assert(source != null);`
	`173`	`Debug.Assert(destination != null);`
	`174`
74	`175`	`destination.SearchText = source.SearchText;`
74	`176`	`destination.Filter = source.Filter;`
74	`177`	`destination.HighlightFields = source.HighlightFields;`
74	`178`	`destination.SearchFields = source.SearchFields;`
74	`179`	`destination.Select = source.Select;`
74	`180`	`destination.Size = source.Size;`
74	`181`	`destination.OrderBy = source.OrderBy;`
74	`182`	`destination.IncludeTotalCount = source.IncludeTotalCount;`
74	`183`	`destination.Facets = source.Facets;`
74	`184`	`destination.ScoringParameters = source.ScoringParameters;`
74	`185`	`destination.HighlightPostTag = source.HighlightPostTag;`
74	`186`	`destination.HighlightPreTag = source.HighlightPreTag;`
74	`187`	`destination.MinimumCoverage = source.MinimumCoverage;`
74	`188`	`destination.QueryType = source.QueryType;`
74	`189`	`destination.ScoringProfile = source.ScoringProfile;`
74	`190`	`destination.SearchMode = source.SearchMode;`
74	`191`	`destination.Skip = source.Skip;`
74	`192`	`}`
	`193`
	`194`	`/// <summary>`
	`195`	`/// Creates a shallow copy of the SearchOptions.`
	`196`	`/// </summary>`
	`197`	`/// <returns>The cloned SearchOptions.</returns>`
	`198`	`internal SearchOptions Clone()`
	`199`	`{`
60	`200`	`SearchOptions clone = new SearchOptions();`
60	`201`	`Copy(this, clone);`
60	`202`	`return clone;`
	`203`	`}`
	`204`	`}`
	`205`	`}`

< Summary

Metrics

File(s)

C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Generated\Models\SearchOptions.cs

C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Generated\Models\SearchOptions.Serialization.cs

C:\Git\azure-sdk-for-net\sdk\search\Azure.Search.Documents\src\Options\SearchOptions.cs

Methods/Properties