Interface IHttpNamespace

Http APIs.

Use the Http property on IOpenSearchClient.

Namespace: OpenSearch.Client.Specification.HttpApi
Assembly: OpenSearch.Client.dll
Syntax
public interface IHttpNamespace

Methods

| Edit this page View Source

DeleteAsync<TResponse>(IHttpDeleteRequest, CancellationToken)

Declaration
Task<TResponse> DeleteAsync<TResponse>(IHttpDeleteRequest request, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpDeleteRequest request
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

DeleteAsync<TResponse>(string, Func<HttpDeleteDescriptor, IHttpDeleteRequest>, CancellationToken)

Declaration
Task<TResponse> DeleteAsync<TResponse>(string path, Func<HttpDeleteDescriptor, IHttpDeleteRequest> selector = null, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpDeleteDescriptor, IHttpDeleteRequest> selector
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

Delete<TResponse>(IHttpDeleteRequest)

Declaration
TResponse Delete<TResponse>(IHttpDeleteRequest request) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpDeleteRequest request
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

Delete<TResponse>(string, Func<HttpDeleteDescriptor, IHttpDeleteRequest>)

Declaration
TResponse Delete<TResponse>(string path, Func<HttpDeleteDescriptor, IHttpDeleteRequest> selector = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpDeleteDescriptor, IHttpDeleteRequest> selector
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

GetAsync<TResponse>(IHttpGetRequest, CancellationToken)

Declaration
Task<TResponse> GetAsync<TResponse>(IHttpGetRequest request, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpGetRequest request
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

GetAsync<TResponse>(string, Func<HttpGetDescriptor, IHttpGetRequest>, CancellationToken)

Declaration
Task<TResponse> GetAsync<TResponse>(string path, Func<HttpGetDescriptor, IHttpGetRequest> selector = null, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpGetDescriptor, IHttpGetRequest> selector
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

Get<TResponse>(IHttpGetRequest)

Declaration
TResponse Get<TResponse>(IHttpGetRequest request) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpGetRequest request
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

Get<TResponse>(string, Func<HttpGetDescriptor, IHttpGetRequest>)

Declaration
TResponse Get<TResponse>(string path, Func<HttpGetDescriptor, IHttpGetRequest> selector = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpGetDescriptor, IHttpGetRequest> selector
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

HeadAsync<TResponse>(IHttpHeadRequest, CancellationToken)

Declaration
Task<TResponse> HeadAsync<TResponse>(IHttpHeadRequest request, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpHeadRequest request
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

HeadAsync<TResponse>(string, Func<HttpHeadDescriptor, IHttpHeadRequest>, CancellationToken)

Declaration
Task<TResponse> HeadAsync<TResponse>(string path, Func<HttpHeadDescriptor, IHttpHeadRequest> selector = null, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpHeadDescriptor, IHttpHeadRequest> selector
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

Head<TResponse>(IHttpHeadRequest)

Declaration
TResponse Head<TResponse>(IHttpHeadRequest request) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpHeadRequest request
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

Head<TResponse>(string, Func<HttpHeadDescriptor, IHttpHeadRequest>)

Declaration
TResponse Head<TResponse>(string path, Func<HttpHeadDescriptor, IHttpHeadRequest> selector = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpHeadDescriptor, IHttpHeadRequest> selector
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

PatchAsync<TResponse>(IHttpPatchRequest, CancellationToken)

Declaration
Task<TResponse> PatchAsync<TResponse>(IHttpPatchRequest request, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpPatchRequest request
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

PatchAsync<TResponse>(string, Func<HttpPatchDescriptor, IHttpPatchRequest>, CancellationToken)

Declaration
Task<TResponse> PatchAsync<TResponse>(string path, Func<HttpPatchDescriptor, IHttpPatchRequest> selector = null, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpPatchDescriptor, IHttpPatchRequest> selector
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

Patch<TResponse>(IHttpPatchRequest)

Declaration
TResponse Patch<TResponse>(IHttpPatchRequest request) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpPatchRequest request
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

Patch<TResponse>(string, Func<HttpPatchDescriptor, IHttpPatchRequest>)

Declaration
TResponse Patch<TResponse>(string path, Func<HttpPatchDescriptor, IHttpPatchRequest> selector = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpPatchDescriptor, IHttpPatchRequest> selector
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

PostAsync<TResponse>(IHttpPostRequest, CancellationToken)

Declaration
Task<TResponse> PostAsync<TResponse>(IHttpPostRequest request, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpPostRequest request
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

PostAsync<TResponse>(string, Func<HttpPostDescriptor, IHttpPostRequest>, CancellationToken)

Declaration
Task<TResponse> PostAsync<TResponse>(string path, Func<HttpPostDescriptor, IHttpPostRequest> selector = null, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpPostDescriptor, IHttpPostRequest> selector
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

Post<TResponse>(IHttpPostRequest)

Declaration
TResponse Post<TResponse>(IHttpPostRequest request) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpPostRequest request
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

Post<TResponse>(string, Func<HttpPostDescriptor, IHttpPostRequest>)

Declaration
TResponse Post<TResponse>(string path, Func<HttpPostDescriptor, IHttpPostRequest> selector = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpPostDescriptor, IHttpPostRequest> selector
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

PutAsync<TResponse>(IHttpPutRequest, CancellationToken)

Declaration
Task<TResponse> PutAsync<TResponse>(IHttpPutRequest request, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpPutRequest request
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

PutAsync<TResponse>(string, Func<HttpPutDescriptor, IHttpPutRequest>, CancellationToken)

Declaration
Task<TResponse> PutAsync<TResponse>(string path, Func<HttpPutDescriptor, IHttpPutRequest> selector = null, CancellationToken ct = default) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpPutDescriptor, IHttpPutRequest> selector
CancellationToken ct
Returns
Type Description
Task<TResponse>
Type Parameters
Name Description
TResponse
| Edit this page View Source

Put<TResponse>(IHttpPutRequest)

Declaration
TResponse Put<TResponse>(IHttpPutRequest request) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
IHttpPutRequest request
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse
| Edit this page View Source

Put<TResponse>(string, Func<HttpPutDescriptor, IHttpPutRequest>)

Declaration
TResponse Put<TResponse>(string path, Func<HttpPutDescriptor, IHttpPutRequest> selector = null) where TResponse : class, IOpenSearchResponse, new()
Parameters
Type Name Description
string path
Func<HttpPutDescriptor, IHttpPutRequest> selector
Returns
Type Description
TResponse
Type Parameters
Name Description
TResponse

Extension Methods