< Summary

Class:Microsoft.Azure.Search.Models.DocumentSearchResult`1
Assembly:Microsoft.Azure.Search.Data
File(s):C:\Git\azure-sdk-for-net\sdk\search\Microsoft.Azure.Search.Data\src\Customizations\Documents\Models\DocumentSearchResult.Customization.cs
C:\Git\azure-sdk-for-net\sdk\search\Microsoft.Azure.Search.Data\src\Generated\Models\DocumentSearchResult.cs
Covered lines:22
Uncovered lines:12
Coverable lines:34
Total lines:200
Line coverage:64.7% (22 of 34)
Covered branches:2
Total branches:2
Branch coverage:100% (2 of 2)

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor(...)-100%100%
get_ContinuationToken()-100%100%
CustomInit()-100%100%
OnDeserialized(...)-100%100%
.ctor()-0%100%
.ctor(...)-0%100%
get_Count()-100%100%
get_Coverage()-100%100%
get_Facets()-100%100%
get_NextPageParameters()-100%100%
get_Results()-100%100%
get_NextLink()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\search\Microsoft.Azure.Search.Data\src\Customizations\Documents\Models\DocumentSearchResult.Customization.cs

#LineLine coverage
 1// Copyright (c) Microsoft Corporation. All rights reserved.
 2// Licensed under the MIT License. See License.txt in the project root for
 3// license information.
 4
 5using System.Collections.Generic;
 6using System.Runtime.Serialization;
 7
 8namespace Microsoft.Azure.Search.Models
 9{
 10    public partial class DocumentSearchResult<T>
 11    {
 12        /// <summary>
 13        /// Initializes a new instance of the DocumentSearchResult class. This constructor is intended to be used for te
 14        /// the properties of this class are immutable.
 15        /// </summary>
 16        /// <param name="results">The sequence of results returned by the query.</param>
 17        /// <param name="count">The total count of results found by the search operation, or null if the count was not r
 18        /// <param name="coverage">A value indicating the percentage of the index that was included in the query, or nul
 19        /// MinimumCoverage was not set in the <c cref="SearchParameters">SearchParameters</c>.</param>
 20        /// <param name="facets">The facet query results for the search operation, or null if the query did not include 
 21        /// expressions.</param>
 22        /// <param name="continuationToken">A continuation token that is used to continue fetching search results. This 
 23        /// Azure Cognitive Search cannot fulfill a search request with a single response.</param>
 15824        public DocumentSearchResult(
 15825            IList<SearchResult<T>> results,
 15826            long? count,
 15827            double? coverage,
 15828            IDictionary<string, IList<FacetResult>> facets,
 15829            SearchContinuationToken continuationToken)
 30        {
 15831            Count = count;
 15832            Coverage = coverage;
 15833            Facets = facets;
 15834            Results = results;
 15835            ContinuationToken = continuationToken;
 15836        }
 37
 38        /// <summary>
 39        /// Gets a continuation token that is used to continue fetching search results. This is necessary when Azure
 40        /// Search cannot fulfill a search request with a single response.
 41        /// </summary>
 42        /// <remarks>
 43        /// <para>
 44        /// This property will be null unless Azure Cognitive Search can't return all the requested documents in a singl
 45        /// response. That can happen for different reasons which are implementation-specific and subject to change.
 46        /// Robust clients should always be ready to handle cases where fewer documents than expected are returned and
 47        /// a continuation token is included to continue retrieving documents. If this property is not null, you can
 48        /// pass its value to the
 49        /// <c cref="IDocumentsOperations.ContinueSearchWithHttpMessagesAsync(SearchContinuationToken, SearchRequestOpti
 50        /// method to retrieve more search results.
 51        /// </para>
 52        /// <para>
 53        /// Note that this property is not meant to help you implement paging of search results. You can implement
 54        /// paging using the <c cref="SearchParameters.Top">Top</c> and <c cref="SearchParameters.Skip">Skip</c>
 55        /// search parameters.
 56        /// </para>
 57        /// </remarks>
 39658        public SearchContinuationToken ContinuationToken { get; private set; }
 59
 60        partial void CustomInit()
 61        {
 62            // Ensure ContinuationToken is initialized.
 15863            ContinuationToken = NextLink != null ? new SearchContinuationToken(NextLink, NextPageParameters) : null;
 15864        }
 65
 66        // Without this, CustomInit() won't be called on deserialization because no constructors are called.
 67        [OnDeserialized]
 15868        private void OnDeserialized(StreamingContext context) => CustomInit();
 69    }
 70}

C:\Git\azure-sdk-for-net\sdk\search\Microsoft.Azure.Search.Data\src\Generated\Models\DocumentSearchResult.cs

#LineLine coverage
 1// <auto-generated>
 2// Copyright (c) Microsoft Corporation. All rights reserved.
 3// Licensed under the MIT License. See License.txt in the project root for
 4// license information.
 5//
 6// Code generated by Microsoft (R) AutoRest Code Generator.
 7// Changes may cause incorrect behavior and will be lost if the code is
 8// regenerated.
 9// </auto-generated>
 10
 11namespace Microsoft.Azure.Search.Models
 12{
 13    using Newtonsoft.Json;
 14    using System.Collections;
 15    using System.Collections.Generic;
 16    using System.Linq;
 17
 18    /// <summary>
 19    /// Response containing search results from an index.
 20    /// </summary>
 21    public partial class DocumentSearchResult<T>
 22    {
 23        /// <summary>
 24        /// Initializes a new instance of the DocumentSearchResult class.
 25        /// </summary>
 026        internal DocumentSearchResult()
 27        {
 028            CustomInit();
 029        }
 30
 31        /// <summary>
 32        /// Initializes a new instance of the DocumentSearchResult class.
 33        /// </summary>
 34        /// <param name="count">The total count of results found by the search
 35        /// operation, or null if the count was not requested. If present, the
 36        /// count may be greater than the number of results in this response.
 37        /// This can happen if you use the $top or $skip parameters, or if
 38        /// Azure Cognitive Search can't return all the requested documents in
 39        /// a single Search response.</param>
 40        /// <param name="coverage">A value indicating the percentage of the
 41        /// index that was included in the query, or null if minimumCoverage
 42        /// was not specified in the request.</param>
 43        /// <param name="facets">The facet query results for the search
 44        /// operation, organized as a collection of buckets for each faceted
 45        /// field; null if the query did not include any facet
 46        /// expressions.</param>
 47        /// <param name="nextPageParameters">Continuation JSON payload returned
 48        /// when Azure Cognitive Search can't return all the requested results
 49        /// in a single Search response. You can use this JSON along with
 50        /// @odata.nextLink to formulate another POST Search request to get the
 51        /// next part of the search response.</param>
 52        /// <param name="results">The sequence of results returned by the
 53        /// query.</param>
 54        /// <param name="nextLink">Continuation URL returned when Azure
 55        /// Cognitive Search can't return all the requested results in a single
 56        /// Search response. You can use this URL to formulate another GET or
 57        /// POST Search request to get the next part of the search response.
 58        /// Make sure to use the same verb (GET or POST) as the request that
 59        /// produced this response.</param>
 060        internal DocumentSearchResult(long? count = default(long?), double? coverage = default(double?), IDictionary<str
 61        {
 062            Count = count;
 063            Coverage = coverage;
 064            Facets = facets;
 065            NextPageParameters = nextPageParameters;
 066            Results = results;
 067            NextLink = nextLink;
 068            CustomInit();
 069        }
 70
 71        /// <summary>
 72        /// An initialization method that performs custom operations like setting defaults
 73        /// </summary>
 74        partial void CustomInit();
 75
 76        /// <summary>
 77        /// Gets the total count of results found by the search operation, or
 78        /// null if the count was not requested. If present, the count may be
 79        /// greater than the number of results in this response. This can
 80        /// happen if you use the $top or $skip parameters, or if Azure
 81        /// Cognitive Search can't return all the requested documents in a
 82        /// single Search response.
 83        /// </summary>
 84        [JsonProperty(PropertyName = "@odata.count")]
 17085        public long? Count { get; private set; }
 86
 87        /// <summary>
 88        /// Gets a value indicating the percentage of the index that was
 89        /// included in the query, or null if minimumCoverage was not specified
 90        /// in the request.
 91        /// </summary>
 92        [JsonProperty(PropertyName = "@search.coverage")]
 17093        public double? Coverage { get; private set; }
 94
 95        /// <summary>
 96        /// Gets the facet query results for the search operation, organized as
 97        /// a collection of buckets for each faceted field; null if the query
 98        /// did not include any facet expressions.
 99        /// </summary>
 100        [JsonProperty(PropertyName = "@search.facets")]
 206101        public IDictionary<string, IList<FacetResult>> Facets { get; private set; }
 102
 103        /// <summary>
 104        /// Gets continuation JSON payload returned when Azure Cognitive Search
 105        /// can't return all the requested results in a single Search response.
 106        /// You can use this JSON along with @odata.nextLink to formulate
 107        /// another POST Search request to get the next part of the search
 108        /// response.
 109        /// </summary>
 110        [JsonProperty(PropertyName = "@search.nextPageParameters")]
 54111        internal SearchRequest NextPageParameters { get; private set; }
 112
 113        /// <summary>
 114        /// Gets the sequence of results returned by the query.
 115        /// </summary>
 116        [JsonProperty(PropertyName = "value")]
 748117        public IList<SearchResult<T>> Results { get; private set; }
 118
 119        /// <summary>
 120        /// Gets continuation URL returned when Azure Cognitive Search can't
 121        /// return all the requested results in a single Search response. You
 122        /// can use this URL to formulate another GET or POST Search request to
 123        /// get the next part of the search response. Make sure to use the same
 124        /// verb (GET or POST) as the request that produced this response.
 125        /// </summary>
 126        [JsonProperty(PropertyName = "@odata.nextLink")]
 230127        internal string NextLink { get; private set; }
 128
 129    }
 130}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:17 PM
GitHub | www.palmmedia.de

Methods/Properties

.ctor(...)
get_ContinuationToken()
CustomInit()
OnDeserialized(...)
.ctor()
.ctor(...)
get_Count()
get_Coverage()
get_Facets()
get_NextPageParameters()
get_Results()
get_NextLink()