< Summary

Class:Microsoft.Azure.CognitiveServices.Personalizer.Models.ServiceConfiguration
Assembly:Microsoft.Azure.CognitiveServices.Personalizer
File(s):C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Personalizer\src\Generated\Models\ServiceConfiguration.cs
Covered lines:18
Uncovered lines:20
Coverable lines:38
Total lines:178
Line coverage:47.3% (18 of 38)
Covered branches:10
Total branches:18
Branch coverage:55.5% (10 of 18)

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
.ctor(...)-0%100%
get_RewardWaitTime()-100%100%
get_DefaultReward()-100%100%
get_RewardAggregation()-100%100%
get_ExplorationPercentage()-100%100%
get_ModelExportFrequency()-100%100%
get_LogMirrorEnabled()-0%100%
get_LogMirrorSasUri()-0%100%
get_LogRetentionDays()-100%100%
Validate()-55.56%55.56%

File(s)

C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Personalizer\src\Generated\Models\ServiceConfiguration.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.CognitiveServices.Personalizer.Models
 12{
 13    using Microsoft.Rest;
 14    using Newtonsoft.Json;
 15    using System.Linq;
 16
 17    /// <summary>
 18    /// The configuration of the service.
 19    /// </summary>
 20    public partial class ServiceConfiguration
 21    {
 22        /// <summary>
 23        /// Initializes a new instance of the ServiceConfiguration class.
 24        /// </summary>
 625        public ServiceConfiguration()
 26        {
 27            CustomInit();
 628        }
 29
 30        /// <summary>
 31        /// Initializes a new instance of the ServiceConfiguration class.
 32        /// </summary>
 33        /// <param name="rewardWaitTime">The time span waited until a request
 34        /// is marked with the default reward.
 35        /// For example, PT5M (5 mins). For information about the time format,
 36        /// see http://en.wikipedia.org/wiki/ISO_8601#Durations</param>
 37        /// <param name="defaultReward">The reward given if a reward is not
 38        /// received within the specified wait time.</param>
 39        /// <param name="rewardAggregation">The function used to process
 40        /// rewards, if multiple reward scores are received before
 41        /// rewardWaitTime is over.</param>
 42        /// <param name="explorationPercentage">The percentage of rank
 43        /// responses that will use exploration.</param>
 44        /// <param name="modelExportFrequency">Personalizer will start using
 45        /// the most updated trained model for online ranks automatically every
 46        /// specified time period.
 47        /// For example, PT5M (5 mins). For information about the time format,
 48        /// see http://en.wikipedia.org/wiki/ISO_8601#Durations</param>
 49        /// <param name="logRetentionDays">Number of days historical logs are
 50        /// to be maintained. -1 implies the logs will never be
 51        /// deleted.</param>
 52        /// <param name="logMirrorEnabled">Flag indicates whether log mirroring
 53        /// is enabled.</param>
 54        /// <param name="logMirrorSasUri">Azure storage account container SAS
 55        /// URI for log mirroring.</param>
 056        public ServiceConfiguration(System.TimeSpan rewardWaitTime, double defaultReward, string rewardAggregation, doub
 57        {
 058            RewardWaitTime = rewardWaitTime;
 059            DefaultReward = defaultReward;
 060            RewardAggregation = rewardAggregation;
 061            ExplorationPercentage = explorationPercentage;
 062            ModelExportFrequency = modelExportFrequency;
 063            LogMirrorEnabled = logMirrorEnabled;
 064            LogMirrorSasUri = logMirrorSasUri;
 065            LogRetentionDays = logRetentionDays;
 66            CustomInit();
 067        }
 68
 69        /// <summary>
 70        /// An initialization method that performs custom operations like setting defaults
 71        /// </summary>
 72        partial void CustomInit();
 73
 74        /// <summary>
 75        /// Gets or sets the time span waited until a request is marked with
 76        /// the default reward.
 77        /// For example, PT5M (5 mins). For information about the time format,
 78        /// see http://en.wikipedia.org/wiki/ISO_8601#Durations
 79        /// </summary>
 80        [JsonProperty(PropertyName = "rewardWaitTime")]
 1881        public System.TimeSpan RewardWaitTime { get; set; }
 82
 83        /// <summary>
 84        /// Gets or sets the reward given if a reward is not received within
 85        /// the specified wait time.
 86        /// </summary>
 87        [JsonProperty(PropertyName = "defaultReward")]
 1888        public double DefaultReward { get; set; }
 89
 90        /// <summary>
 91        /// Gets or sets the function used to process rewards, if multiple
 92        /// reward scores are received before rewardWaitTime is over.
 93        /// </summary>
 94        [JsonProperty(PropertyName = "rewardAggregation")]
 1895        public string RewardAggregation { get; set; }
 96
 97        /// <summary>
 98        /// Gets or sets the percentage of rank responses that will use
 99        /// exploration.
 100        /// </summary>
 101        [JsonProperty(PropertyName = "explorationPercentage")]
 18102        public double ExplorationPercentage { get; set; }
 103
 104        /// <summary>
 105        /// Gets or sets personalizer will start using the most updated trained
 106        /// model for online ranks automatically every specified time period.
 107        /// For example, PT5M (5 mins). For information about the time format,
 108        /// see http://en.wikipedia.org/wiki/ISO_8601#Durations
 109        /// </summary>
 110        [JsonProperty(PropertyName = "modelExportFrequency")]
 18111        public System.TimeSpan ModelExportFrequency { get; set; }
 112
 113        /// <summary>
 114        /// Gets or sets flag indicates whether log mirroring is enabled.
 115        /// </summary>
 116        [JsonProperty(PropertyName = "logMirrorEnabled")]
 0117        public bool? LogMirrorEnabled { get; set; }
 118
 119        /// <summary>
 120        /// Gets or sets azure storage account container SAS URI for log
 121        /// mirroring.
 122        /// </summary>
 123        [JsonProperty(PropertyName = "logMirrorSasUri")]
 0124        public string LogMirrorSasUri { get; set; }
 125
 126        /// <summary>
 127        /// Gets or sets number of days historical logs are to be maintained.
 128        /// -1 implies the logs will never be deleted.
 129        /// </summary>
 130        [JsonProperty(PropertyName = "logRetentionDays")]
 12131        public int LogRetentionDays { get; set; }
 132
 133        /// <summary>
 134        /// Validate the object.
 135        /// </summary>
 136        /// <exception cref="ValidationException">
 137        /// Thrown if validation fails
 138        /// </exception>
 139        public virtual void Validate()
 140        {
 2141            if (RewardAggregation == null)
 142            {
 0143                throw new ValidationException(ValidationRules.CannotBeNull, "RewardAggregation");
 144            }
 2145            if (DefaultReward > 1)
 146            {
 0147                throw new ValidationException(ValidationRules.InclusiveMaximum, "DefaultReward", 1);
 148            }
 2149            if (DefaultReward < -1)
 150            {
 0151                throw new ValidationException(ValidationRules.InclusiveMinimum, "DefaultReward", -1);
 152            }
 2153            if (RewardAggregation != null)
 154            {
 2155                if (RewardAggregation.Length > 256)
 156                {
 0157                    throw new ValidationException(ValidationRules.MaxLength, "RewardAggregation", 256);
 158                }
 159            }
 2160            if (ExplorationPercentage > 1)
 161            {
 0162                throw new ValidationException(ValidationRules.InclusiveMaximum, "ExplorationPercentage", 1);
 163            }
 2164            if (ExplorationPercentage < 0)
 165            {
 0166                throw new ValidationException(ValidationRules.InclusiveMinimum, "ExplorationPercentage", 0);
 167            }
 2168            if (LogRetentionDays > 2147483647)
 169            {
 0170                throw new ValidationException(ValidationRules.InclusiveMaximum, "LogRetentionDays", 2147483647);
 171            }
 2172            if (LogRetentionDays < -1)
 173            {
 0174                throw new ValidationException(ValidationRules.InclusiveMinimum, "LogRetentionDays", -1);
 175            }
 2176        }
 177    }
 178}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:14 PM
GitHub | www.palmmedia.de

Methods/Properties

.ctor()
.ctor(...)
get_RewardWaitTime()
get_DefaultReward()
get_RewardAggregation()
get_ExplorationPercentage()
get_ModelExportFrequency()
get_LogMirrorEnabled()
get_LogMirrorSasUri()
get_LogRetentionDays()
Validate()