LUSID C# SDK
Protected Member Functions | Properties | List of all members
ResponseBase Class Reference

To be extended by Response<T> This class exists to provide a type agnostic response to be used in PollyApiRetryHandler> More...

Inheritance diagram for ResponseBase:
Inheritance graph
[legend]

Protected Member Functions

 ResponseBase ()
 
 ResponseBase (Request request)
 

Properties

RequestRequest [get, set]
 The request that was made to get this response More...
 
string? Content [get, set]
 String representation of response content More...
 
HttpStatusCode StatusCode [get, set]
 HTTP response status code More...
 
bool IsSuccessStatusCode [get, set]
 Whether the HTTP response status code indicates success More...
 
bool IsSuccessful [get]
 Whether the HTTP response status code indicates success and no other error occurred (deserialization, timeout, ...) More...
 
string? StatusDescription [get, set]
 Description of HTTP status returned More...
 
byte?[] RawBytes [get, set]
 Response content More...
 
IReadOnlyCollection< HeaderHeaders = new List<Header>() [get, set]
 Response headers returned by server with the response More...
 
ResponseStatus ResponseStatus = ResponseStatus.None [get, set]
 Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead More...
 
string? ErrorMessage [get, set]
 Transport or another non-HTTP error generated while attempting request More...
 
Exception? ErrorException [get, set]
 The exception thrown during the request, if any More...
 

Detailed Description

To be extended by Response<T> This class exists to provide a type agnostic response to be used in PollyApiRetryHandler>

Property Documentation

◆ Content

string? ResponseBase.Content
getset

String representation of response content

◆ ErrorException

Exception? ResponseBase.ErrorException
getset

The exception thrown during the request, if any

◆ ErrorMessage

string? ResponseBase.ErrorMessage
getset

Transport or another non-HTTP error generated while attempting request

◆ Headers

IReadOnlyCollection<Header> ResponseBase.Headers = new List<Header>()
getset

Response headers returned by server with the response

◆ IsSuccessful

bool ResponseBase.IsSuccessful
get

Whether the HTTP response status code indicates success and no other error occurred (deserialization, timeout, ...)

◆ IsSuccessStatusCode

bool ResponseBase.IsSuccessStatusCode
getset

Whether the HTTP response status code indicates success

◆ RawBytes

byte? [] ResponseBase.RawBytes
getset

Response content

◆ Request

Request? ResponseBase.Request
getset

The request that was made to get this response

Mainly for debugging if ResponseStatus is not OK

◆ ResponseStatus

ResponseStatus ResponseBase.ResponseStatus = ResponseStatus.None
getset

Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead

◆ StatusCode

HttpStatusCode ResponseBase.StatusCode
getset

HTTP response status code

◆ StatusDescription

string? ResponseBase.StatusDescription
getset

Description of HTTP status returned


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