AnalyzeRe.APITypes.DataSubResource Class Reference

Describes an additional data sub-resource available off a resource. Endpoint supports GET and PUT. More...

Public Member Functions
	DataSubResource (IEndpoint owner, string relativePath)
	Defines a new data sub-resource 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.

Protected Attributes
string	PUT_ContentType = "application/octet-stream"
	The contentType to set when submitting this resource's body in a PUT request.

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

Detailed Description

Describes an additional data sub-resource available off a resource. Endpoint supports GET and PUT.

TODO: The PUT method appears to have been deprecated. Can this class be removed?

Definition at line 6 of file DataSubResource.cs.

Inheritance diagram for AnalyzeRe.APITypes.DataSubResource:

Constructor & Destructor Documentation

DataSubResource()

AnalyzeRe.APITypes.DataSubResource.DataSubResource ( IEndpoint  owner, string  relativePath  )

inline

Defines a new data sub-resource off of some other endpoint.

Parameters

owner	The endpoint which owns this data sub-resource.
relativePath	The relative path to the data endpoint from its owner.

Definition at line 17 of file DataSubResource.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

consumeStream	The action that will consume the response stream.
parameters	Any additional parameters to include in the request.
timeout	Optional - 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

APIRequestException

If 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.

Member Data Documentation

PUT_ContentType

string AnalyzeRe.APITypes.DataSubResource.PUT_ContentType = "application/octet-stream"

protected

The contentType to set when submitting this resource's body in a PUT request.

Definition at line 10 of file DataSubResource.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:

• DataSubResource.cs