C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalysisProfile.cs
Go to the documentation of this file.
3using System;
4using System.Collections.Generic;
5using System.Runtime.Serialization;
6
7namespace AnalyzeRe
8{
11 {
12 #region APIResource Interface Members
13
15 public static readonly string CLASS_COLLECTION_NAME = "analysis_profiles";
16
19 public override string collection_name => CLASS_COLLECTION_NAME;
20
25 [Obsolete("No % progress is available on the server. Use .PollUntilReady() to await for completion.")]
26 public double progress { get; set; }
27
28 #endregion APIResource Interface Members
29
30 #region Public Properties
31
33 [DataMember(Order = 11)]
34 [NotNull]
36
38 [DataMember(Order = 12)]
39 public IReference<ExchangeRates.ExchangeRateProfile> exchange_rate_profile { get; set; }
40
42 [DataMember(Order = 13)]
43 [NotNull]
44 [NotEmpty]
46
48 [DataMember(Order = 14)]
51
54 [DataMember(Order = 15)]
55 // TODO ARE-6645: Uncomment the ServerHasDefault attribute once API changes are complete
56 //[ServerHasDefault(Perspective.Base.NetLoss)]
57 public Perspective default_perspective { get; set; }
58
61 [DataMember(Order = 16)]
62 public bool yelt_loss_set_simulation_filtering { get; set; }
63
65 [DataMember(Order = 17)]
66 public bool round_sequences { get; set; }
67
68 #endregion Public Properties
69
77 }
78}
Describes a collection of resources which can be listed.
Base class for a StoredAPIResource that has a "status" property and corresponding "status_message" wh...
A configuration of resources used to simulate a layer or portfolio.
bool yelt_loss_set_simulation_filtering
Filter occurrences contained in a YELT Loss Set based on the occurrences defined in the SimGrid (ARE-...
static readonly string CLASS_COLLECTION_NAME
The collection endpoint at which resources of this type reside on the server.
IReference< ExchangeRates.ExchangeRateProfile > exchange_rate_profile
The ExchangeRateProfile to use to get rates.
bool round_sequences
Round sequences to the nearest second.
IReference< Simulation > simulation
The Simulation to run.
Perspective default_perspective
Determines what the default Metrics.Context.perspective will be if no specific Perspective is request...
List< IReference< LossFilter > > loss_filters
The LossFilters to bucket simulation results in.
List< IReference< EventCatalog > > event_catalogs
The EventCatalogs to use during this simulation.
AnalysisProfile()
Construct a new AnalysisProfile with empty loss_filters and event_catalogs lists.
override string collection_name
The collection endpoint at which resources of this type reside on the server.
double progress
Obsolete - Maintained for backwards-compatibility purposes. Was meant to display the progress in proc...
Indicates that the property, if left null, will be given a default value by the server corresponding ...
The loss perspective determines what factors to include when computing a distribution.
Base interface for all reference entities.