// <copyright file="SamplingDecision.cs" company="OpenTelemetry Authors">
// Copyright The OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>

#nullable enable

namespace OpenTelemetry.Trace;

/// <summary>
/// Enumeration to define sampling decision.
/// </summary>
public enum SamplingDecision
{
    /// <summary>
    /// The activity will be created but not recorded.
    /// Activity.IsAllDataRequested will return false.
    /// </summary>
    Drop,

    /// <summary>
    /// The activity will be created and recorded, but sampling flag will not be set.
    /// Activity.IsAllDataRequested will return true.
    /// Activity.Recorded will return false.
    /// </summary>
    RecordOnly,

    /// <summary>
    /// The activity will be created, recorded, and sampling flag will be set.
    /// Activity.IsAllDataRequested will return true.
    /// Activity.Recorded will return true.
    /// </summary>
    RecordAndSample,
}
