C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeRe.APITypes.SubResourceCollection< T > Class Template Reference

Describes a collection of resources available off another resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support list operations. More...

Public Member Functions

 SubResourceCollection (IEndpoint owner, string relativePath)
 Defines a new collection off of some other endpoint.
 
T Get (IEnumerable< Parameter > parameters=null, int? timeout=null)
 Performs a GET request a at this endpoint.
 
IRestResponse GetStream (Action< Stream > consumeStream, IEnumerable< Parameter > parameters=null, int? timeout=null)
 Perform a GET on the supplied URL and provide an action for consuming the response stream rather than loading the whole response into memory.
 
IRestResponse Head (IEnumerable< Parameter > parameters=null, int? timeout=null)
 Performs a HEAD request at this endpoint.
 

Static Public Member Functions

static implicit operator T (SubResource< T > value)
 Allows implicit conversion of an instance of this class to its expected response return type.
 

Properties

intDefaultTimeout [get, set]
 Can be used to override the API.DefaultRequestTimeout with one that better suits this SubResource.
 

Detailed Description

Describes a collection of resources available off another resource. Allows APIResources to quickly define additional endpoints off their URLs which in turn support list operations.

Template Parameters
TThe type of data residing at this endpoint.
Type Constraints
T :IAPIType 

Definition at line 7 of file SubResourceCollection[T].cs.

Inheritance diagram for AnalyzeRe.APITypes.SubResourceCollection< T >:
AnalyzeRe.APITypes.SubResource< ICollectionResponse< T > > AnalyzeRe.APITypes.IResourceCollection< T >

Constructor & Destructor Documentation

◆ SubResourceCollection()

Defines a new collection off of some other endpoint.

Parameters
ownerThe endpoint which owns this collection.
relativePathThe relative path to this collection from its owner.

Definition at line 14 of file SubResourceCollection[T].cs.

Member Function Documentation

◆ Get()

T AnalyzeRe.APITypes.SubResource< T >.Get ( IEnumerable< Parameter parameters = null,
int timeout = null 
)
inlineinherited

Performs a GET request a at this endpoint.

Parameters
parameters(Optional) Rest parameters to include with the GET request.
timeout(Optional) The timeout before the request fails.
Returns
The data previously uploaded to this endpoint.

Definition at line 51 of file SubResource[T].cs.

◆ GetStream()

IRestResponse AnalyzeRe.APITypes.SubResource< T >.GetStream ( Action< Stream consumeStream,
IEnumerable< Parameter parameters = null,
int timeout = null 
)
inlineinherited

Perform a GET on the supplied URL and provide an action for consuming the response stream rather than loading the whole response into memory.

Warning: 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.

Parameters
consumeStreamThe action that will consume the response stream.
parametersAny additional parameters to include in the request.
timeoutOptional - The desired request response timeout (in milliseconds).
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.
Exceptions
APIRequestExceptionIf the request failed to reach the API.

Definition at line 72 of file SubResource[T].cs.

◆ Head()

IRestResponse AnalyzeRe.APITypes.SubResource< T >.Head ( IEnumerable< Parameter parameters = null,
int timeout = null 
)
inlineinherited

Performs a HEAD request at this endpoint.

Parameters
parameters(Optional) Rest parameters to include with the HEAD request.
timeout(Optional) The timeout before the request fails.
Returns
The response.

Definition at line 40 of file SubResource[T].cs.

◆ operator T()

static implicit AnalyzeRe.APITypes.SubResource< T >.operator T ( SubResource< T value)
inlinestaticinherited

Allows implicit conversion of an instance of this class to its expected response return type.

Definition at line 28 of file SubResource[T].cs.

Property Documentation

◆ DefaultTimeout

int? AnalyzeRe.APITypes.SubResource< T >.DefaultTimeout
getsetinherited

Can be used to override the API.DefaultRequestTimeout with one that better suits this SubResource.

Definition at line 16 of file SubResource[T].cs.


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