C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.ExchangeRates.ExchangeRateTable Class Reference

A table containing exchange rate information. More...

Classes

class  CurrenciesEndpointResponse
 An object representation of the ExchangeRateTable.currencies endpoint response. More...
 

Public Member Functions

HashSet< stringGetUniqueCurrencies ()
 Uses the currencies endpoint to return a list of unique currencies present in the exchange rate table.
 
virtual T ShallowCopy< T > ()
 Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

 

Static Public Attributes

static readonly string CLASS_COLLECTION_NAME = "exchange_rate_tables"
 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

string base_currency [get, set]
 The currency that all exchange rates in the table convert to.
 
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.
 
SubResource< CurrenciesEndpointResponsecurrencies [get]
 An endpoint from which the user can retrieve information about the unique currencies in this exchange rate table (once processed).
 
LargeDataSubResource data [get]
 An endpoint for accessing or modifying the data file attached to this resource. Also contains a LargeDataSubResource.status endpoint for retrieving information about the upload progress (such as the current AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress).
 
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, 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.
 
string Path [get]
 The relative path to this endpoint from the root URL.
 
double progress [get, set]
 Obsolete - Maintained for backwards-compatibility purposes. This was meant to display the progress in processing this Exchange Rate Table's associated data, but is is not currencly part of the server model. This resource's APIResource_WithDataEndpoint.data endpoint does, however, have a LargeDataSubResource.status endpoint that reports the LargeDataUpload.StatusResponse.commit_progress.
 
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.
 

Detailed Description

A table containing exchange rate information.

Definition at line 12 of file ExchangeRateTable.cs.

Inheritance diagram for AnalyzeRe.ExchangeRates.ExchangeRateTable:
AnalyzeRe.APITypes.APIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource_WithStatus AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint AnalyzeRe.APITypes.StoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APITypes.IStoredAPIResource_WithStatus AnalyzeRe.APIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APITypes.IStoredAPIResource AnalyzeRe.APIType AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.IAPIResource AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.APITypes.IEndpoint AnalyzeRe.IAPIType AnalyzeRe.IAPIType

Member Function Documentation

◆ AfterMembersCloned()

override void AnalyzeRe.APITypes.APIResource_WithDataEndpoint.AfterMembersCloned ( APIType  _)
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 33 of file APIResource_WithDataEndpoint.cs.

◆ GetUniqueCurrencies()

HashSet< string > AnalyzeRe.ExchangeRates.ExchangeRateTable.GetUniqueCurrencies ( )

Uses the currencies endpoint to return a list of unique currencies present in the exchange rate table.

◆ ShallowCopy< T >()

virtual T AnalyzeRe.APIType.ShallowCopy< T > ( )
inlinevirtualinherited

Create a shallow copy of this object.

See also
ExtensionMethods.DeepCopy<T>

for a serializer-based copy method.

Returns
A shallow copy of this object.

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.

Type Constraints
T :IAPIType 

Definition at line 14 of file APIType.cs.

Member Data Documentation

◆ CLASS_COLLECTION_NAME

readonly string AnalyzeRe.ExchangeRates.ExchangeRateTable.CLASS_COLLECTION_NAME = "exchange_rate_tables"
static

The collection endpoint at which resources of this type reside on the server.

Definition at line 16 of file ExchangeRateTable.cs.

Property Documentation

◆ base_currency

string AnalyzeRe.ExchangeRates.ExchangeRateTable.base_currency
getset

The currency that all exchange rates in the table convert to.

Definition at line 37 of file ExchangeRateTable.cs.

◆ collection_name

override string AnalyzeRe.ExchangeRates.ExchangeRateTable.collection_name
get

The collection endpoint at which resources of this type reside on the server.

Implements AnalyzeRe.IAPIResource.

Definition at line 19 of file ExchangeRateTable.cs.

◆ created

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

◆ currencies

SubResource<CurrenciesEndpointResponse> AnalyzeRe.ExchangeRates.ExchangeRateTable.currencies
get

An endpoint from which the user can retrieve information about the unique currencies in this exchange rate table (once processed).

Definition at line 42 of file ExchangeRateTable.cs.

◆ data

LargeDataSubResource AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data
getinherited

An endpoint for accessing or modifying the data file attached to this resource. Also contains a LargeDataSubResource.status endpoint for retrieving information about the upload progress (such as the current AnalyzeRe.LargeDataUpload.StatusResponse.commit_progress).

Implements AnalyzeRe.APITypes.IAPIResource_WithDataEndpoint.

Definition at line 19 of file APIResource_WithDataEndpoint.cs.

◆ data_file

IReference<DataFile> AnalyzeRe.APITypes.APIResource_WithDataEndpoint.data_file
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 30 of file APIResource_WithDataEndpoint.cs.

◆ description

string AnalyzeRe.APITypes.StoredAPIResource.description
getsetinherited

A user-friendly description of the resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 14 of file StoredAPIResource.cs.

◆ id

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

◆ meta_data

Dictionary<string, object> AnalyzeRe.APITypes.StoredAPIResource.meta_data = new Dictionary<string, object>()
getsetinherited

Any user-defined metadata for this layer.

Implements AnalyzeRe.APITypes.IStoredAPIResource.

Definition at line 30 of file StoredAPIResource.cs.

◆ modified

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

◆ Path

string AnalyzeRe.APIResource.Path
getinherited

The relative path to this endpoint from the root URL.

The relative path to this endpoint from the root URL.

Exceptions
System.ArgumentExceptionIf this resource does not have an id.

Implements AnalyzeRe.APITypes.IEndpoint.

Definition at line 27 of file APIResource.cs.

◆ progress

double AnalyzeRe.ExchangeRates.ExchangeRateTable.progress
getset

Obsolete - Maintained for backwards-compatibility purposes. This was meant to display the progress in processing this Exchange Rate Table's associated data, but is is not currencly part of the server model. This resource's APIResource_WithDataEndpoint.data endpoint does, however, have a LargeDataSubResource.status endpoint that reports the LargeDataUpload.StatusResponse.commit_progress.

Definition at line 29 of file ExchangeRateTable.cs.

◆ status

TaskStatus AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status
getsetinherited

Status of the data file associated with this resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.

Definition at line 16 of file StoredAPIResource_WithStatus.cs.

◆ status_message

string AnalyzeRe.APITypes.StoredAPIResource_WithStatus.status_message
getsetinherited

Status message of the data file associated with this resource.

Implements AnalyzeRe.APITypes.IStoredAPIResource_WithStatus.

Definition at line 21 of file StoredAPIResource_WithStatus.cs.


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