Class RequestDescriptorBase<TDescriptor, TParameters, TInterface>
Base class for all Request descriptor types
Inheritance
RequestDescriptorBase<TDescriptor, TParameters, TInterface>
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public abstract class RequestDescriptorBase<TDescriptor, TParameters, TInterface> : RequestBase<TParameters>, IRequest<TParameters>, IRequest, IDescriptor where TDescriptor : RequestDescriptorBase<TDescriptor, TParameters, TInterface>, TInterface where TParameters : RequestParameters<TParameters>, new()
Type Parameters
| Name |
Description |
| TDescriptor |
|
| TParameters |
|
| TInterface |
|
Constructors
|
Edit this page
View Source
RequestDescriptorBase()
Declaration
protected RequestDescriptorBase()
|
Edit this page
View Source
RequestDescriptorBase(Func<RouteValues, RouteValues>)
Declaration
protected RequestDescriptorBase(Func<RouteValues, RouteValues> pathSelector)
Parameters
Properties
|
Edit this page
View Source
Self
Declaration
protected TInterface Self { get; }
Property Value
| Type |
Description |
| TInterface |
|
Methods
|
Edit this page
View Source
Assign<TValue>(TValue, Action<TInterface, TValue>)
Declaration
protected TDescriptor Assign<TValue>(TValue value, Action<TInterface, TValue> assign)
Parameters
| Type |
Name |
Description |
| TValue |
value |
|
| Action<TInterface, TValue> |
assign |
|
Returns
| Type |
Description |
| TDescriptor |
|
Type Parameters
|
Edit this page
View Source
ErrorTrace(bool?)
Include the stack trace of returned errors.
Declaration
public TDescriptor ErrorTrace(bool? errortrace = true)
Parameters
| Type |
Name |
Description |
| bool? |
errortrace |
|
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
FilterPath(IEnumerable<string>)
A comma-separated list of filters used to reduce the response.
<p>Use of response filtering can result in a response from OpenSearch that cannot be correctly deserialized to the respective response type for the request. In such situations, use the low level client to issue the request and handle response deserialization</p>
Declaration
public TDescriptor FilterPath(IEnumerable<string> filterpath)
Parameters
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
FilterPath(params string[])
A comma-separated list of filters used to reduce the response.
<p>Use of response filtering can result in a response from OpenSearch that cannot be correctly deserialized to the respective response type for the request. In such situations, use the low level client to issue the request and handle response deserialization</p>
Declaration
public TDescriptor FilterPath(params string[] filterpath)
Parameters
| Type |
Name |
Description |
| string[] |
filterpath |
|
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
Human(bool?)
Return human readable values for statistics.
Declaration
public TDescriptor Human(bool? human = true)
Parameters
| Type |
Name |
Description |
| bool? |
human |
|
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
Pretty(bool?)
Pretty format the returned JSON response.
Declaration
public TDescriptor Pretty(bool? pretty = true)
Parameters
| Type |
Name |
Description |
| bool? |
pretty |
|
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
Qs(string, object)
Declaration
protected TDescriptor Qs(string name, object value)
Parameters
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
Specify settings for this request alone, handy if you need a custom timeout or want to bypass sniffing, retries
Declaration
public TDescriptor RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration> configurationSelector)
Parameters
Returns
| Type |
Description |
| TDescriptor |
|
|
Edit this page
View Source
SourceQueryString(string)
The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
Declaration
public TDescriptor SourceQueryString(string sourcequerystring)
Parameters
| Type |
Name |
Description |
| string |
sourcequerystring |
|
Returns
| Type |
Description |
| TDescriptor |
|
Implements
Extension Methods