Class LowLevelLtrNamespace

Ltr APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelLtrNamespace

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

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelLtrNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

AddFeaturesToSetAsync<TResponse>(string, PostData, AddFeaturesToSetRequestParameters, CancellationToken)

POST on /_ltr/_featureset/{name}/_addfeatures

Declaration

public Task<TResponse> AddFeaturesToSetAsync<TResponse>(string name, PostData body, AddFeaturesToSetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the feature set to add features to.
PostData	body	The features to add to the feature set.
AddFeaturesToSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSetAsync<TResponse>(string, string, PostData, AddFeaturesToSetRequestParameters, CancellationToken)

POST on /_ltr/{store}/_featureset/{name}/_addfeatures

Declaration

public Task<TResponse> AddFeaturesToSetAsync<TResponse>(string store, string name, PostData body, AddFeaturesToSetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	name	The name of the feature set to add features to.
PostData	body	The features to add to the feature set.
AddFeaturesToSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSetByQueryAsync<TResponse>(string, string, AddFeaturesToSetByQueryRequestParameters, CancellationToken)

POST on /_ltr/_featureset/{name}/_addfeatures/{query}

Declaration

public Task<TResponse> AddFeaturesToSetByQueryAsync<TResponse>(string name, string query, AddFeaturesToSetByQueryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the feature set to add features to.
string	query	Query string to filter existing features from the store by name. When provided, only features matching this query will be added to the feature set, and no request body should be included.
AddFeaturesToSetByQueryRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSetByQueryAsync<TResponse>(string, string, string, AddFeaturesToSetByQueryRequestParameters, CancellationToken)

POST on /_ltr/{store}/_featureset/{name}/_addfeatures/{query}

Declaration

public Task<TResponse> AddFeaturesToSetByQueryAsync<TResponse>(string store, string name, string query, AddFeaturesToSetByQueryRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	name	The name of the feature set to add features to.
string	query	Query string to filter existing features from the store by name. When provided, only features matching this query will be added to the feature set, and no request body should be included.
AddFeaturesToSetByQueryRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSetByQuery<TResponse>(string, string, AddFeaturesToSetByQueryRequestParameters)

POST on /_ltr/_featureset/{name}/_addfeatures/{query}

Declaration

public TResponse AddFeaturesToSetByQuery<TResponse>(string name, string query, AddFeaturesToSetByQueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the feature set to add features to.
string	query	Query string to filter existing features from the store by name. When provided, only features matching this query will be added to the feature set, and no request body should be included.
AddFeaturesToSetByQueryRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSetByQuery<TResponse>(string, string, string, AddFeaturesToSetByQueryRequestParameters)

POST on /_ltr/{store}/_featureset/{name}/_addfeatures/{query}

Declaration

public TResponse AddFeaturesToSetByQuery<TResponse>(string store, string name, string query, AddFeaturesToSetByQueryRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	name	The name of the feature set to add features to.
string	query	Query string to filter existing features from the store by name. When provided, only features matching this query will be added to the feature set, and no request body should be included.
AddFeaturesToSetByQueryRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSet<TResponse>(string, PostData, AddFeaturesToSetRequestParameters)

POST on /_ltr/_featureset/{name}/_addfeatures

Declaration

public TResponse AddFeaturesToSet<TResponse>(string name, PostData body, AddFeaturesToSetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the feature set to add features to.
PostData	body	The features to add to the feature set.
AddFeaturesToSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

AddFeaturesToSet<TResponse>(string, string, PostData, AddFeaturesToSetRequestParameters)

POST on /_ltr/{store}/_featureset/{name}/_addfeatures

Declaration

public TResponse AddFeaturesToSet<TResponse>(string store, string name, PostData body, AddFeaturesToSetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	name	The name of the feature set to add features to.
PostData	body	The features to add to the feature set.
AddFeaturesToSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CacheStatsAsync<TResponse>(CacheStatsRequestParameters, CancellationToken)

GET on /_ltr/_cachestats

Declaration

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

Parameters

Type	Name	Description
CacheStatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

CacheStats<TResponse>(CacheStatsRequestParameters)

GET on /_ltr/_cachestats

Declaration

public TResponse CacheStats<TResponse>(CacheStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CacheStatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

ClearCacheAsync<TResponse>(ClearCacheRequestParameters, CancellationToken)

POST on /_ltr/_clearcache

Declaration

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

Parameters

Type	Name	Description
ClearCacheRequestParameters	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.19.0 or greater.

| Edit this page View Source

ClearCacheAsync<TResponse>(string, ClearCacheRequestParameters, CancellationToken)

POST on /_ltr/{store}/_clearcache

Declaration

public Task<TResponse> ClearCacheAsync<TResponse>(string store, ClearCacheRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store for which to clear the cache.
ClearCacheRequestParameters	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.19.0 or greater.

| Edit this page View Source

ClearCache<TResponse>(ClearCacheRequestParameters)

POST on /_ltr/_clearcache

Declaration

public TResponse ClearCache<TResponse>(ClearCacheRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ClearCacheRequestParameters	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.19.0 or greater.

| Edit this page View Source

ClearCache<TResponse>(string, ClearCacheRequestParameters)

POST on /_ltr/{store}/_clearcache

Declaration

public TResponse ClearCache<TResponse>(string store, ClearCacheRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store for which to clear the cache.
ClearCacheRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateDefaultStoreAsync<TResponse>(CreateDefaultStoreRequestParameters, CancellationToken)

PUT on /_ltr

Declaration

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

Parameters

Type	Name	Description
CreateDefaultStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

CreateDefaultStore<TResponse>(CreateDefaultStoreRequestParameters)

PUT on /_ltr

Declaration

public TResponse CreateDefaultStore<TResponse>(CreateDefaultStoreRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CreateDefaultStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

CreateFeatureAsync<TResponse>(string, PostData, CreateFeatureRequestParameters, CancellationToken)

PUT on /_ltr/_feature/{id}

Declaration

public Task<TResponse> CreateFeatureAsync<TResponse>(string id, PostData body, CreateFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
PostData	body	The feature definition.
CreateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeatureAsync<TResponse>(string, string, PostData, CreateFeatureRequestParameters, CancellationToken)

PUT on /_ltr/{store}/_feature/{id}

Declaration

public Task<TResponse> CreateFeatureAsync<TResponse>(string store, string id, PostData body, CreateFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
PostData	body	The feature definition.
CreateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeature<TResponse>(string, PostData, CreateFeatureRequestParameters)

PUT on /_ltr/_feature/{id}

Declaration

public TResponse CreateFeature<TResponse>(string id, PostData body, CreateFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
PostData	body	The feature definition.
CreateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeature<TResponse>(string, string, PostData, CreateFeatureRequestParameters)

PUT on /_ltr/{store}/_feature/{id}

Declaration

public TResponse CreateFeature<TResponse>(string store, string id, PostData body, CreateFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
PostData	body	The feature definition.
CreateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeaturesetAsync<TResponse>(string, PostData, CreateFeaturesetRequestParameters, CancellationToken)

PUT on /_ltr/_featureset/{id}

Declaration

public Task<TResponse> CreateFeaturesetAsync<TResponse>(string id, PostData body, CreateFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
PostData	body	The feature set definition.
CreateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeaturesetAsync<TResponse>(string, string, PostData, CreateFeaturesetRequestParameters, CancellationToken)

PUT on /_ltr/{store}/_featureset/{id}

Declaration

public Task<TResponse> CreateFeaturesetAsync<TResponse>(string store, string id, PostData body, CreateFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
PostData	body	The feature set definition.
CreateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeatureset<TResponse>(string, PostData, CreateFeaturesetRequestParameters)

PUT on /_ltr/_featureset/{id}

Declaration

public TResponse CreateFeatureset<TResponse>(string id, PostData body, CreateFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
PostData	body	The feature set definition.
CreateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateFeatureset<TResponse>(string, string, PostData, CreateFeaturesetRequestParameters)

PUT on /_ltr/{store}/_featureset/{id}

Declaration

public TResponse CreateFeatureset<TResponse>(string store, string id, PostData body, CreateFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
PostData	body	The feature set definition.
CreateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModelAsync<TResponse>(string, PostData, CreateModelRequestParameters, CancellationToken)

PUT on /_ltr/_model/{id}

Declaration

public Task<TResponse> CreateModelAsync<TResponse>(string id, PostData body, CreateModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the model.
PostData	body	The model definition.
CreateModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModelAsync<TResponse>(string, string, PostData, CreateModelRequestParameters, CancellationToken)

PUT on /_ltr/{store}/_model/{id}

Declaration

public Task<TResponse> CreateModelAsync<TResponse>(string store, string id, PostData body, CreateModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the model.
PostData	body	The model definition.
CreateModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModelFromSetAsync<TResponse>(string, PostData, CreateModelFromSetRequestParameters, CancellationToken)

POST on /_ltr/_featureset/{name}/_createmodel

Declaration

public Task<TResponse> CreateModelFromSetAsync<TResponse>(string name, PostData body, CreateModelFromSetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the feature set to use for creating the model.
PostData	body	The model definition for creating from a feature set.
CreateModelFromSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModelFromSetAsync<TResponse>(string, string, PostData, CreateModelFromSetRequestParameters, CancellationToken)

POST on /_ltr/{store}/_featureset/{name}/_createmodel

Declaration

public Task<TResponse> CreateModelFromSetAsync<TResponse>(string store, string name, PostData body, CreateModelFromSetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	name	The name of the feature set to use for creating the model.
PostData	body	The model definition for creating from a feature set.
CreateModelFromSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModelFromSet<TResponse>(string, PostData, CreateModelFromSetRequestParameters)

POST on /_ltr/_featureset/{name}/_createmodel

Declaration

public TResponse CreateModelFromSet<TResponse>(string name, PostData body, CreateModelFromSetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name	The name of the feature set to use for creating the model.
PostData	body	The model definition for creating from a feature set.
CreateModelFromSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModelFromSet<TResponse>(string, string, PostData, CreateModelFromSetRequestParameters)

POST on /_ltr/{store}/_featureset/{name}/_createmodel

Declaration

public TResponse CreateModelFromSet<TResponse>(string store, string name, PostData body, CreateModelFromSetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	name	The name of the feature set to use for creating the model.
PostData	body	The model definition for creating from a feature set.
CreateModelFromSetRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModel<TResponse>(string, PostData, CreateModelRequestParameters)

PUT on /_ltr/_model/{id}

Declaration

public TResponse CreateModel<TResponse>(string id, PostData body, CreateModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the model.
PostData	body	The model definition.
CreateModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateModel<TResponse>(string, string, PostData, CreateModelRequestParameters)

PUT on /_ltr/{store}/_model/{id}

Declaration

public TResponse CreateModel<TResponse>(string store, string id, PostData body, CreateModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the model.
PostData	body	The model definition.
CreateModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

CreateStoreAsync<TResponse>(string, CreateStoreRequestParameters, CancellationToken)

PUT on /_ltr/{store}

Declaration

public Task<TResponse> CreateStoreAsync<TResponse>(string store, CreateStoreRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
CreateStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

CreateStore<TResponse>(string, CreateStoreRequestParameters)

PUT on /_ltr/{store}

Declaration

public TResponse CreateStore<TResponse>(string store, CreateStoreRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
CreateStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

DeleteDefaultStoreAsync<TResponse>(DeleteDefaultStoreRequestParameters, CancellationToken)

DELETE on /_ltr

Declaration

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

Parameters

Type	Name	Description
DeleteDefaultStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

DeleteDefaultStore<TResponse>(DeleteDefaultStoreRequestParameters)

DELETE on /_ltr

Declaration

public TResponse DeleteDefaultStore<TResponse>(DeleteDefaultStoreRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
DeleteDefaultStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

DeleteFeatureAsync<TResponse>(string, DeleteFeatureRequestParameters, CancellationToken)

DELETE on /_ltr/_feature/{id}

Declaration

public Task<TResponse> DeleteFeatureAsync<TResponse>(string id, DeleteFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
DeleteFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeatureAsync<TResponse>(string, string, DeleteFeatureRequestParameters, CancellationToken)

DELETE on /_ltr/{store}/_feature/{id}

Declaration

public Task<TResponse> DeleteFeatureAsync<TResponse>(string store, string id, DeleteFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
DeleteFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeature<TResponse>(string, DeleteFeatureRequestParameters)

DELETE on /_ltr/_feature/{id}

Declaration

public TResponse DeleteFeature<TResponse>(string id, DeleteFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
DeleteFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeature<TResponse>(string, string, DeleteFeatureRequestParameters)

DELETE on /_ltr/{store}/_feature/{id}

Declaration

public TResponse DeleteFeature<TResponse>(string store, string id, DeleteFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
DeleteFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeaturesetAsync<TResponse>(string, DeleteFeaturesetRequestParameters, CancellationToken)

DELETE on /_ltr/_featureset/{id}

Declaration

public Task<TResponse> DeleteFeaturesetAsync<TResponse>(string id, DeleteFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
DeleteFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeaturesetAsync<TResponse>(string, string, DeleteFeaturesetRequestParameters, CancellationToken)

DELETE on /_ltr/{store}/_featureset/{id}

Declaration

public Task<TResponse> DeleteFeaturesetAsync<TResponse>(string store, string id, DeleteFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
DeleteFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeatureset<TResponse>(string, DeleteFeaturesetRequestParameters)

DELETE on /_ltr/_featureset/{id}

Declaration

public TResponse DeleteFeatureset<TResponse>(string id, DeleteFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
DeleteFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteFeatureset<TResponse>(string, string, DeleteFeaturesetRequestParameters)

DELETE on /_ltr/{store}/_featureset/{id}

Declaration

public TResponse DeleteFeatureset<TResponse>(string store, string id, DeleteFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
DeleteFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteModelAsync<TResponse>(string, DeleteModelRequestParameters, CancellationToken)

DELETE on /_ltr/_model/{id}

Declaration

public Task<TResponse> DeleteModelAsync<TResponse>(string id, DeleteModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the model.
DeleteModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteModelAsync<TResponse>(string, string, DeleteModelRequestParameters, CancellationToken)

DELETE on /_ltr/{store}/_model/{id}

Declaration

public Task<TResponse> DeleteModelAsync<TResponse>(string store, string id, DeleteModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the model.
DeleteModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteModel<TResponse>(string, DeleteModelRequestParameters)

DELETE on /_ltr/_model/{id}

Declaration

public TResponse DeleteModel<TResponse>(string id, DeleteModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the model.
DeleteModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteModel<TResponse>(string, string, DeleteModelRequestParameters)

DELETE on /_ltr/{store}/_model/{id}

Declaration

public TResponse DeleteModel<TResponse>(string store, string id, DeleteModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the model.
DeleteModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

DeleteStoreAsync<TResponse>(string, DeleteStoreRequestParameters, CancellationToken)

DELETE on /_ltr/{store}

Declaration

public Task<TResponse> DeleteStoreAsync<TResponse>(string store, DeleteStoreRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
DeleteStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

DeleteStore<TResponse>(string, DeleteStoreRequestParameters)

DELETE on /_ltr/{store}

Declaration

public TResponse DeleteStore<TResponse>(string store, DeleteStoreRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
DeleteStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

GetFeatureAsync<TResponse>(string, GetFeatureRequestParameters, CancellationToken)

GET on /_ltr/_feature/{id}

Declaration

public Task<TResponse> GetFeatureAsync<TResponse>(string id, GetFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
GetFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeatureAsync<TResponse>(string, string, GetFeatureRequestParameters, CancellationToken)

GET on /_ltr/{store}/_feature/{id}

Declaration

public Task<TResponse> GetFeatureAsync<TResponse>(string store, string id, GetFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
GetFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeature<TResponse>(string, GetFeatureRequestParameters)

GET on /_ltr/_feature/{id}

Declaration

public TResponse GetFeature<TResponse>(string id, GetFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
GetFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeature<TResponse>(string, string, GetFeatureRequestParameters)

GET on /_ltr/{store}/_feature/{id}

Declaration

public TResponse GetFeature<TResponse>(string store, string id, GetFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
GetFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeaturesetAsync<TResponse>(string, GetFeaturesetRequestParameters, CancellationToken)

GET on /_ltr/_featureset/{id}

Declaration

public Task<TResponse> GetFeaturesetAsync<TResponse>(string id, GetFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
GetFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeaturesetAsync<TResponse>(string, string, GetFeaturesetRequestParameters, CancellationToken)

GET on /_ltr/{store}/_featureset/{id}

Declaration

public Task<TResponse> GetFeaturesetAsync<TResponse>(string store, string id, GetFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
GetFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeatureset<TResponse>(string, GetFeaturesetRequestParameters)

GET on /_ltr/_featureset/{id}

Declaration

public TResponse GetFeatureset<TResponse>(string id, GetFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
GetFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetFeatureset<TResponse>(string, string, GetFeaturesetRequestParameters)

GET on /_ltr/{store}/_featureset/{id}

Declaration

public TResponse GetFeatureset<TResponse>(string store, string id, GetFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
GetFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetModelAsync<TResponse>(string, GetModelRequestParameters, CancellationToken)

GET on /_ltr/_model/{id}

Declaration

public Task<TResponse> GetModelAsync<TResponse>(string id, GetModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the model.
GetModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetModelAsync<TResponse>(string, string, GetModelRequestParameters, CancellationToken)

GET on /_ltr/{store}/_model/{id}

Declaration

public Task<TResponse> GetModelAsync<TResponse>(string store, string id, GetModelRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the model.
GetModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetModel<TResponse>(string, GetModelRequestParameters)

GET on /_ltr/_model/{id}

Declaration

public TResponse GetModel<TResponse>(string id, GetModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the model.
GetModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetModel<TResponse>(string, string, GetModelRequestParameters)

GET on /_ltr/{store}/_model/{id}

Declaration

public TResponse GetModel<TResponse>(string store, string id, GetModelRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the model.
GetModelRequestParameters	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.19.0 or greater.

| Edit this page View Source

GetStoreAsync<TResponse>(string, GetStoreRequestParameters, CancellationToken)

GET on /_ltr/{store}

Declaration

public Task<TResponse> GetStoreAsync<TResponse>(string store, GetStoreRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
GetStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

GetStore<TResponse>(string, GetStoreRequestParameters)

GET on /_ltr/{store}

Declaration

public TResponse GetStore<TResponse>(string store, GetStoreRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
GetStoreRequestParameters	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.17.1 or greater.

| Edit this page View Source

ListStoresAsync<TResponse>(ListStoresRequestParameters, CancellationToken)

GET on /_ltr

Declaration

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

Parameters

Type	Name	Description
ListStoresRequestParameters	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.17.1 or greater.

| Edit this page View Source

ListStores<TResponse>(ListStoresRequestParameters)

GET on /_ltr

Declaration

public TResponse ListStores<TResponse>(ListStoresRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ListStoresRequestParameters	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.17.1 or greater.

| Edit this page View Source

SearchFeaturesAsync<TResponse>(SearchFeaturesRequestParameters, CancellationToken)

GET on /_ltr/_feature

Declaration

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

Parameters

Type	Name	Description
SearchFeaturesRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeaturesAsync<TResponse>(string, SearchFeaturesRequestParameters, CancellationToken)

GET on /_ltr/{store}/_feature

Declaration

public Task<TResponse> SearchFeaturesAsync<TResponse>(string store, SearchFeaturesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
SearchFeaturesRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeatures<TResponse>(SearchFeaturesRequestParameters)

GET on /_ltr/_feature

Declaration

public TResponse SearchFeatures<TResponse>(SearchFeaturesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SearchFeaturesRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeatures<TResponse>(string, SearchFeaturesRequestParameters)

GET on /_ltr/{store}/_feature

Declaration

public TResponse SearchFeatures<TResponse>(string store, SearchFeaturesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
SearchFeaturesRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeaturesetsAsync<TResponse>(SearchFeaturesetsRequestParameters, CancellationToken)

GET on /_ltr/_featureset

Declaration

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

Parameters

Type	Name	Description
SearchFeaturesetsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeaturesetsAsync<TResponse>(string, SearchFeaturesetsRequestParameters, CancellationToken)

GET on /_ltr/{store}/_featureset

Declaration

public Task<TResponse> SearchFeaturesetsAsync<TResponse>(string store, SearchFeaturesetsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
SearchFeaturesetsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeaturesets<TResponse>(SearchFeaturesetsRequestParameters)

GET on /_ltr/_featureset

Declaration

public TResponse SearchFeaturesets<TResponse>(SearchFeaturesetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SearchFeaturesetsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchFeaturesets<TResponse>(string, SearchFeaturesetsRequestParameters)

GET on /_ltr/{store}/_featureset

Declaration

public TResponse SearchFeaturesets<TResponse>(string store, SearchFeaturesetsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
SearchFeaturesetsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchModelsAsync<TResponse>(SearchModelsRequestParameters, CancellationToken)

GET on /_ltr/_model

Declaration

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

Parameters

Type	Name	Description
SearchModelsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchModelsAsync<TResponse>(string, SearchModelsRequestParameters, CancellationToken)

GET on /_ltr/{store}/_model

Declaration

public Task<TResponse> SearchModelsAsync<TResponse>(string store, SearchModelsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
SearchModelsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchModels<TResponse>(SearchModelsRequestParameters)

GET on /_ltr/_model

Declaration

public TResponse SearchModels<TResponse>(SearchModelsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SearchModelsRequestParameters	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.19.0 or greater.

| Edit this page View Source

SearchModels<TResponse>(string, SearchModelsRequestParameters)

GET on /_ltr/{store}/_model

Declaration

public TResponse SearchModels<TResponse>(string store, SearchModelsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
SearchModelsRequestParameters	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.19.0 or greater.

| Edit this page View Source

StatsAsync<TResponse>(string, StatsRequestParameters, CancellationToken)

GET on /_plugins/_ltr/{node_id}/stats

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

StatsAsync<TResponse>(string, LtrStatName?, StatsRequestParameters, CancellationToken)

GET on /_plugins/_ltr/{node_id}/stats/{stat}

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, LtrStatName? stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
LtrStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

StatsForAllAsync<TResponse>(StatsRequestParameters, CancellationToken)

GET on /_plugins/_ltr/stats

Declaration

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

Parameters

Type	Name	Description
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

StatsForAllAsync<TResponse>(LtrStatName?, StatsRequestParameters, CancellationToken)

GET on /_plugins/_ltr/stats/{stat}

Declaration

public Task<TResponse> StatsForAllAsync<TResponse>(LtrStatName? stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
LtrStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

StatsForAll<TResponse>(StatsRequestParameters)

GET on /_plugins/_ltr/stats

Declaration

public TResponse StatsForAll<TResponse>(StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

StatsForAll<TResponse>(LtrStatName?, StatsRequestParameters)

GET on /_plugins/_ltr/stats/{stat}

Declaration

public TResponse StatsForAll<TResponse>(LtrStatName? stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
LtrStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

Stats<TResponse>(string, StatsRequestParameters)

GET on /_plugins/_ltr/{node_id}/stats

Declaration

public TResponse Stats<TResponse>(string nodeId, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

Stats<TResponse>(string, LtrStatName?, StatsRequestParameters)

GET on /_plugins/_ltr/{node_id}/stats/{stat}

Declaration

public TResponse Stats<TResponse>(string nodeId, LtrStatName? stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	A comma-separated list of node IDs or names to limit the returned information; use <c>_local</c> to return information from the node you're connecting to, leave empty to get information from all nodes.
LtrStatName?	stat	A comma-separated list of stats to retrieve; use <c>_all</c> or empty string to retrieve all stats.
StatsRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeatureAsync<TResponse>(string, PostData, UpdateFeatureRequestParameters, CancellationToken)

POST on /_ltr/_feature/{id}

Declaration

public Task<TResponse> UpdateFeatureAsync<TResponse>(string id, PostData body, UpdateFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
PostData	body	The updated feature definition.
UpdateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeatureAsync<TResponse>(string, string, PostData, UpdateFeatureRequestParameters, CancellationToken)

POST on /_ltr/{store}/_feature/{id}

Declaration

public Task<TResponse> UpdateFeatureAsync<TResponse>(string store, string id, PostData body, UpdateFeatureRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
PostData	body	The updated feature definition.
UpdateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeature<TResponse>(string, PostData, UpdateFeatureRequestParameters)

POST on /_ltr/_feature/{id}

Declaration

public TResponse UpdateFeature<TResponse>(string id, PostData body, UpdateFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature.
PostData	body	The updated feature definition.
UpdateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeature<TResponse>(string, string, PostData, UpdateFeatureRequestParameters)

POST on /_ltr/{store}/_feature/{id}

Declaration

public TResponse UpdateFeature<TResponse>(string store, string id, PostData body, UpdateFeatureRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature.
PostData	body	The updated feature definition.
UpdateFeatureRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeaturesetAsync<TResponse>(string, PostData, UpdateFeaturesetRequestParameters, CancellationToken)

POST on /_ltr/_featureset/{id}

Declaration

public Task<TResponse> UpdateFeaturesetAsync<TResponse>(string id, PostData body, UpdateFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
PostData	body	The updated feature set definition.
UpdateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeaturesetAsync<TResponse>(string, string, PostData, UpdateFeaturesetRequestParameters, CancellationToken)

POST on /_ltr/{store}/_featureset/{id}

Declaration

public Task<TResponse> UpdateFeaturesetAsync<TResponse>(string store, string id, PostData body, UpdateFeaturesetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
PostData	body	The updated feature set definition.
UpdateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeatureset<TResponse>(string, PostData, UpdateFeaturesetRequestParameters)

POST on /_ltr/_featureset/{id}

Declaration

public TResponse UpdateFeatureset<TResponse>(string id, PostData body, UpdateFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	The name of the feature set.
PostData	body	The updated feature set definition.
UpdateFeaturesetRequestParameters	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.19.0 or greater.

| Edit this page View Source

UpdateFeatureset<TResponse>(string, string, PostData, UpdateFeaturesetRequestParameters)

POST on /_ltr/{store}/_featureset/{id}

Declaration

public TResponse UpdateFeatureset<TResponse>(string store, string id, PostData body, UpdateFeaturesetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	store	The name of the feature store.
string	id	The name of the feature set.
PostData	body	The updated feature set definition.
UpdateFeaturesetRequestParameters	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.19.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)