< Summary

Class:Azure.AI.TextAnalytics.TextAnalyticsClientOptions
Assembly:Azure.AI.TextAnalytics
File(s):C:\Git\azure-sdk-for-net\sdk\textanalytics\Azure.AI.TextAnalytics\src\TextAnalyticsClientOptions.cs
Covered lines:11
Uncovered lines:3
Coverable lines:14
Total lines:81
Line coverage:78.5% (11 of 14)
Covered branches:2
Total branches:4
Branch coverage:50% (2 of 4)

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
get_Version()-100%100%
get_DefaultCountryHint()-100%100%
get_DefaultLanguage()-0%100%
.ctor(...)-100%100%
GetVersionString()-71.43%50%

File(s)

C:\Git\azure-sdk-for-net\sdk\textanalytics\Azure.AI.TextAnalytics\src\TextAnalyticsClientOptions.cs

#LineLine coverage
 1// Copyright (c) Microsoft Corporation. All rights reserved.
 2// Licensed under the MIT License.
 3
 4using Azure.Core;
 5using System;
 6
 7namespace Azure.AI.TextAnalytics
 8{
 9    /// <summary>
 10    /// Options that allow to configure the management of the request sent to the service.
 11    /// </summary>
 12    public class TextAnalyticsClientOptions : ClientOptions
 13    {
 14        /// <summary>
 15        /// The latest service version supported by this client library.
 16        /// </summary>
 17        internal const ServiceVersion LatestVersion = ServiceVersion.V3_1_Preview_1;
 18
 19        /// <summary>
 20        /// The versions of the Text Analytics service supported by this client library.
 21        /// </summary>
 22        public enum ServiceVersion
 23        {
 24#pragma warning disable CA1707 // Identifiers should not contain underscores
 25            /// <summary>
 26            /// Version 3.0
 27            /// </summary>
 28            V3_0 = 1,
 29
 30            /// <summary>
 31            /// Version 3.1-preview.1
 32            /// </summary>
 33            V3_1_Preview_1 = 2,
 34#pragma warning restore CA1707 // Identifiers should not contain underscores
 35        }
 36
 37        /// <summary>
 38        /// Gets the <see cref="ServiceVersion"/> of the service API used when
 39        /// making requests.
 40        /// </summary>
 18441        internal ServiceVersion Version { get; }
 42
 43        /// <summary>
 44        /// Default country hint value to use in all client calls.
 45        /// If no value is specified, "us" is set as default.
 46        /// To remove this behavior, set to <see cref="DetectLanguageInput.None"/>.
 47        /// </summary>
 24448        public string DefaultCountryHint { get; set; } = "us";
 49
 50        /// <summary>
 51        /// Default language value to use in all client calls.
 52        /// If no value is specified, "en" is set as default.
 53        /// </summary>
 054        public string DefaultLanguage { get; set; } = "en";
 55
 56        /// <summary>
 57        /// Initializes a new instance of the <see cref="TextAnalyticsClientOptions"/>
 58        /// class.
 59        /// </summary>
 60        /// <param name="version">
 61        /// The <see cref="ServiceVersion"/> of the service API used when
 62        /// making requests.
 63        /// </param>
 20064        public TextAnalyticsClientOptions(ServiceVersion version = LatestVersion)
 65        {
 20066            Version = version;
 20067            this.ConfigureLogging();
 20068        }
 69
 70        internal string GetVersionString()
 71        {
 18472            return Version switch
 18473            {
 074                ServiceVersion.V3_0 => "v3.0",
 36875                ServiceVersion.V3_1_Preview_1 => "v3.1-preview.1",
 18476
 077                _ => throw new ArgumentException($"Version {Version.ToString()} not supported."),
 18478            };
 79        }
 80    }
 81}