C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
EventCatalog.cs
Go to the documentation of this file.
1using System;
2using System.Collections.Generic;
3using System.Runtime.Serialization;
4
7
8namespace AnalyzeRe
9{
13 {
14 #region APIResource Interface Members
16 public static readonly string CLASS_COLLECTION_NAME = "event_catalogs";
19 public override string collection_name => CLASS_COLLECTION_NAME;
20
28 [Obsolete("Progress % is not reported on the root object, but at the /data/status/ endpoint.")]
29 public double progress { get; set; }
30 #endregion APIResource Interface Members
31
32 #region Public Properties
35 [DataMember(Order = 12)]
36 [NotEmpty]
37 public string source { get; set; }
38
41 [DataMember(Order = 13)]
43 public List<string> tags { get; set; }
44
48 public SubResource<Profile> profile => new SubResource<Profile>(this, "profile");
49 #endregion Public Properties
50
52 public EventCatalog()
53 {
54 tags = new List<string>();
55 }
56
57 #region Nested Classes
60 public class Profile : APIType
61 {
63 [DataMember(Order = 1)]
65 }
66
68 public class Attribute : APIType
69 {
72 [DataMember(Order = 1)]
73 public string name { get; set; }
74
77 [DataMember(Order = 2)]
78 public string type { get; set; }
79
83 [DataMember(Order = 3)]
84 public HashSet<object> values { get; set; }
85 }
86 #endregion Nested Classes
87 }
88}
Base class used by all types and resources.
Definition APIType.cs:8
Minor extension to the base APIResource class that adds a "/data" sub-resource, since this is common ...
Describes a collection of resources which can be listed.
Indicates that the property, if left null, will be given a default value by the server corresponding ...
Represents a column of values parsed out of the catalog.
HashSet< object > values
The list of distinct values that appear in this column.
string type
The type of values that appear in this column, as determined by the server.
string name
The corresponding column name as it appears in the event catalog (case sensitive)
An object retrieved from the EventCatalog.profile endpoint of a catalog that describes the columns in...
List< Attribute > attributes
The set of all columns parsed from the catalog.
Representation of an event catalog. The event catalog may cover multiple region/perils,...
string source
A unique identifier for the source of the event catalog, which typically would be a vendor model or a...
EventCatalog()
Construct a new EventCatalog with an empty tags list.
override string collection_name
The collection endpoint at which resources of this type reside on the server.
static readonly string CLASS_COLLECTION_NAME
The collection endpoint at which resources of this type reside on the server.
SubResource< Profile > profile
An endpoint from which the user can retrieve information about the columns in this event catalog (onc...
List< string > tags
A list of region/peril combinations that are provided by the event catalog.
double progress
Obsolete - Maintained for backwards-compatibility purposes. This was meant to display the progress in...