Table of Contents

Class ApiCallDetails

Namespace
Elasticsearch.Net
Assembly
Elasticsearch.Net.dll
public class ApiCallDetails : IApiCallDetails
Inheritance
ApiCallDetails
Implements
Inherited Members

Constructors

ApiCallDetails() 

public ApiCallDetails()

Properties

AuditTrail

An audit trail of requests made to nodes within the cluster

public List<Audit> AuditTrail { get; set; }

Property Value

List<Audit>

DebugInformation

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

public string DebugInformation { get; }

Property Value

string

DeprecationWarnings

A collection of deprecation warnings returned from Elasticsearch.

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

public IEnumerable<string> DeprecationWarnings { get; set; }

Property Value

IEnumerable<string>

HttpMethod

The HTTP method used by the request

public HttpMethod HttpMethod { get; set; }

Property Value

HttpMethod

HttpStatusCode

The HTTP status code as returned by Elasticsearch

public int? HttpStatusCode { get; set; }

Property Value

int?

OriginalException

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

public Exception OriginalException { get; set; }

Property Value

Exception

RequestBodyInBytes

The request body bytes.

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

public byte[] RequestBodyInBytes { get; set; }

Property Value

byte[]

ResponseBodyInBytes

The response body bytes.

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

public byte[] ResponseBodyInBytes { get; set; }

Property Value

byte[]

ResponseMimeType

The response mime type

public string ResponseMimeType { get; set; }

Property Value

string

ServerError 

public ServerError ServerError { get; set; }

Property Value

ServerError

Success

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

public bool Success { get; set; }

Property Value

bool

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;

public bool SuccessOrKnownError { get; }

Property Value

bool

Uri

The url as requested

public Uri Uri { get; set; }

Property Value

Uri

Methods

ToString() 

public override string ToString()

Returns

string