Class LowLevelQueryNamespace

Query APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelQueryNamespace

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.QueryApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelQueryNamespace : NamespacedClientProxy

Methods

DatasourceDeleteAsync<TResponse>(string, DatasourceDeleteRequestParameters, CancellationToken)

DELETE on /_plugins/_query/_datasources/{datasource_name}

Declaration

public Task<TResponse> DatasourceDeleteAsync<TResponse>(string datasourceName, DatasourceDeleteRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	datasourceName	The name of the data source to delete.
DatasourceDeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourceDelete<TResponse>(string, DatasourceDeleteRequestParameters)

DELETE on /_plugins/_query/_datasources/{datasource_name}

Declaration

public TResponse DatasourceDelete<TResponse>(string datasourceName, DatasourceDeleteRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	datasourceName	The name of the data source to delete.
DatasourceDeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourceRetrieveAsync<TResponse>(string, DatasourceRetrieveRequestParameters, CancellationToken)

GET on /_plugins/_query/_datasources/{datasource_name}

Declaration

public Task<TResponse> DatasourceRetrieveAsync<TResponse>(string datasourceName, DatasourceRetrieveRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	datasourceName	The name of the data source to retrieve.
DatasourceRetrieveRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourceRetrieve<TResponse>(string, DatasourceRetrieveRequestParameters)

GET on /_plugins/_query/_datasources/{datasource_name}

Declaration

public TResponse DatasourceRetrieve<TResponse>(string datasourceName, DatasourceRetrieveRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	datasourceName	The name of the data source to retrieve.
DatasourceRetrieveRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourcesCreateAsync<TResponse>(PostData, DatasourcesCreateRequestParameters, CancellationToken)

POST on /_plugins/_query/_datasources

Declaration

public Task<TResponse> DatasourcesCreateAsync<TResponse>(PostData body, DatasourcesCreateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The data source configuration to create.
DatasourcesCreateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourcesCreate<TResponse>(PostData, DatasourcesCreateRequestParameters)

POST on /_plugins/_query/_datasources

Declaration

public TResponse DatasourcesCreate<TResponse>(PostData body, DatasourcesCreateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The data source configuration to create.
DatasourcesCreateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourcesListAsync<TResponse>(DatasourcesListRequestParameters, CancellationToken)

GET on /_plugins/_query/_datasources

Declaration

public Task<TResponse> DatasourcesListAsync<TResponse>(DatasourcesListRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DatasourcesListRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourcesList<TResponse>(DatasourcesListRequestParameters)

GET on /_plugins/_query/_datasources

Declaration

public TResponse DatasourcesList<TResponse>(DatasourcesListRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DatasourcesListRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourcesUpdateAsync<TResponse>(PostData, DatasourcesUpdateRequestParameters, CancellationToken)

PUT on /_plugins/_query/_datasources

Declaration

public Task<TResponse> DatasourcesUpdateAsync<TResponse>(PostData body, DatasourcesUpdateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The updated data source configuration.
DatasourcesUpdateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

DatasourcesUpdate<TResponse>(PostData, DatasourcesUpdateRequestParameters)

PUT on /_plugins/_query/_datasources

Declaration

public TResponse DatasourcesUpdate<TResponse>(PostData body, DatasourcesUpdateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The updated data source configuration.
DatasourcesUpdateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)