C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Custom Distribution that describes a parametric loss set's seasonality. More...
Public Member Functions | |
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 = "distributions" |
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 | |
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. | |
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. | |
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. | |
bool | interpolate [get, set] |
Determines whether linear interpolation should be used for probabilities between those that appear in the custom distribution. (Default: False) | |
double? | max_val [get, set] |
The server calculated maximum value of this distribution (if available) | |
double? | mean_val [get, set] |
The server calculated mean value of this distribution (if available) | |
Dictionary< string, object > | meta_data = new Dictionary<string, object>() [get, set] |
Any user-defined metadata for this layer. | |
double? | min_val [get, set] |
The server calculated minimum value of this distribution (if available) | |
DateTime? | modified [get, set] |
The date and time when the resource was last modified on the system. | |
double? | modulo [get, set] |
Sets a maximum value for the distribution. Any values greater than or equal to this will be wrapped back to zero. (For example, if modulo = 365, when the distribution produces a value of 370.5, the resulting value will be 5.5, and a value of exactly 365 would wrap to 0.) Similarly, negative numbers produced by the distribution will get wrapped up to a number between 0 and modulo. Leave modulo equal to null and distribution values will remain unmodified. | |
string | Path [get] |
The relative path to this endpoint from the root URL. | |
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. | |
string | type [get] |
The server name for this type of resource. | |
Custom Distribution that describes a parametric loss set's seasonality.
Definition at line 4 of file CustomSeasonalityDistribution.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 46 of file CustomDistribution.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 15 of file Distribution.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 18 of file Distribution.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.
Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.
Definition at line 24 of file CustomDistribution.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 33 of file CustomDistribution.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 |
Determines whether linear interpolation should be used for probabilities between those that appear in the custom distribution. (Default: False)
Definition at line 16 of file CustomDistribution.cs.
|
getsetinherited |
The server calculated maximum value of this distribution (if available)
Implements AnalyzeRe.Distributions.IDistribution.
Definition at line 45 of file Distribution.cs.
|
getsetinherited |
The server calculated mean value of this distribution (if available)
Implements AnalyzeRe.Distributions.IDistribution.
Definition at line 40 of file Distribution.cs.
|
getsetinherited |
Any user-defined metadata for this layer.
Implements AnalyzeRe.APITypes.IStoredAPIResource.
Definition at line 30 of file StoredAPIResource.cs.
|
getsetinherited |
The server calculated minimum value of this distribution (if available)
Implements AnalyzeRe.Distributions.IDistribution.
Definition at line 35 of file Distribution.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.
|
getsetinherited |
Sets a maximum value for the distribution. Any values greater than or equal to this will be wrapped back to zero. (For example, if modulo = 365, when the distribution produces a value of 370.5, the resulting value will be 5.5, and a value of exactly 365 would wrap to 0.) Similarly, negative numbers produced by the distribution will get wrapped up to a number between 0 and modulo. Leave modulo equal to null and distribution values will remain unmodified.
Implements AnalyzeRe.Distributions.IDistribution.
Definition at line 30 of file Distribution.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 |
Status of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 38 of file CustomDistribution.cs.
|
getsetinherited |
Status message of the data file associated with this resource.
Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.
Definition at line 43 of file CustomDistribution.cs.
|
getinherited |
The server name for this type of resource.
Implements AnalyzeRe.APITypes.IAPI_Polymorphic.
Definition at line 13 of file StoredAPIResource_Polymorphic.cs.