Class RequestConfigurationDescriptor

Inheritance
object
RequestConfigurationDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class RequestConfigurationDescriptor : IRequestConfiguration

Constructors

| Edit this page View Source

RequestConfigurationDescriptor(IRequestConfiguration)

Declaration
public RequestConfigurationDescriptor(IRequestConfiguration config)
Parameters
Type Name Description
IRequestConfiguration config

Methods

| Edit this page View Source

Accept(string)

Declaration
public RequestConfigurationDescriptor Accept(string acceptHeader)
Parameters
Type Name Description
string acceptHeader
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

AllowedStatusCodes(IEnumerable<int>)

Declaration
public RequestConfigurationDescriptor AllowedStatusCodes(IEnumerable<int> codes)
Parameters
Type Name Description
IEnumerable<int> codes
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

AllowedStatusCodes(params int[])

Declaration
public RequestConfigurationDescriptor AllowedStatusCodes(params int[] codes)
Parameters
Type Name Description
int[] codes
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ApiKeyAuthentication(SecureString)

Declaration
public RequestConfigurationDescriptor ApiKeyAuthentication(SecureString base64EncodedApiKey)
Parameters
Type Name Description
SecureString base64EncodedApiKey
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ApiKeyAuthentication(string)

Declaration
public RequestConfigurationDescriptor ApiKeyAuthentication(string base64EncodedApiKey)
Parameters
Type Name Description
string base64EncodedApiKey
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ApiKeyAuthentication(string, SecureString)

Declaration
public RequestConfigurationDescriptor ApiKeyAuthentication(string id, SecureString apiKey)
Parameters
Type Name Description
string id
SecureString apiKey
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ApiKeyAuthentication(string, string)

Declaration
public RequestConfigurationDescriptor ApiKeyAuthentication(string id, string apiKey)
Parameters
Type Name Description
string id
string apiKey
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

BasicAuthentication(string, SecureString)

Declaration
public RequestConfigurationDescriptor BasicAuthentication(string userName, SecureString password)
Parameters
Type Name Description
string userName
SecureString password
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

BasicAuthentication(string, string)

Declaration
public RequestConfigurationDescriptor BasicAuthentication(string userName, string password)
Parameters
Type Name Description
string userName
string password
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ClientCertificate(X509Certificate)

Use the following client certificate to authenticate this request to OpenSearch

Declaration
public RequestConfigurationDescriptor ClientCertificate(X509Certificate certificate)
Parameters
Type Name Description
X509Certificate certificate
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ClientCertificate(string)

Use the following client certificate to authenticate this request to OpenSearch

Declaration
public RequestConfigurationDescriptor ClientCertificate(string certificatePath)
Parameters
Type Name Description
string certificatePath
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ClientCertificates(X509CertificateCollection)

Use the following client certificates to authenticate this request to OpenSearch

Declaration
public RequestConfigurationDescriptor ClientCertificates(X509CertificateCollection certificates)
Parameters
Type Name Description
X509CertificateCollection certificates
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ContentType(string)

Declaration
public RequestConfigurationDescriptor ContentType(string contentTypeHeader)
Parameters
Type Name Description
string contentTypeHeader
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

DisableDirectStreaming(bool?)

Declaration
public RequestConfigurationDescriptor DisableDirectStreaming(bool? disable = true)
Parameters
Type Name Description
bool? disable
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

DisablePing(bool?)

Declaration
public RequestConfigurationDescriptor DisablePing(bool? disable = true)
Parameters
Type Name Description
bool? disable
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

DisableSniffing(bool?)

Declaration
public RequestConfigurationDescriptor DisableSniffing(bool? disable = true)
Parameters
Type Name Description
bool? disable
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

EnableHttpPipelining(bool)

Declaration
public RequestConfigurationDescriptor EnableHttpPipelining(bool enable = true)
Parameters
Type Name Description
bool enable
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

EnableTcpStats(bool?)

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

Declaration
public RequestConfigurationDescriptor EnableTcpStats(bool? enableTcpStats = true)
Parameters
Type Name Description
bool? enableTcpStats
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

EnableThreadPoolStats(bool?)

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

Declaration
public RequestConfigurationDescriptor EnableThreadPoolStats(bool? enableThreadPoolStats = true)
Parameters
Type Name Description
bool? enableThreadPoolStats
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

ForceNode(Uri)

Declaration
public RequestConfigurationDescriptor ForceNode(Uri uri)
Parameters
Type Name Description
Uri uri
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

GlobalHeaders(NameValueCollection)

Try to send these headers for this single request

Declaration
public RequestConfigurationDescriptor GlobalHeaders(NameValueCollection headers)
Parameters
Type Name Description
NameValueCollection headers
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

MaxRetries(int)

Declaration
public RequestConfigurationDescriptor MaxRetries(int retry)
Parameters
Type Name Description
int retry
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

OpaqueId(string)

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

Declaration
public RequestConfigurationDescriptor OpaqueId(string opaqueId)
Parameters
Type Name Description
string opaqueId
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

PingTimeout(TimeSpan)

Declaration
public RequestConfigurationDescriptor PingTimeout(TimeSpan pingTimeout)
Parameters
Type Name Description
TimeSpan pingTimeout
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

RequestTimeout(TimeSpan)

Declaration
public RequestConfigurationDescriptor RequestTimeout(TimeSpan requestTimeout)
Parameters
Type Name Description
TimeSpan requestTimeout
Returns
Type Description
RequestConfigurationDescriptor
| Edit this page View Source

RunAs(string)

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




  

  
Declaration

  

    
public RequestConfigurationDescriptor RunAs(string username)

  

  
Parameters

  

    
      

        Type
        Name
        Description
      

    
    
      

        string
        username
        
      

    
  

  
Returns

  

    
      

        Type
        Description
      

    
    
      

        RequestConfigurationDescriptor
        
      

    
  

  
    |
    Edit this page
  
  
    View Source
  
  
  
ThrowExceptions(bool)

  

  

  
Declaration

  

    
public RequestConfigurationDescriptor ThrowExceptions(bool throwExceptions = true)

  

  
Parameters

  

    
      

        Type
        Name
        Description
      

    
    
      

        bool
        throwExceptions
        
      

    
  

  
Returns

  

    
      

        Type
        Description
      

    
    
      

        RequestConfigurationDescriptor
        
      

    
  

  
    |
    Edit this page
  
  
    View Source
  
  
  
TransferEncodingChunked(bool?)

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



  

  
Declaration

  

    
public RequestConfigurationDescriptor TransferEncodingChunked(bool? transferEncodingChunked = true)

  

  
Parameters

  

    
      

        Type
        Name
        Description
      

    
    
      

        bool?
        transferEncodingChunked
        
      

    
  

  
Returns

  

    
      

        Type
        Description
      

    
    
      

        RequestConfigurationDescriptor
        
      

    
  

  
Implements

  
  
Extension Methods