ExtensionMethods.IAPIResourceView.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using AnalyzeRe.Metrics;
 
// Disable warnings about snake_case function names in this method. While it
// C# best-practice, it's done intentionally to follow the API conventions closely.
#pragma warning disable IDE1006
 
namespace AnalyzeRe
{
    public static partial class ExtensionMethods
    {
        #region Blocking Metrics Requests
        public static TailMetrics tail_metrics_blocking(this IAPIResourceView thisView,
            double probability, MetricsOptions options = null, PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(
                () => thisView.tail_metrics(probability, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static List<TailMetrics> tail_metrics_blocking(this IAPIResourceView thisView,
            IEnumerable<double> probabilities, MetricsOptions options = null,
            PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(() =>
                thisView.tail_metrics(probabilities, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static WindowMetrics window_metrics_blocking(this IAPIResourceView thisView,
            ProbabilityWindow range, MetricsOptions options = null, PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(
                () => thisView.window_metrics(range, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static List<WindowMetrics> window_metrics_blocking(this IAPIResourceView thisView,
            IEnumerable<ProbabilityWindow> ranges, MetricsOptions options = null,
            PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(() =>
                thisView.window_metrics(ranges, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static CoMetrics co_metrics_blocking<T>(
            this IAPIResourceView thisView, ProbabilityWindow range,
            IReference<T> component, CoMetricsOptions options = null,
            PollingOptions pollingOptions = null)
            where T : IAPIResourceView
        {
            return API.PollUntilReady(() =>
                thisView.co_metrics(range, component, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static List<CoMetrics> co_metrics_blocking<T>(
            this IAPIResourceView thisView, IEnumerable<ProbabilityWindow> ranges,
            IReference<T> component, CoMetricsOptions options = null,
            PollingOptions pollingOptions = null)
            where T : IAPIResourceView
        {
            return API.PollUntilReady(() =>
                thisView.co_metrics(ranges, component, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static ExceedanceProbability exceedance_probability_blocking(
            this IAPIResourceView thisView, double threshold,
            ExceedanceProbabilityOptions options = null, PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(() =>
                thisView.exceedance_probability(threshold, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        public static List<ExceedanceProbability> exceedance_probability_blocking(
            this IAPIResourceView thisView, IEnumerable<double> thresholds,
            ExceedanceProbabilityOptions options = null, PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(() =>
                thisView.exceedance_probability(thresholds, options, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
 
        [Obsolete("POST a BackAllocatedLayer structure instead.")]
        public static BackAllocations back_allocations_blocking(
            this IAPIResourceView thisView, string source_id, PollingOptions pollingOptions = null)
        {
            return API.PollUntilReady(() =>
                thisView.back_allocations(source_id, pollingOptions?.MaxPollTotalTime),
                pollingOptions);
        }
        #endregion Blocking Metrics Requests
 
        #region Metrics Aliases
        public static double expected_loss(
            this IAPIResourceView thisView, MetricsOptions options = null, int? timeout = null)
        {
            return thisView.tail_metrics(1.0, options, timeout).mean;
        }
        public static double tvar(this IAPIResourceView thisView,
            double probability, MetricsOptions options = null, int? timeout = null)
        {
            return thisView.tail_metrics(probability, options, timeout).mean;
        }
 
        public static double var(this IAPIResourceView thisView,
            double probability, MetricsOptions options = null, int? timeout = null)
        {
            return thisView.tail_metrics(probability, options, timeout).min;
        }
        #endregion Metrics Aliases
    }
}