C# Client Library
A C# Client Library for the AnalyzeRe REST API
|
Describes an APIResource class that adds a "/data" sub-resource, since this functionality is common to several different resources. TODO: Make this a mix-in if C# ever supports mix-ins or something similar. More...
Public Member Functions | |
T | ShallowCopy< T > () |
Create a shallow copy of this object. | |
Properties | |
string | collection_name [get] |
The relative path from the root of the API at which the collection of resources of this type reside. | |
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. | |
Dictionary< string, object > | meta_data [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. | |
TaskStatus | status [get, set] |
Validation status of this resource. | |
string | status_message [get, set] |
Resource validation status message (if any). | |
Describes an APIResource class that adds a "/data" sub-resource, since this functionality is common to several different resources. TODO: Make this a mix-in if C# ever supports mix-ins or something similar.
Definition at line 11 of file IAPIResource_WithDataEndpoint.cs.
Create a shallow copy of this object.
Implemented in AnalyzeRe.APIType.
T | : | IAPIType |
|
getinherited |
The relative path from the root of the API at which the collection of resources of this type reside.
Implemented in AnalyzeRe.API.PortfolioViewMarginals.MarginalPortfolioView, AnalyzeRe.Authentication.OauthAccessToken, AnalyzeRe.AnalysisProfile, AnalyzeRe.APIResource, AnalyzeRe.Distribution, AnalyzeRe.EventCatalog, AnalyzeRe.ExchangeRates.ExchangeRateProfile, AnalyzeRe.ExchangeRates.ExchangeRateTable, AnalyzeRe.DataFile, AnalyzeRe.Layer, AnalyzeRe.LayerView< T >, AnalyzeRe.LossFilter, AnalyzeRe.LossSet, AnalyzeRe.Agent, AnalyzeRe.Analyses.Analysis, AnalyzeRe.Optimization.Candidate, AnalyzeRe.Optimization.ProjectionFunction, AnalyzeRe.Optimization.MetricsFunction, AnalyzeRe.Optimization.OptimizationView, AnalyzeRe.Portfolio, AnalyzeRe.PortfolioView, and AnalyzeRe.Simulation.
Definition at line 19 of file IAPIResource.cs.
|
getsetinherited |
The date and time when the resource was created on the system.
Implemented in AnalyzeRe.APITypes.StoredAPIResource.
Definition at line 19 of file IStoredAPIResource.cs.
|
get |
An endpoint for accessing or modifying the data file attached to this resource.
Implemented in AnalyzeRe.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.StaticSimulation.
Definition at line 15 of file IAPIResource_WithDataEndpoint.cs.
|
getset |
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.
Implemented in AnalyzeRe.APITypes.APIResource_WithDataEndpoint, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.StaticSimulation.
Definition at line 23 of file IAPIResource_WithDataEndpoint.cs.
|
getsetinherited |
A user-friendly description of the resource.
Implemented in AnalyzeRe.APITypes.StoredAPIResource.
Definition at line 14 of file IStoredAPIResource.cs.
|
getsetinherited |
The resource's unique identifier. It will be used in the request URL when requesting the resource from the server.
Implemented in AnalyzeRe.APIResource, and AnalyzeRe.Optimization.Candidate.
Definition at line 14 of file IAPIResource.cs.
|
getsetinherited |
Any user-defined metadata for this layer.
Implemented in AnalyzeRe.APITypes.StoredAPIResource.
Definition at line 30 of file IStoredAPIResource.cs.
|
getsetinherited |
The date and time when the resource was last modified on the system.
Implemented in AnalyzeRe.APITypes.StoredAPIResource.
Definition at line 24 of file IStoredAPIResource.cs.
|
getinherited |
The relative path to this endpoint from the root URL.
Implemented in AnalyzeRe.API.PortfolioViewMarginals, AnalyzeRe.APITypes.SubResourceEndpoint, AnalyzeRe.APIResource, and AnalyzeRe.Optimization.Candidate.
Definition at line 13 of file IEndpoint.cs.
|
getsetinherited |
Validation status of this resource.
Implemented in AnalyzeRe.APITypes.StoredAPIResource_WithStatus, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.StaticSimulation.
Definition at line 16 of file IStoredAPIResource_WithStatus.cs.
|
getsetinherited |
Resource validation status message (if any).
Implemented in AnalyzeRe.APITypes.StoredAPIResource_WithStatus, AnalyzeRe.Distributions.CustomDistribution, AnalyzeRe.LossSets.LossSet_WithData, and AnalyzeRe.StaticSimulation.
Definition at line 21 of file IStoredAPIResource_WithStatus.cs.