Interface IRequestConfiguration

Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public interface IRequestConfiguration

Properties

| Edit this page View Source

Accept

Force a different Accept header on the request

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

AllowedStatusCodes

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

Declaration
IReadOnlyCollection<int> AllowedStatusCodes { get; set; }
Property Value
Type Description
IReadOnlyCollection<int>
| Edit this page View Source

ApiKeyAuthenticationCredentials

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

Declaration
ApiKeyAuthenticationCredentials ApiKeyAuthenticationCredentials { get; set; }
Property Value
Type Description
ApiKeyAuthenticationCredentials
Remarks

Cannot be used in conjunction with BasicAuthenticationCredentials

| Edit this page View Source

BasicAuthenticationCredentials

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

Declaration
BasicAuthenticationCredentials BasicAuthenticationCredentials { get; set; }
Property Value
Type Description
BasicAuthenticationCredentials
Remarks

Cannot be used in conjunction with ApiKeyAuthenticationCredentials

| Edit this page View Source

ClientCertificates

Use the following client certificates to authenticate this single request

Declaration
X509CertificateCollection ClientCertificates { get; set; }
Property Value
Type Description
X509CertificateCollection
| Edit this page View Source

ContentType

Force a different Content-Type header on the request

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

DisableDirectStreaming

Whether to buffer the request and response bytes for the call

Declaration
bool? DisableDirectStreaming { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

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
bool? DisablePing { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

DisableSniff

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

Declaration
bool? DisableSniff { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

EnableHttpPipelining

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

Declaration
bool? EnableHttpPipelining { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

EnableTcpStats

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

Declaration
bool? EnableTcpStats { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

EnableThreadPoolStats

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

Declaration
bool? EnableThreadPoolStats { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

ForceNode

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

Declaration
Uri ForceNode { get; set; }
Property Value
Type Description
Uri
| Edit this page View Source

Headers

Try to send these headers for this single request

Declaration
NameValueCollection Headers { get; set; }
Property Value
Type Description
NameValueCollection
| Edit this page View Source

MaxRetries

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

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

OpaqueId

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

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

PingTimeout

The ping timeout for this specific request

Declaration
TimeSpan? PingTimeout { get; set; }
Property Value
Type Description
TimeSpan?
| Edit this page View Source

RequestMetaData

Holds additional meta data about the request.

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

RequestTimeout

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

Declaration
TimeSpan? RequestTimeout { get; set; }
Property Value
Type Description
TimeSpan?
| Edit this page View Source

RunAs

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




  

  
Declaration

  

    
string RunAs { get; set; }

  

  
Property Value

  

    
      

        Type
        Description
      

    
    
      

        string
        
      

    
  

  
    |
    Edit this page
  
  
    View Source
  
  
  
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

  

    
bool? ThrowExceptions { get; set; }

  

  
Property Value

  

    
      

        Type
        Description
      

    
    
      

        bool?
        
      

    
  

  
    |
    Edit this page
  
  
    View Source
  
  
  
TransferEncodingChunked

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



  

  
Declaration

  

    
bool? TransferEncodingChunked { get; set; }

  

  
Property Value

  

    
      

        Type
        Description
      

    
    
      

        bool?
        
      

    
  

  
Extension Methods