ExtractiveSummarySentencesOrder.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

// <auto-generated/>

#nullable disable

using System;
using System.ComponentModel;

namespace Azure.AI.TextAnalytics
{
    /// <summary> The sorting criteria to use for the results of Extractive Summarization. </summary>
    public readonly partial struct ExtractiveSummarySentencesOrder : IEquatable<ExtractiveSummarySentencesOrder>
    {
        private readonly string _value;

        /// <summary> Initializes a new instance of <see cref="ExtractiveSummarySentencesOrder"/>. </summary>
        /// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
        public ExtractiveSummarySentencesOrder(string value)
        {
            _value = value ?? throw new ArgumentNullException(nameof(value));
        }

        private const string OffsetValue = "Offset";
        private const string RankValue = "Rank";

        /// <summary> Indicates that results should be sorted in order of appearance in the text. </summary>
        public static ExtractiveSummarySentencesOrder Offset { get; } = new ExtractiveSummarySentencesOrder(OffsetValue);
        /// <summary> Indicates that results should be sorted in order of importance (i.e. rank score) according to the model. </summary>
        public static ExtractiveSummarySentencesOrder Rank { get; } = new ExtractiveSummarySentencesOrder(RankValue);
        /// <summary> Determines if two <see cref="ExtractiveSummarySentencesOrder"/> values are the same. </summary>
        public static bool operator ==(ExtractiveSummarySentencesOrder left, ExtractiveSummarySentencesOrder right) => left.Equals(right);
        /// <summary> Determines if two <see cref="ExtractiveSummarySentencesOrder"/> values are not the same. </summary>
        public static bool operator !=(ExtractiveSummarySentencesOrder left, ExtractiveSummarySentencesOrder right) => !left.Equals(right);
        /// <summary> Converts a string to a <see cref="ExtractiveSummarySentencesOrder"/>. </summary>
        public static implicit operator ExtractiveSummarySentencesOrder(string value) => new ExtractiveSummarySentencesOrder(value);

        /// <inheritdoc />
        [EditorBrowsable(EditorBrowsableState.Never)]
        public override bool Equals(object obj) => obj is ExtractiveSummarySentencesOrder other && Equals(other);
        /// <inheritdoc />
        public bool Equals(ExtractiveSummarySentencesOrder other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);

        /// <inheritdoc />
        [EditorBrowsable(EditorBrowsableState.Never)]
        public override int GetHashCode() => _value?.GetHashCode() ?? 0;
        /// <inheritdoc />
        public override string ToString() => _value;
    }
}