C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint Interface Reference

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.
 
DateTimecreated [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< 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.
 
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, objectmeta_data [get, set]
 Any user-defined metadata for this layer.
 
DateTimemodified [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).
 

Detailed Description

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.

Inheritance diagram for AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint:
AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.APITypes.APIResource_WithDataEndpoint AnalyzeRe.Distributions.CustomDistribution AnalyzeRe.LossSets.ILossSet_WithData AnalyzeRe.StaticSimulation AnalyzeRe.EventCatalog AnalyzeRe.ExchangeRates.ExchangeRateTable AnalyzeRe.Distributions.CustomFrequencyDistribution AnalyzeRe.Distributions.CustomSeasonalityDistribution AnalyzeRe.Distributions.CustomSeverityDistribution AnalyzeRe.LossSets.ILossSet_Simulated AnalyzeRe.LossSets.LossSet_WithData AnalyzeRe.LossSets.YELTLossSet AnalyzeRe.LossSets.YLTLossSet AnalyzeRe.LossSets.ELTLossSet AnalyzeRe.LossSets.YELTLossSet AnalyzeRe.LossSets.YLTLossSet AnalyzeRe.LossSets.PortfolioLossSet AnalyzeRe.LossSets.TreatyLossSet

Member Function Documentation

◆ ShallowCopy< T >()

T AnalyzeRe.IAPIType.ShallowCopy< T > ( )
inherited

Create a shallow copy of this object.

Returns
A shallow copy of this object.

Implemented in AnalyzeRe.APIType.

Type Constraints
T :IAPIType 

Property Documentation

◆ collection_name

◆ created

DateTime? AnalyzeRe.APITypes.IStoredAPIResource.created
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.

◆ data

LargeDataSubResource AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.data
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.

◆ data_file

IReference<DataFile> AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.data_file
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.

◆ description

string AnalyzeRe.APITypes.IStoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Implemented in AnalyzeRe.APITypes.StoredAPIResource.

Definition at line 14 of file IStoredAPIResource.cs.

◆ id

string AnalyzeRe.IAPIResource.id
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.

◆ meta_data

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

Any user-defined metadata for this layer.

Implemented in AnalyzeRe.APITypes.StoredAPIResource.

Definition at line 30 of file IStoredAPIResource.cs.

◆ modified

DateTime? AnalyzeRe.APITypes.IStoredAPIResource.modified
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.

◆ Path

string AnalyzeRe.APITypes.IEndpoint.Path
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.

◆ status

TaskStatus AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.status
getsetinherited

◆ status_message

string AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.status_message
getsetinherited

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