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

Interface for Base class used by all stored resources. 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.
 
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.
 

Detailed Description

Interface for Base class used by all stored resources.

Definition at line 9 of file IStoredAPIResource.cs.

Inheritance diagram for AnalyzeRe.APITypes.IStoredAPIResource:
AnalyzeRe.IAPIResource AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.Distributions.IDistribution AnalyzeRe.ILayer AnalyzeRe.LossSets.ILossSet AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.APITypes.StoredAPIResource_Polymorphic AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.Agent AnalyzeRe.DataFile AnalyzeRe.ExchangeRates.ExchangeRateProfile AnalyzeRe.Optimization.Function AnalyzeRe.Distribution AnalyzeRe.Distributions.IContinuousDistribution AnalyzeRe.Distributions.IDiscreteDistribution AnalyzeRe.Layer AnalyzeRe.Layers.ILayer_WithLossSets AnalyzeRe.LossSet AnalyzeRe.LossSets.ILossSet_WithData AnalyzeRe.LossSets.ILossSet_WithEventCatalog AnalyzeRe.LossSets.ILossSet_WithSeasonality

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
getset

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.

◆ description

string AnalyzeRe.APITypes.IStoredAPIResource.description
getset

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
getset

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
getset

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.


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