C# Client Library
A C# Client Library for the AnalyzeRe REST API
AnalyzeRe.EventCatalog Class Reference

Representation of an event catalog. The event catalog may cover multiple region/perils, but it is suggested that event catalogs cover disjoint set of events. More...

Classes

class  Attribute
 Represents a column of values parsed out of the catalog. More...
 
class  Profile
 An object retrieved from the EventCatalog.profile endpoint of a catalog that describes the columns in that catalog. More...
 

Public Member Functions

 EventCatalog ()
 Construct a new EventCatalog with an empty tags list. More...
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method. More...

 

Public Attributes

override string collection_name => CLASS_COLLECTION_NAME
 The collection endpoint at which resources of this type reside on the server. More...
 
LargeDataSubResource data
 An endpoint for accessing or modifying the data file attached to this resource. More...
 
string Path => API.GetResourcePath(this)
 The relative path to this endpoint from the root URL. More...
 
SubResource< Profileprofile => new SubResource<Profile>(this, "profile")
 An endpoint from which the user can retrieve information about the columns in this event catalog (once processed). More...
 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "event_catalogs"
 The collection endpoint at which resources of this type reside on the server. More...
 

Protected Member Functions

override void AfterMembersCloned (APIType _)
 Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned. More...
 

Properties

DateTime created [get, set]
 The date and time when the resource was created on the system. More...
 
IReference< DataFiledata_file [get, set]
 A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource. More...
 
string description [get, set]
 A user-friendly description of the resource. More...
 
string id [get, set]
 The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. More...
 
Dictionary< string, object > meta_data [get, set]
 Any user-defined metadata for this layer. More...
 
DateTime modified [get, set]
 The date and time when the resource was last modified on the system. More...
 
double progress [get, set]
 The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types. More...
 
string source [get, set]
 A unique identifier for the source of the event catalog, which typically would be a vendor model or a manually curated catalog. More...
 
TaskStatus status [get, set]
 Status of the data file associated with this resource. More...
 
string status_message [get, set]
 Status message of the data file associated with this resource. More...
 
List< string > tags [get, set]
 A list of region/peril combinations that are provided by the event catalog. More...
 

Detailed Description

Representation of an event catalog. The event catalog may cover multiple region/perils, but it is suggested that event catalogs cover disjoint set of events.

Definition at line 11 of file EventCatalog.cs.

Inheritance diagram for AnalyzeRe.EventCatalog:
AnalyzeRe.APITypes.APIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Constructor & Destructor Documentation

AnalyzeRe.EventCatalog.EventCatalog ( )
inline

Construct a new EventCatalog with an empty tags list.

Definition at line 41 of file EventCatalog.cs.

Member Function Documentation

override void AnalyzeRe.APITypes.APIResource_WithDataEndpoint.AfterMembersCloned ( APIType  _)
inlineprotectedvirtualinherited

Invoked following construction if the current instance has been created using a member-wise clone of some other instance. Override if your derived APIType class contains some members that should not be cloned.

Reimplemented from AnalyzeRe.APIType.

Definition at line 28 of file APIResource_WithDataEndpoint.cs.

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

If this object contains any members that reference the current object (this), the class should override this method to avoid cloning a reference to the old class.

Implements AnalyzeRe.IAPIType.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Member Data Documentation

readonly string AnalyzeRe.EventCatalog.CLASS_COLLECTION_NAME = "event_catalogs"
static

The collection endpoint at which resources of this type reside on the server.

Definition at line 15 of file EventCatalog.cs.

override string AnalyzeRe.EventCatalog.collection_name => CLASS_COLLECTION_NAME

The collection endpoint at which resources of this type reside on the server.

Definition at line 18 of file EventCatalog.cs.

LargeDataSubResource AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data
inherited
Initial value:
=> _dataEndpoint ??
(_dataEndpoint = new LargeDataSubResource(this))

An endpoint for accessing or modifying the data file attached to this resource.

Definition at line 16 of file APIResource_WithDataEndpoint.cs.

string AnalyzeRe.APIResource.Path => API.GetResourcePath(this)
inherited

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Definition at line 27 of file APIResource.cs.

SubResource<Profile> AnalyzeRe.EventCatalog.profile => new SubResource<Profile>(this, "profile")

An endpoint from which the user can retrieve information about the columns in this event catalog (once processed).

Definition at line 37 of file EventCatalog.cs.

Property Documentation

DateTime AnalyzeRe.APITypes.StoredAPIResource.created
getsetinherited

The date and time when the resource was created on the system.

Definition at line 19 of file StoredAPIResource.cs.

IReference<DataFile> AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data_file
getsetinherited

A reference to the data attached to this resource. This field will automatically be created if you initiate an upload using the data property, or this can be set to reference an existing file on the server to immediately initiate the commit phase of this resource.

Definition at line 25 of file APIResource_WithDataEndpoint.cs.

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Definition at line 14 of file StoredAPIResource.cs.

string AnalyzeRe.APIResource.id
getsetinherited

The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.

Definition at line 16 of file APIResource.cs.

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data
getsetinherited

Any user-defined metadata for this layer.

Definition at line 30 of file StoredAPIResource.cs.

DateTime AnalyzeRe.APITypes.StoredAPIResource.modified
getsetinherited

The date and time when the resource was last modified on the system.

Definition at line 24 of file StoredAPIResource.cs.

double AnalyzeRe.APITypes.StoredAPIResource_WithStatus.progress
getsetinherited

The progress made in validating this resource. Usually a number between 0 and 1 (where 1 means 100% completion). Progress may not be available for certain resource types.

Definition at line 28 of file StoredAPIResource_WithStatus.cs.

string AnalyzeRe.EventCatalog.source
getset

A unique identifier for the source of the event catalog, which typically would be a vendor model or a manually curated catalog.

Definition at line 26 of file EventCatalog.cs.

TaskStatus AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status
getsetinherited

Status of the data file associated with this resource.

Definition at line 16 of file StoredAPIResource_WithStatus.cs.

string AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status_message
getsetinherited

Status message of the data file associated with this resource.

Definition at line 21 of file StoredAPIResource_WithStatus.cs.

List<string> AnalyzeRe.EventCatalog.tags
getset

A list of region/peril combinations that are provided by the event catalog.

Definition at line 32 of file EventCatalog.cs.


The documentation for this class was generated from the following file: