C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Representation of a loss set with an associated year-event-loss table. More...
Public Types | |
enum | DataType { csv , binary } |
The format of the data uploaded against this YELT. More... | |
Public Member Functions | |
YELTLossSet () | |
Construct a new YELTLossSet with an empty event_catalogs 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 = "loss_sets" |
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 | |
bool | adjust_leap_years [get, set] |
Allows to skip 29 of Feb in the leap years in case if simulation has 365 days. | |
static string | APITypeName [get] |
Can be used to get the API type name in a static context. | |
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. | |
string | currency [get, set] |
The currency of the losses in this loss set. | |
LargeDataSubResource | data [get] |
An endpoint for accessing or modifying the data file attached to this resource. | |
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. | |
DataType? | data_type [get, set] |
The format of the data uploaded against this YELT (default CSV). | |
string | description [get, set] |
A user-friendly description of the resource. | |
List< IReference< EventCatalog > > | event_catalogs [get, set] |
A list of event catalog for which the loss set contains event losses. | |
string | id [get, set] |
The resource's unique identifier. It will be used in the request URL when requesting the resource from the server. | |
LossType? | loss_type [get, set] |
Indicates what types of losses are generated by this loss set. If not specified the server will default to LossGross, except for YLTLossSets, which are assumed to be LossNetOfAggregateTerms by default. | |
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. | |
bool | one_based_sequencing [get, set] |
By default event sequences start with 0. This parameter can be set to "true" if sequences in csv start with 1. | |
string | Path [get] |
The relative path to this endpoint from the root URL. | |
LossSetProfile | profile [get, set] |
A profile of this loss set, generated by the server after post. | |
ReinstatementsDataType? | reinstatements_data_type [get, set] |
Dictates whether any reinstatement information associated with the loss set should be interpreted as a fixed dollar amount. (ReinstatementsDataType.currency) or as a percentage of the premium of the layer this loss set gets attached to (ReinstatementsDataType.percentage). | |
DateTime | start_date [get, set] |
The date and time represented by a sequence value of 0 in the YELT data. | |
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. | |
int | trial_count [get, set] |
Number of trials in these simulated losses. | |
string | type [get] |
The server name for this type of resource. | |
Representation of a loss set with an associated year-event-loss table.
Definition at line 10 of file YELTLossSet.cs.
The format of the data uploaded against this YELT.
Enumerator | |
---|---|
csv | The file is in a text/csv format. |
binary | The file is in a binary format. |
Definition at line 13 of file YELTLossSet.DataType.cs.
|
inline |
Construct a new YELTLossSet with an empty event_catalogs list.
Definition at line 60 of file YELTLossSet.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 42 of file LossSet_WithData.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 41 of file LossSet.cs.
|
getset |
Allows to skip 29 of Feb in the leap years in case if simulation has 365 days.
Definition at line 55 of file YELTLossSet.cs.
|
staticgetinherited |
Can be used to get the API type name in a static context.
Definition at line 17 of file StoredAPIResource_Polymorphic.cs.
The collection endpoint at which resources of this type reside on the server.
Implements AnalyzeRe.IAPIResource.
Definition at line 44 of file LossSet.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.
|
getsetinherited |
The currency of the losses in this loss set.
Definition at line 14 of file LossSet_WithCurrency.cs.
|
getinherited |
An endpoint for accessing or modifying the data file attached to this resource.
Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.
Definition at line 17 of file LossSet_WithData.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 26 of file LossSet_WithData.cs.
|
getset |
The format of the data uploaded against this YELT (default CSV).
Definition at line 36 of file YELTLossSet.cs.
|
getsetinherited |
A user-friendly description of the resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 14 of file StoredAPIResource.cs.
|
getset |
A list of event catalog for which the loss set contains event losses.
Implements AnalyzeRe.LossSets.ILossSet_WithEventCatalog.
Definition at line 17 of file YELTLossSet.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 |
Indicates what types of losses are generated by this loss set. If not specified the server will default to LossGross, except for YLTLossSets, which are assumed to be LossNetOfAggregateTerms by default.
Implements AnalyzeRe.LossSets.ILossSet.
Definition at line 53 of file LossSet.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.
|
getset |
By default event sequences start with 0. This parameter can be set to "true" if sequences in csv start with 1.
Definition at line 50 of file YELTLossSet.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.
|
getsetinherited |
A profile of this loss set, generated by the server after post.
Implements AnalyzeRe.LossSets.ILossSet.
Definition at line 58 of file LossSet.cs.
|
getset |
Dictates whether any reinstatement information associated with the loss set should be interpreted as a fixed dollar amount. (ReinstatementsDataType.currency) or as a percentage of the premium of the layer this loss set gets attached to (ReinstatementsDataType.percentage).
Implements AnalyzeRe.LossSets.ILossSet_Simulated.
Definition at line 44 of file YELTLossSet.cs.
|
getset |
The date and time represented by a sequence value of 0 in the YELT data.
Implements AnalyzeRe.LossSets.ILossSet_WithSeasonality.
Definition at line 26 of file YELTLossSet.cs.
|
getsetinherited |
Status of the data file associated with this resource.
For details about an upload in progress, you may retrieve the APIResource_WithDataEndpoint.data endpoint's LargeDataSubResource.status response.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 34 of file LossSet_WithData.cs.
|
getsetinherited |
Status message of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 39 of file LossSet_WithData.cs.
|
getset |
Number of trials in these simulated losses.
Implements AnalyzeRe.LossSets.ILossSet_Simulated.
Definition at line 21 of file YELTLossSet.cs.
|
getinherited |
The server name for this type of resource.
Implements AnalyzeRe.APITypes.IAPI_Polymorphic.
Definition at line 13 of file StoredAPIResource_Polymorphic.cs.