Class LowLevelHttpNamespace

Http APIs.

Not intended to be instantiated directly. Use the Http property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelHttpNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.HttpApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelHttpNamespace : NamespacedClientProxy

Methods

DeleteAsync<TResponse>(FormattableString, HttpDeleteRequestParameters, CancellationToken)

Declaration

public Task<TResponse> DeleteAsync<TResponse>(FormattableString path, HttpDeleteRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
HttpDeleteRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

DeleteAsync<TResponse>(string, HttpDeleteRequestParameters, CancellationToken)

Declaration

public Task<TResponse> DeleteAsync<TResponse>(string path, HttpDeleteRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
HttpDeleteRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Delete<TResponse>(FormattableString, HttpDeleteRequestParameters)

Declaration

public TResponse Delete<TResponse>(FormattableString path, HttpDeleteRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
HttpDeleteRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Delete<TResponse>(string, HttpDeleteRequestParameters)

Declaration

public TResponse Delete<TResponse>(string path, HttpDeleteRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
HttpDeleteRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAsync<TResponse>(FormattableString, HttpGetRequestParameters, CancellationToken)

Declaration

public Task<TResponse> GetAsync<TResponse>(FormattableString path, HttpGetRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
HttpGetRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

GetAsync<TResponse>(string, HttpGetRequestParameters, CancellationToken)

Declaration

public Task<TResponse> GetAsync<TResponse>(string path, HttpGetRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
HttpGetRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Get<TResponse>(FormattableString, HttpGetRequestParameters)

Declaration

public TResponse Get<TResponse>(FormattableString path, HttpGetRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
HttpGetRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Get<TResponse>(string, HttpGetRequestParameters)

Declaration

public TResponse Get<TResponse>(string path, HttpGetRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
HttpGetRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

HeadAsync<TResponse>(FormattableString, HttpHeadRequestParameters, CancellationToken)

Declaration

public Task<TResponse> HeadAsync<TResponse>(FormattableString path, HttpHeadRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
HttpHeadRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

HeadAsync<TResponse>(string, HttpHeadRequestParameters, CancellationToken)

Declaration

public Task<TResponse> HeadAsync<TResponse>(string path, HttpHeadRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
HttpHeadRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Head<TResponse>(FormattableString, HttpHeadRequestParameters)

Declaration

public TResponse Head<TResponse>(FormattableString path, HttpHeadRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
HttpHeadRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Head<TResponse>(string, HttpHeadRequestParameters)

Declaration

public TResponse Head<TResponse>(string path, HttpHeadRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
HttpHeadRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PatchAsync<TResponse>(FormattableString, PostData, HttpPatchRequestParameters, CancellationToken)

Declaration

public Task<TResponse> PatchAsync<TResponse>(FormattableString path, PostData body = null, HttpPatchRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
PostData	body
HttpPatchRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PatchAsync<TResponse>(string, PostData, HttpPatchRequestParameters, CancellationToken)

Declaration

public Task<TResponse> PatchAsync<TResponse>(string path, PostData body = null, HttpPatchRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
PostData	body
HttpPatchRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Patch<TResponse>(FormattableString, PostData, HttpPatchRequestParameters)

Declaration

public TResponse Patch<TResponse>(FormattableString path, PostData body = null, HttpPatchRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
PostData	body
HttpPatchRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Patch<TResponse>(string, PostData, HttpPatchRequestParameters)

Declaration

public TResponse Patch<TResponse>(string path, PostData body = null, HttpPatchRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
PostData	body
HttpPatchRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PostAsync<TResponse>(FormattableString, PostData, HttpPostRequestParameters, CancellationToken)

Declaration

public Task<TResponse> PostAsync<TResponse>(FormattableString path, PostData body = null, HttpPostRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
PostData	body
HttpPostRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PostAsync<TResponse>(string, PostData, HttpPostRequestParameters, CancellationToken)

Declaration

public Task<TResponse> PostAsync<TResponse>(string path, PostData body = null, HttpPostRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
PostData	body
HttpPostRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Post<TResponse>(FormattableString, PostData, HttpPostRequestParameters)

Declaration

public TResponse Post<TResponse>(FormattableString path, PostData body = null, HttpPostRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
PostData	body
HttpPostRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Post<TResponse>(string, PostData, HttpPostRequestParameters)

Declaration

public TResponse Post<TResponse>(string path, PostData body = null, HttpPostRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
PostData	body
HttpPostRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

PutAsync<TResponse>(FormattableString, PostData, HttpPutRequestParameters, CancellationToken)

Declaration

public Task<TResponse> PutAsync<TResponse>(FormattableString path, PostData body = null, HttpPutRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
PostData	body
HttpPutRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

PutAsync<TResponse>(string, PostData, HttpPutRequestParameters, CancellationToken)

Declaration

public Task<TResponse> PutAsync<TResponse>(string path, PostData body = null, HttpPutRequestParameters parameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
PostData	body
HttpPutRequestParameters	parameters
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Put<TResponse>(FormattableString, PostData, HttpPutRequestParameters)

Declaration

public TResponse Put<TResponse>(FormattableString path, PostData body = null, HttpPutRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FormattableString	path
PostData	body
HttpPutRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Put<TResponse>(string, PostData, HttpPutRequestParameters)

Declaration

public TResponse Put<TResponse>(string path, PostData body = null, HttpPutRequestParameters parameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	path
PostData	body
HttpPutRequestParameters	parameters

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Extension Methods

SuffixExtensions.Suffix(object, string)