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

A pass-through to the ylt endpoint for configuring and downloading a per-trial simulation result from the analytics engine. More...

Public Member Functions

 YLTSimulationResult (IAPIResourceView owner)
 Defines a new YLT SimulationResult.
 
string Get (T options=null, bool blocking=true, int? timeout=null, IEnumerable< Parameter > requestParameters=null)
 Performs a GET for this simulation result and returns the response as string.
 
IRestResponse GetStream (Action< Stream > consumeStream, T options=null, bool blocking=true, int? timeout=null, IEnumerable< Parameter > requestParameters=null)
 Performs a GET for this simulation result and streams the result to the specified handler, rather than loading the whole response into memory.
 
IRestResponse Head (T options=null, int? timeout=null, IEnumerable< Parameter > requestParameters=null)
 Perform a HEAD request for this simulation result. This can be used to determine whether the result is ready (and what the response content length will be).
 

Properties

override MetricsOptions DefaultOptions [get]
 

Detailed Description

A pass-through to the ylt endpoint for configuring and downloading a per-trial simulation result from the analytics engine.

Definition at line 7 of file YLTSimulationResult.cs.

Inheritance diagram for AnalyzeRe.APIResourceView.YLTSimulationResult:
AnalyzeRe.APIResourceView.SimulationResult< MetricsOptions >

Constructor & Destructor Documentation

◆ YLTSimulationResult()

AnalyzeRe.APIResourceView.YLTSimulationResult.YLTSimulationResult ( IAPIResourceView  owner)
inline

Defines a new YLT SimulationResult.

Parameters
ownerThe resource which owns this ylt sub-resource.

Definition at line 14 of file YLTSimulationResult.cs.

Member Function Documentation

◆ Get()

string AnalyzeRe.APIResourceView.SimulationResult< T >.Get ( T  options = null,
bool  blocking = true,
int timeout = null,
IEnumerable< Parameter requestParameters = null 
)
inlineinherited

Performs a GET for this simulation result and returns the response as string.

Parameters
optionsA set of request options which can be used to produce a distribution net of various filters, loss perspectives, etc.
blocking(Optional - Default: true) Specifies whether the the thread should wait until the result is ready before returning. If set to true, automatically retries using PollingOptions.Default settings.
timeout(Optional) The timeout before the request fails. By default, the request will never timeout.

// TODO: This is inconsistent with the rest of the API

Parameters
requestParameters(Optional) Additional parameters to include in the request.
Returns
The data previously uploaded to this endpoint.
Exceptions
APIRequestExceptionIf there was an error, or if blocking was set to false and the results are not yet available.
NotWaitingExceptionIf blocking is set to true, but specified timeout has been exceeded and the results are not yet available.

Definition at line 38 of file SimulationResult.cs.

◆ GetStream()

IRestResponse AnalyzeRe.APIResourceView.SimulationResult< T >.GetStream ( Action< Stream consumeStream,
T  options = null,
bool  blocking = true,
int timeout = null,
IEnumerable< Parameter requestParameters = null 
)
inlineinherited

Performs a GET for this simulation result and streams the result to the specified handler, rather than loading the whole response into memory.

Parameters
consumeStreamThe action that will consume the response stream.
optionsA set of request options which can be used to produce a distribution net of various filters, loss perspectives, etc.
blocking(Optional - Default: true) Specifies whether the the thread should wait until the result is ready before returning. If set to true, automatically retries using PollingOptions.Default settings.
timeout(Optional) The timeout before the request fails. By default, the request will never timeout.

// TODO: This is inconsistent with the rest of the API

Parameters
requestParameters(Optional) Additional parameters to include in the request.
Returns
The IRestResponse returned after executing the request. This response object contains all the details about the request (whether it was successful or not) except for the raw data, which is handled by the user-supplied stream action.

The consumeStream action will always be invoked and handed the response body, even if the response status was an error. Your consumeStream action should be able to handle scenarios where the message body is an error message or otherwise contains unexpected content.

Exceptions
APIRequestExceptionIf there was an error, or if blocking was set to false and the results are not yet available.
NotWaitingExceptionIf blocking is set to true, but specified timeout has been exceeded and the results are not yet available.

Definition at line 71 of file SimulationResult.cs.

◆ Head()

IRestResponse AnalyzeRe.APIResourceView.SimulationResult< T >.Head ( T  options = null,
int timeout = null,
IEnumerable< Parameter requestParameters = null 
)
inlineinherited

Perform a HEAD request for this simulation result. This can be used to determine whether the result is ready (and what the response content length will be).

Parameters
optionsA set of request options which can be used to produce a distribution net of various filters, loss perspectives, etc.
timeout(Optional) The timeout before the request fails.
requestParameters(Optional) Additional parameters to include in the request.
Returns
The IRestResponse from the server.

Definition at line 92 of file SimulationResult.cs.

Property Documentation

◆ DefaultOptions

override MetricsOptions AnalyzeRe.APIResourceView.YLTSimulationResult.DefaultOptions
getprotected

Definition at line 10 of file YLTSimulationResult.cs.


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