C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
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. | |
virtual T | ShallowCopy< T > () |
Create a shallow copy of this object.
for a serializer-based copy method. | |
Static Public Attributes | |
static readonly string | CLASS_COLLECTION_NAME = "event_catalogs" |
The collection endpoint at which resources of this type reside on the server. | |
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.Overriding implementations should be sure to invoke base.AfterMembersCloned(). | |
Properties | |
override string | collection_name [get] |
The collection endpoint at which resources of this type reside on the server. | |
DateTime? | created [get, set] |
The date and time when the resource was created on the system. | |
LargeDataSubResource | data [get] |
An endpoint for accessing or modifying the data file attached to this resource. Also contains a LargeDataSubResource.status endpoint for retrieving information about the upload progress (such as the current AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress). | |
IReference< DataFile > | data_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. | |
string | description [get, set] |
A user-friendly description of the resource. | |
string | id [get, set] |
The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. | |
Dictionary< string, object > | meta_data = new Dictionary<string, object>() [get, set] |
Any user-defined metadata for this layer. | |
DateTime? | modified [get, set] |
The date and time when the resource was last modified on the system. | |
string | Path [get] |
The relative path to this endpoint from the root URL. | |
SubResource< Profile > | profile [get] |
An endpoint from which the user can retrieve information about the columns in this event catalog (once processed). | |
double | progress [get, set] |
Obsolete - Maintained for backwards-compatibility purposes. This was meant to display the progress in processing this Event Catalog's associated data, but is is not currencly part of the server model. This resource's APIResource_WithDataEndpoint.data endpoint does, however, have a LargeDataSubResource.status endpoint that reports the LargeDataUpload.StatusResponse.commit_progress. | |
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. | |
TaskStatus | status [get, set] |
Status of the data file associated with this resource. | |
string | status_message [get, set] |
Status message of the data file associated with this resource. | |
List< string > | tags [get, set] |
A list of region/peril combinations that are provided by the event catalog. | |
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 12 of file EventCatalog.cs.
|
inline |
Construct a new EventCatalog with an empty tags list.
Definition at line 52 of file EventCatalog.cs.
|
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.Overriding implementations should be sure to invoke base.AfterMembersCloned().
Reimplemented from AnalyzeRe.APIType.
Definition at line 33 of file APIResource_WithDataEndpoint.cs.
|
inlinevirtualinherited |
Create a shallow copy of this object.
for a serializer-based copy method.
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.
T | : | IAPIType |
Definition at line 14 of file APIType.cs.
The collection endpoint at which resources of this type reside on the server.
Definition at line 16 of file EventCatalog.cs.
The collection endpoint at which resources of this type reside on the server.
Implements AnalyzeRe.IAPIResource.
Definition at line 19 of file EventCatalog.cs.
|
getsetinherited |
The date and time when the resource was created on the system.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 19 of file StoredAPIResource.cs.
|
getinherited |
An endpoint for accessing or modifying the data file attached to this resource. Also contains a LargeDataSubResource.status endpoint for retrieving information about the upload progress (such as the current AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress).
Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.
Definition at line 19 of file APIResource_WithDataEndpoint.cs.
|
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.
Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.
Definition at line 30 of file APIResource_WithDataEndpoint.cs.
|
getsetinherited |
A user-friendly description of the resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 14 of file StoredAPIResource.cs.
|
getsetinherited |
The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
Implements AnalyzeRe.IAPIResource.
Definition at line 16 of file APIResource.cs.
|
getsetinherited |
Any user-defined metadata for this layer.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 30 of file StoredAPIResource.cs.
|
getsetinherited |
The date and time when the resource was last modified on the system.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 24 of file StoredAPIResource.cs.
|
getinherited |
The relative path to this endpoint from the root URL.
The relative path to this endpoint from the root URL.
System.ArgumentException | If this resource does not have an id. |
Implements AnalyzeRe.APITypes.IEndpoint.
Definition at line 27 of file APIResource.cs.
|
get |
An endpoint from which the user can retrieve information about the columns in this event catalog (once processed).
Definition at line 48 of file EventCatalog.cs.
|
getset |
Obsolete - Maintained for backwards-compatibility purposes. This was meant to display the progress in processing this Event Catalog's associated data, but is is not currencly part of the server model. This resource's APIResource_WithDataEndpoint.data endpoint does, however, have a LargeDataSubResource.status endpoint that reports the LargeDataUpload.StatusResponse.commit_progress.
Definition at line 29 of file EventCatalog.cs.
|
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 37 of file EventCatalog.cs.
|
getsetinherited |
Status of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 16 of file StoredAPIResource_WithStatus.cs.
|
getsetinherited |
Status message of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 21 of file StoredAPIResource_WithStatus.cs.
|
getset |
A list of region/peril combinations that are provided by the event catalog.
Definition at line 43 of file EventCatalog.cs.