Class RequestConfiguration

Inheritance

object

RequestConfiguration

Implements

IRequestConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class RequestConfiguration : IRequestConfiguration

Properties

Accept

Force a different Accept header on the request

Declaration

public string Accept { get; set; }

Property Value

Type	Description
string

AllowedStatusCodes

Treat the following statuses (on top of the 200 range) NOT as error.

Declaration

public IReadOnlyCollection<int> AllowedStatusCodes { get; set; }

Property Value

Type	Description
IReadOnlyCollection<int>

ApiKeyAuthenticationCredentials

An API-key authorization credentials to specify with this request. Overrides any credentials that are set at the global IConnectionSettings level.

Declaration

public ApiKeyAuthenticationCredentials ApiKeyAuthenticationCredentials { get; set; }

Property Value

Type	Description
ApiKeyAuthenticationCredentials

Remarks

Cannot be used in conjunction with BasicAuthenticationCredentials

BasicAuthenticationCredentials

Basic access authorization credentials to specify with this request. Overrides any credentials that are set at the global IConnectionSettings level.

Declaration

public BasicAuthenticationCredentials BasicAuthenticationCredentials { get; set; }

Property Value

Type	Description
BasicAuthenticationCredentials

Remarks

Cannot be used in conjunction with ApiKeyAuthenticationCredentials

ClientCertificates

Use the following client certificates to authenticate this single request

Declaration

public X509CertificateCollection ClientCertificates { get; set; }

Property Value

Type	Description
X509CertificateCollection

ContentType

Force a different Content-Type header on the request

Declaration

public string ContentType { get; set; }

Property Value

Type	Description
string

DisableDirectStreaming

Whether to buffer the request and response bytes for the call

Declaration

public bool? DisableDirectStreaming { get; set; }

Property Value

Type	Description
bool?

DisablePing

Under no circumstance do a ping before the actual call. If a node was previously dead a small ping with low connect timeout will be tried first in normal circumstances

Declaration

public bool? DisablePing { get; set; }

Property Value

Type	Description
bool?

DisableSniff

Forces no sniffing to occur on the request no matter what configuration is in place globally

Declaration

public bool? DisableSniff { get; set; }

Property Value

Type	Description
bool?

EnableHttpPipelining

Whether or not this request should be pipelined. http://en.wikipedia.org/wiki/HTTP_pipelining defaults to true

Declaration

public bool? EnableHttpPipelining { get; set; }

Property Value

Type	Description
bool?

EnableTcpStats

Enable statistics about TCP connections to be collected when making a request

Declaration

public bool? EnableTcpStats { get; set; }

Property Value

Type	Description
bool?

EnableThreadPoolStats

Enable statistics about thread pools to be collected when making a request

Declaration

public bool? EnableThreadPoolStats { get; set; }

Property Value

Type	Description
bool?

ForceNode

This will force the operation on the specified node, this will bypass any configured connection pool and will no retry.

Declaration

public Uri ForceNode { get; set; }

Property Value

Type	Description
Uri

Headers

Try to send these headers for this single request

Declaration

public NameValueCollection Headers { get; set; }

Property Value

Type	Description
NameValueCollection

MaxRetries

This will override whatever is set on the connection configuration or whatever default the connectionpool has.

Declaration

public int? MaxRetries { get; set; }

Property Value

Type	Description
int?

OpaqueId

Associate an Id with this user-initiated task, such that it can be located in the cluster task list.

Declaration

public string OpaqueId { get; set; }

Property Value

Type	Description
string

PingTimeout

The ping timeout for this specific request

Declaration

public TimeSpan? PingTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

RequestMetaData

Holds additional meta data about the request.

Declaration

public RequestMetaData RequestMetaData { get; set; }

Property Value

Type	Description
RequestMetaData

RequestTimeout

The timeout for this specific request, takes precedence over the global timeout settings

Declaration

public TimeSpan? RequestTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

RunAs

Submit the request on behalf in the context of a different shield user

Declaration

public string RunAs { get; set; }

Property Value

Type	Description
string

ThrowExceptions

Instead of following a c/go like error checking on response.IsValid do throw an exception (except when SuccessOrKnownError is false) on the client when a call resulted in an exception on either the client or the OpenSearch server.

Reasons for such exceptions could be search parser errors, index missing exceptions, etc...

Declaration

public bool? ThrowExceptions { get; set; }

Property Value

Type	Description
bool?

TransferEncodingChunked

Whether the request should be sent with chunked Transfer-Encoding.

Declaration

public bool? TransferEncodingChunked { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestConfiguration

Extension Methods

SuffixExtensions.Suffix(object, string)