< Summary

Class:Microsoft.Azure.CognitiveServices.Search.LocalSearch.Models.EntitiesEntityPresentationInfo
Assembly:Microsoft.Azure.CognitiveServices.Search.BingLocalSearch
File(s):C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingLocalSearch\src\Generated\LocalSearch\Models\EntitiesEntityPresentationInfo.cs
Covered lines:0
Uncovered lines:17
Coverable lines:17
Total lines:107
Line coverage:0% (0 of 17)
Covered branches:0
Total branches:2
Branch coverage:0% (0 of 2)

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-0%100%
.ctor(...)-0%100%
get_EntityScenario()-0%100%
get_EntityTypeHints()-0%100%
get_EntityTypeDisplayHint()-0%100%
get_Query()-0%100%
get_EntitySubTypeHints()-0%100%
Validate()-0%0%

File(s)

C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingLocalSearch\src\Generated\LocalSearch\Models\EntitiesEntityPresentationInfo.cs

#LineLine coverage
 1// <auto-generated>
 2// Code generated by Microsoft (R) AutoRest Code Generator.
 3// Changes may cause incorrect behavior and will be lost if the code is
 4// regenerated.
 5// </auto-generated>
 6
 7namespace Microsoft.Azure.CognitiveServices.Search.LocalSearch.Models
 8{
 9    using Microsoft.Rest;
 10    using Newtonsoft.Json;
 11    using System.Collections;
 12    using System.Collections.Generic;
 13    using System.Linq;
 14
 15    /// <summary>
 16    /// Defines additional information about an entity such as type hints.
 17    /// </summary>
 18    [Newtonsoft.Json.JsonObject("Entities/EntityPresentationInfo")]
 19    public partial class EntitiesEntityPresentationInfo
 20    {
 21        /// <summary>
 22        /// Initializes a new instance of the EntitiesEntityPresentationInfo
 23        /// class.
 24        /// </summary>
 025        public EntitiesEntityPresentationInfo()
 26        {
 27            CustomInit();
 028        }
 29
 30        /// <summary>
 31        /// Initializes a new instance of the EntitiesEntityPresentationInfo
 32        /// class.
 33        /// </summary>
 34        /// <param name="entityScenario">The supported scenario. Possible
 35        /// values include: 'DominantEntity', 'DisambiguationItem',
 36        /// 'ListItem'</param>
 37        /// <param name="entityTypeHints">A list of hints that indicate the
 38        /// entity's type. The list could contain a single hint such as Movie
 39        /// or a list of hints such as Place, LocalBusiness, Restaurant. Each
 40        /// successive hint in the array narrows the entity's type.</param>
 41        /// <param name="entityTypeDisplayHint">A display version of the entity
 42        /// hint. For example, if entityTypeHints is Artist, this field may be
 43        /// set to American Singer.</param>
 044        public EntitiesEntityPresentationInfo(string entityScenario, IList<string> entityTypeHints = default(IList<strin
 45        {
 046            EntityScenario = entityScenario;
 047            EntityTypeHints = entityTypeHints;
 048            EntityTypeDisplayHint = entityTypeDisplayHint;
 049            Query = query;
 050            EntitySubTypeHints = entitySubTypeHints;
 51            CustomInit();
 052        }
 53
 54        /// <summary>
 55        /// An initialization method that performs custom operations like setting defaults
 56        /// </summary>
 57        partial void CustomInit();
 58
 59        /// <summary>
 60        /// Gets or sets the supported scenario. Possible values include:
 61        /// 'DominantEntity', 'DisambiguationItem', 'ListItem'
 62        /// </summary>
 63        [JsonProperty(PropertyName = "entityScenario")]
 064        public string EntityScenario { get; set; }
 65
 66        /// <summary>
 67        /// Gets a list of hints that indicate the entity's type. The list
 68        /// could contain a single hint such as Movie or a list of hints such
 69        /// as Place, LocalBusiness, Restaurant. Each successive hint in the
 70        /// array narrows the entity's type.
 71        /// </summary>
 72        [JsonProperty(PropertyName = "entityTypeHints")]
 073        public IList<string> EntityTypeHints { get; private set; }
 74
 75        /// <summary>
 76        /// Gets a display version of the entity hint. For example, if
 77        /// entityTypeHints is Artist, this field may be set to American
 78        /// Singer.
 79        /// </summary>
 80        [JsonProperty(PropertyName = "entityTypeDisplayHint")]
 081        public string EntityTypeDisplayHint { get; private set; }
 82
 83        /// <summary>
 84        /// </summary>
 85        [JsonProperty(PropertyName = "query")]
 086        public string Query { get; private set; }
 87
 88        /// <summary>
 89        /// </summary>
 90        [JsonProperty(PropertyName = "entitySubTypeHints")]
 091        public IList<string> EntitySubTypeHints { get; private set; }
 92
 93        /// <summary>
 94        /// Validate the object.
 95        /// </summary>
 96        /// <exception cref="ValidationException">
 97        /// Thrown if validation fails
 98        /// </exception>
 99        public virtual void Validate()
 100        {
 0101            if (EntityScenario == null)
 102            {
 0103                throw new ValidationException(ValidationRules.CannotBeNull, "EntityScenario");
 104            }
 0105        }
 106    }
 107}