Class OpenSearchResponseBase

A response from OpenSearch including details about the request/response life cycle

Inheritance
object
OpenSearchResponseBase
OpenSearchResponse<T>
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public abstract class OpenSearchResponseBase : IApiCallDetails, IOpenSearchResponse

Properties

| Edit this page View Source

ApiCall

Sets and returns the IApiCallDetails diagnostic information

Declaration
public IApiCallDetails ApiCall { get; set; }
Property Value
Type Description
IApiCallDetails
| Edit this page View Source

AuditTrail

An audit trail of requests made to nodes within the cluster

Declaration
public List<Audit> AuditTrail { get; set; }
Property Value
Type Description
List<Audit>
| Edit this page View Source

ConnectionConfiguration

Reference to the connection configuration that yielded this response

Declaration
public IConnectionConfigurationValues ConnectionConfiguration { get; }
Property Value
Type Description
IConnectionConfigurationValues
| Edit this page View Source

DebugInformation

A human readable string representation of what happened during this request for both successful and failed requests.

Declaration
public string DebugInformation { get; }
Property Value
Type Description
string
| Edit this page View Source

DeprecationWarnings

A collection of deprecation warnings returned from OpenSearch.

Used to signal that the request uses an API feature that is marked as deprecated

Declaration
public IEnumerable<string> DeprecationWarnings { get; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

HttpMethod

The HTTP method used by the request

Declaration
public HttpMethod HttpMethod { get; }
Property Value
Type Description
HttpMethod
| Edit this page View Source

HttpStatusCode

The HTTP status code as returned by OpenSearch

Declaration
public int? HttpStatusCode { get; }
Property Value
Type Description
int?
| Edit this page View Source

OriginalException

If Success is false, this will hold the original exception. This will be the originating CLR exception in most cases.

Declaration
public Exception OriginalException { get; }
Property Value
Type Description
Exception
| Edit this page View Source

RequestBodyInBytes

The request body bytes.

NOTE: Only set when disable direct streaming is set for the request

Declaration
public byte[] RequestBodyInBytes { get; }
Property Value
Type Description
byte[]
| Edit this page View Source

ResponseBodyInBytes

The response body bytes.

NOTE: Only set when disable direct streaming is set for the request

Declaration
public byte[] ResponseBodyInBytes { get; }
Property Value
Type Description
byte[]
| Edit this page View Source

ResponseMimeType

The response MIME type

Declaration
public string ResponseMimeType { get; }
Property Value
Type Description
string
| Edit this page View Source

Success

The response status code is in the 200 range or is in the allowed list of status codes set on the request.

Declaration
public bool Success { get; }
Property Value
Type Description
bool
| Edit this page View Source

SuccessOrKnownError

The response is successful or has a response code between 400-599, the call should not be retried. Only on 502,503 and 504 will this return false;

Declaration
public bool SuccessOrKnownError { get; }
Property Value
Type Description
bool
| Edit this page View Source

TcpStats

Active TCP connection statistics collected when making a request

Declaration
public ReadOnlyDictionary<TcpState, int> TcpStats { get; set; }
Property Value
Type Description
ReadOnlyDictionary<TcpState, int>
| Edit this page View Source

ThreadPoolStats

Thread pool thread statistics collected when making a request

Declaration
public ReadOnlyDictionary<string, ThreadPoolStatistics> ThreadPoolStats { get; set; }
Property Value
Type Description
ReadOnlyDictionary<string, ThreadPoolStatistics>
| Edit this page View Source

Uri

The url as requested

Declaration
public Uri Uri { get; }
Property Value
Type Description
Uri

Methods

| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
| Edit this page View Source

TryGetServerError(out ServerError)

Declaration
public virtual bool TryGetServerError(out ServerError serverError)
Parameters
Type Name Description
ServerError serverError
Returns
Type Description
bool
| Edit this page View Source

TryGetServerErrorReason(out string)

Declaration
protected virtual bool TryGetServerErrorReason(out string reason)
Parameters
Type Name Description
string reason
Returns
Type Description
bool

Implements

Extension Methods