Class OpenSearchLtrClient
java.lang.Object
org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchLtrClient>
org.opensearch.client.opensearch.ltr.OpenSearchLtrClient
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchLtrClient
extends ApiClient<OpenSearchTransport,OpenSearchLtrClient>
Client for the ltr namespace.
-
Field Summary
Fields inherited from class org.opensearch.client.ApiClient
transport, transportOptions -
Constructor Summary
ConstructorsConstructorDescriptionOpenSearchLtrClient(OpenSearchTransport transport) OpenSearchLtrClient(OpenSearchTransport transport, TransportOptions transportOptions) -
Method Summary
Modifier and TypeMethodDescriptionfinal AddFeaturesToSetResponseaddFeaturesToSet(Function<AddFeaturesToSetRequest.Builder, ObjectBuilder<AddFeaturesToSetRequest>> fn) Add features to an existing feature set in the default feature store.addFeaturesToSet(AddFeaturesToSetRequest request) Add features to an existing feature set in the default feature store.addFeaturesToSetByQuery(Function<AddFeaturesToSetByQueryRequest.Builder, ObjectBuilder<AddFeaturesToSetByQueryRequest>> fn) Add features to an existing feature set in the default feature store.Add features to an existing feature set in the default feature store.final CacheStatsResponseRetrieves cache statistics for all feature stores.final CacheStatsResponseRetrieves cache statistics for all feature stores.cacheStats(CacheStatsRequest request) Retrieves cache statistics for all feature stores.final ClearCacheResponseClears the store caches.final ClearCacheResponseClears the store caches.clearCache(ClearCacheRequest request) Clears the store caches.Creates the default feature store.createDefaultStore(Function<CreateDefaultStoreRequest.Builder, ObjectBuilder<CreateDefaultStoreRequest>> fn) Creates the default feature store.Creates the default feature store.final CreateFeatureResponseCreate or update a feature in the default feature store.createFeature(CreateFeatureRequest request) Create or update a feature in the default feature store.final CreateFeaturesetResponsecreateFeatureset(Function<CreateFeaturesetRequest.Builder, ObjectBuilder<CreateFeaturesetRequest>> fn) Create or update a feature set in the default feature store.createFeatureset(CreateFeaturesetRequest request) Create or update a feature set in the default feature store.final CreateModelResponseCreate or update a model in the default feature store.createModel(CreateModelRequest request) Create or update a model in the default feature store.createModelFromSet(Function<CreateModelFromSetRequest.Builder, ObjectBuilder<CreateModelFromSetRequest>> fn) Create a model from an existing feature set in the default feature store.Create a model from an existing feature set in the default feature store.final CreateStoreResponseCreates a new feature store with the specified name.createStore(CreateStoreRequest request) Creates a new feature store with the specified name.Deletes the default feature store.deleteDefaultStore(Function<DeleteDefaultStoreRequest.Builder, ObjectBuilder<DeleteDefaultStoreRequest>> fn) Deletes the default feature store.Deletes the default feature store.final DeleteFeatureResponseDelete a feature from the default feature store.deleteFeature(DeleteFeatureRequest request) Delete a feature from the default feature store.final DeleteFeaturesetResponsedeleteFeatureset(Function<DeleteFeaturesetRequest.Builder, ObjectBuilder<DeleteFeaturesetRequest>> fn) Delete a feature set from the default feature store.deleteFeatureset(DeleteFeaturesetRequest request) Delete a feature set from the default feature store.final DeleteModelResponseDelete a model from the default feature store.deleteModel(DeleteModelRequest request) Delete a model from the default feature store.final DeleteStoreResponseDeletes a feature store with the specified name.deleteStore(DeleteStoreRequest request) Deletes a feature store with the specified name.final GetFeatureResponseGet a feature from the default feature store.getFeature(GetFeatureRequest request) Get a feature from the default feature store.final GetFeaturesetResponseGet a feature set from the default feature store.getFeatureset(GetFeaturesetRequest request) Get a feature set from the default feature store.final GetModelResponseGet a model from the default feature store.getModel(GetModelRequest request) Get a model from the default feature store.final GetStoreResponseChecks if a store exists.getStore(GetStoreRequest request) Checks if a store exists.final ListStoresResponseLists all available feature stores.final ListStoresResponseLists all available feature stores.listStores(ListStoresRequest request) Lists all available feature stores.final SearchFeaturesResponseSearch for features in a feature store.final SearchFeaturesResponseSearch for features in a feature store.searchFeatures(SearchFeaturesRequest request) Search for features in a feature store.Search for feature sets in a feature store.searchFeaturesets(Function<SearchFeaturesetsRequest.Builder, ObjectBuilder<SearchFeaturesetsRequest>> fn) Search for feature sets in a feature store.Search for feature sets in a feature store.final SearchModelsResponseSearch for models in a feature store.final SearchModelsResponseSearch for models in a feature store.searchModels(SearchModelsRequest request) Search for models in a feature store.final LtrStatsResponsestats()Provides information about the current status of the LTR plugin.final LtrStatsResponseProvides information about the current status of the LTR plugin.stats(LtrStatsRequest request) Provides information about the current status of the LTR plugin.final UpdateFeatureResponseUpdate a feature in the default feature store.updateFeature(UpdateFeatureRequest request) Update a feature in the default feature store.final UpdateFeaturesetResponseupdateFeatureset(Function<UpdateFeaturesetRequest.Builder, ObjectBuilder<UpdateFeaturesetRequest>> fn) Update a feature set in the default feature store.updateFeatureset(UpdateFeaturesetRequest request) Update a feature set in the default feature store.withTransportOptions(TransportOptions transportOptions) Creates a new client with some request optionsMethods inherited from class org.opensearch.client.ApiClient
_transport, _transportOptions, getDeserializer
-
Constructor Details
-
OpenSearchLtrClient
-
OpenSearchLtrClient
public OpenSearchLtrClient(OpenSearchTransport transport, @Nullable TransportOptions transportOptions)
-
-
Method Details
-
withTransportOptions
Description copied from class:ApiClientCreates a new client with some request options- Specified by:
withTransportOptionsin classApiClient<OpenSearchTransport,OpenSearchLtrClient>
-
addFeaturesToSet
public AddFeaturesToSetResponse addFeaturesToSet(AddFeaturesToSetRequest request) throws IOException, OpenSearchException Add features to an existing feature set in the default feature store.- Throws:
IOExceptionOpenSearchException
-
addFeaturesToSet
public final AddFeaturesToSetResponse addFeaturesToSet(Function<AddFeaturesToSetRequest.Builder, ObjectBuilder<AddFeaturesToSetRequest>> fn) throws IOException, OpenSearchExceptionAdd features to an existing feature set in the default feature store.- Parameters:
fn- a function that initializes a builder to create theAddFeaturesToSetRequest- Throws:
IOExceptionOpenSearchException
-
addFeaturesToSetByQuery
public AddFeaturesToSetByQueryResponse addFeaturesToSetByQuery(AddFeaturesToSetByQueryRequest request) throws IOException, OpenSearchException Add features to an existing feature set in the default feature store.- Throws:
IOExceptionOpenSearchException
-
addFeaturesToSetByQuery
public final AddFeaturesToSetByQueryResponse addFeaturesToSetByQuery(Function<AddFeaturesToSetByQueryRequest.Builder, ObjectBuilder<AddFeaturesToSetByQueryRequest>> fn) throws IOException, OpenSearchExceptionAdd features to an existing feature set in the default feature store.- Parameters:
fn- a function that initializes a builder to create theAddFeaturesToSetByQueryRequest- Throws:
IOExceptionOpenSearchException
-
cacheStats
public CacheStatsResponse cacheStats(CacheStatsRequest request) throws IOException, OpenSearchException Retrieves cache statistics for all feature stores.- Throws:
IOExceptionOpenSearchException
-
cacheStats
public final CacheStatsResponse cacheStats(Function<CacheStatsRequest.Builder, ObjectBuilder<CacheStatsRequest>> fn) throws IOException, OpenSearchExceptionRetrieves cache statistics for all feature stores.- Parameters:
fn- a function that initializes a builder to create theCacheStatsRequest- Throws:
IOExceptionOpenSearchException
-
cacheStats
Retrieves cache statistics for all feature stores.- Throws:
IOExceptionOpenSearchException
-
clearCache
public ClearCacheResponse clearCache(ClearCacheRequest request) throws IOException, OpenSearchException Clears the store caches.- Throws:
IOExceptionOpenSearchException
-
clearCache
public final ClearCacheResponse clearCache(Function<ClearCacheRequest.Builder, ObjectBuilder<ClearCacheRequest>> fn) throws IOException, OpenSearchExceptionClears the store caches.- Parameters:
fn- a function that initializes a builder to create theClearCacheRequest- Throws:
IOExceptionOpenSearchException
-
clearCache
Clears the store caches.- Throws:
IOExceptionOpenSearchException
-
createDefaultStore
public CreateDefaultStoreResponse createDefaultStore(CreateDefaultStoreRequest request) throws IOException, OpenSearchException Creates the default feature store.- Throws:
IOExceptionOpenSearchException
-
createDefaultStore
public final CreateDefaultStoreResponse createDefaultStore(Function<CreateDefaultStoreRequest.Builder, ObjectBuilder<CreateDefaultStoreRequest>> fn) throws IOException, OpenSearchExceptionCreates the default feature store.- Parameters:
fn- a function that initializes a builder to create theCreateDefaultStoreRequest- Throws:
IOExceptionOpenSearchException
-
createDefaultStore
public final CreateDefaultStoreResponse createDefaultStore() throws IOException, OpenSearchExceptionCreates the default feature store.- Throws:
IOExceptionOpenSearchException
-
createFeature
public CreateFeatureResponse createFeature(CreateFeatureRequest request) throws IOException, OpenSearchException Create or update a feature in the default feature store.- Throws:
IOExceptionOpenSearchException
-
createFeature
public final CreateFeatureResponse createFeature(Function<CreateFeatureRequest.Builder, ObjectBuilder<CreateFeatureRequest>> fn) throws IOException, OpenSearchExceptionCreate or update a feature in the default feature store.- Parameters:
fn- a function that initializes a builder to create theCreateFeatureRequest- Throws:
IOExceptionOpenSearchException
-
createFeatureset
public CreateFeaturesetResponse createFeatureset(CreateFeaturesetRequest request) throws IOException, OpenSearchException Create or update a feature set in the default feature store.- Throws:
IOExceptionOpenSearchException
-
createFeatureset
public final CreateFeaturesetResponse createFeatureset(Function<CreateFeaturesetRequest.Builder, ObjectBuilder<CreateFeaturesetRequest>> fn) throws IOException, OpenSearchExceptionCreate or update a feature set in the default feature store.- Parameters:
fn- a function that initializes a builder to create theCreateFeaturesetRequest- Throws:
IOExceptionOpenSearchException
-
createModel
public CreateModelResponse createModel(CreateModelRequest request) throws IOException, OpenSearchException Create or update a model in the default feature store.- Throws:
IOExceptionOpenSearchException
-
createModel
public final CreateModelResponse createModel(Function<CreateModelRequest.Builder, ObjectBuilder<CreateModelRequest>> fn) throws IOException, OpenSearchExceptionCreate or update a model in the default feature store.- Parameters:
fn- a function that initializes a builder to create theCreateModelRequest- Throws:
IOExceptionOpenSearchException
-
createModelFromSet
public CreateModelFromSetResponse createModelFromSet(CreateModelFromSetRequest request) throws IOException, OpenSearchException Create a model from an existing feature set in the default feature store.- Throws:
IOExceptionOpenSearchException
-
createModelFromSet
public final CreateModelFromSetResponse createModelFromSet(Function<CreateModelFromSetRequest.Builder, ObjectBuilder<CreateModelFromSetRequest>> fn) throws IOException, OpenSearchExceptionCreate a model from an existing feature set in the default feature store.- Parameters:
fn- a function that initializes a builder to create theCreateModelFromSetRequest- Throws:
IOExceptionOpenSearchException
-
createStore
public CreateStoreResponse createStore(CreateStoreRequest request) throws IOException, OpenSearchException Creates a new feature store with the specified name.- Throws:
IOExceptionOpenSearchException
-
createStore
public final CreateStoreResponse createStore(Function<CreateStoreRequest.Builder, ObjectBuilder<CreateStoreRequest>> fn) throws IOException, OpenSearchExceptionCreates a new feature store with the specified name.- Parameters:
fn- a function that initializes a builder to create theCreateStoreRequest- Throws:
IOExceptionOpenSearchException
-
deleteDefaultStore
public DeleteDefaultStoreResponse deleteDefaultStore(DeleteDefaultStoreRequest request) throws IOException, OpenSearchException Deletes the default feature store.- Throws:
IOExceptionOpenSearchException
-
deleteDefaultStore
public final DeleteDefaultStoreResponse deleteDefaultStore(Function<DeleteDefaultStoreRequest.Builder, ObjectBuilder<DeleteDefaultStoreRequest>> fn) throws IOException, OpenSearchExceptionDeletes the default feature store.- Parameters:
fn- a function that initializes a builder to create theDeleteDefaultStoreRequest- Throws:
IOExceptionOpenSearchException
-
deleteDefaultStore
public final DeleteDefaultStoreResponse deleteDefaultStore() throws IOException, OpenSearchExceptionDeletes the default feature store.- Throws:
IOExceptionOpenSearchException
-
deleteFeature
public DeleteFeatureResponse deleteFeature(DeleteFeatureRequest request) throws IOException, OpenSearchException Delete a feature from the default feature store.- Throws:
IOExceptionOpenSearchException
-
deleteFeature
public final DeleteFeatureResponse deleteFeature(Function<DeleteFeatureRequest.Builder, ObjectBuilder<DeleteFeatureRequest>> fn) throws IOException, OpenSearchExceptionDelete a feature from the default feature store.- Parameters:
fn- a function that initializes a builder to create theDeleteFeatureRequest- Throws:
IOExceptionOpenSearchException
-
deleteFeatureset
public DeleteFeaturesetResponse deleteFeatureset(DeleteFeaturesetRequest request) throws IOException, OpenSearchException Delete a feature set from the default feature store.- Throws:
IOExceptionOpenSearchException
-
deleteFeatureset
public final DeleteFeaturesetResponse deleteFeatureset(Function<DeleteFeaturesetRequest.Builder, ObjectBuilder<DeleteFeaturesetRequest>> fn) throws IOException, OpenSearchExceptionDelete a feature set from the default feature store.- Parameters:
fn- a function that initializes a builder to create theDeleteFeaturesetRequest- Throws:
IOExceptionOpenSearchException
-
deleteModel
public DeleteModelResponse deleteModel(DeleteModelRequest request) throws IOException, OpenSearchException Delete a model from the default feature store.- Throws:
IOExceptionOpenSearchException
-
deleteModel
public final DeleteModelResponse deleteModel(Function<DeleteModelRequest.Builder, ObjectBuilder<DeleteModelRequest>> fn) throws IOException, OpenSearchExceptionDelete a model from the default feature store.- Parameters:
fn- a function that initializes a builder to create theDeleteModelRequest- Throws:
IOExceptionOpenSearchException
-
deleteStore
public DeleteStoreResponse deleteStore(DeleteStoreRequest request) throws IOException, OpenSearchException Deletes a feature store with the specified name.- Throws:
IOExceptionOpenSearchException
-
deleteStore
public final DeleteStoreResponse deleteStore(Function<DeleteStoreRequest.Builder, ObjectBuilder<DeleteStoreRequest>> fn) throws IOException, OpenSearchExceptionDeletes a feature store with the specified name.- Parameters:
fn- a function that initializes a builder to create theDeleteStoreRequest- Throws:
IOExceptionOpenSearchException
-
getFeature
public GetFeatureResponse getFeature(GetFeatureRequest request) throws IOException, OpenSearchException Get a feature from the default feature store.- Throws:
IOExceptionOpenSearchException
-
getFeature
public final GetFeatureResponse getFeature(Function<GetFeatureRequest.Builder, ObjectBuilder<GetFeatureRequest>> fn) throws IOException, OpenSearchExceptionGet a feature from the default feature store.- Parameters:
fn- a function that initializes a builder to create theGetFeatureRequest- Throws:
IOExceptionOpenSearchException
-
getFeatureset
public GetFeaturesetResponse getFeatureset(GetFeaturesetRequest request) throws IOException, OpenSearchException Get a feature set from the default feature store.- Throws:
IOExceptionOpenSearchException
-
getFeatureset
public final GetFeaturesetResponse getFeatureset(Function<GetFeaturesetRequest.Builder, ObjectBuilder<GetFeaturesetRequest>> fn) throws IOException, OpenSearchExceptionGet a feature set from the default feature store.- Parameters:
fn- a function that initializes a builder to create theGetFeaturesetRequest- Throws:
IOExceptionOpenSearchException
-
getModel
Get a model from the default feature store.- Throws:
IOExceptionOpenSearchException
-
getModel
public final GetModelResponse getModel(Function<GetModelRequest.Builder, ObjectBuilder<GetModelRequest>> fn) throws IOException, OpenSearchExceptionGet a model from the default feature store.- Parameters:
fn- a function that initializes a builder to create theGetModelRequest- Throws:
IOExceptionOpenSearchException
-
getStore
Checks if a store exists.- Throws:
IOExceptionOpenSearchException
-
getStore
public final GetStoreResponse getStore(Function<GetStoreRequest.Builder, ObjectBuilder<GetStoreRequest>> fn) throws IOException, OpenSearchExceptionChecks if a store exists.- Parameters:
fn- a function that initializes a builder to create theGetStoreRequest- Throws:
IOExceptionOpenSearchException
-
listStores
public ListStoresResponse listStores(ListStoresRequest request) throws IOException, OpenSearchException Lists all available feature stores.- Throws:
IOExceptionOpenSearchException
-
listStores
public final ListStoresResponse listStores(Function<ListStoresRequest.Builder, ObjectBuilder<ListStoresRequest>> fn) throws IOException, OpenSearchExceptionLists all available feature stores.- Parameters:
fn- a function that initializes a builder to create theListStoresRequest- Throws:
IOExceptionOpenSearchException
-
listStores
Lists all available feature stores.- Throws:
IOExceptionOpenSearchException
-
searchFeatures
public SearchFeaturesResponse searchFeatures(SearchFeaturesRequest request) throws IOException, OpenSearchException Search for features in a feature store.- Throws:
IOExceptionOpenSearchException
-
searchFeatures
public final SearchFeaturesResponse searchFeatures(Function<SearchFeaturesRequest.Builder, ObjectBuilder<SearchFeaturesRequest>> fn) throws IOException, OpenSearchExceptionSearch for features in a feature store.- Parameters:
fn- a function that initializes a builder to create theSearchFeaturesRequest- Throws:
IOExceptionOpenSearchException
-
searchFeatures
Search for features in a feature store.- Throws:
IOExceptionOpenSearchException
-
searchFeaturesets
public SearchFeaturesetsResponse searchFeaturesets(SearchFeaturesetsRequest request) throws IOException, OpenSearchException Search for feature sets in a feature store.- Throws:
IOExceptionOpenSearchException
-
searchFeaturesets
public final SearchFeaturesetsResponse searchFeaturesets(Function<SearchFeaturesetsRequest.Builder, ObjectBuilder<SearchFeaturesetsRequest>> fn) throws IOException, OpenSearchExceptionSearch for feature sets in a feature store.- Parameters:
fn- a function that initializes a builder to create theSearchFeaturesetsRequest- Throws:
IOExceptionOpenSearchException
-
searchFeaturesets
Search for feature sets in a feature store.- Throws:
IOExceptionOpenSearchException
-
searchModels
public SearchModelsResponse searchModels(SearchModelsRequest request) throws IOException, OpenSearchException Search for models in a feature store.- Throws:
IOExceptionOpenSearchException
-
searchModels
public final SearchModelsResponse searchModels(Function<SearchModelsRequest.Builder, ObjectBuilder<SearchModelsRequest>> fn) throws IOException, OpenSearchExceptionSearch for models in a feature store.- Parameters:
fn- a function that initializes a builder to create theSearchModelsRequest- Throws:
IOExceptionOpenSearchException
-
searchModels
Search for models in a feature store.- Throws:
IOExceptionOpenSearchException
-
stats
Provides information about the current status of the LTR plugin.- Throws:
IOExceptionOpenSearchException
-
stats
public final LtrStatsResponse stats(Function<LtrStatsRequest.Builder, ObjectBuilder<LtrStatsRequest>> fn) throws IOException, OpenSearchExceptionProvides information about the current status of the LTR plugin.- Parameters:
fn- a function that initializes a builder to create theLtrStatsRequest- Throws:
IOExceptionOpenSearchException
-
stats
Provides information about the current status of the LTR plugin.- Throws:
IOExceptionOpenSearchException
-
updateFeature
public UpdateFeatureResponse updateFeature(UpdateFeatureRequest request) throws IOException, OpenSearchException Update a feature in the default feature store.- Throws:
IOExceptionOpenSearchException
-
updateFeature
public final UpdateFeatureResponse updateFeature(Function<UpdateFeatureRequest.Builder, ObjectBuilder<UpdateFeatureRequest>> fn) throws IOException, OpenSearchExceptionUpdate a feature in the default feature store.- Parameters:
fn- a function that initializes a builder to create theUpdateFeatureRequest- Throws:
IOExceptionOpenSearchException
-
updateFeatureset
public UpdateFeaturesetResponse updateFeatureset(UpdateFeaturesetRequest request) throws IOException, OpenSearchException Update a feature set in the default feature store.- Throws:
IOExceptionOpenSearchException
-
updateFeatureset
public final UpdateFeaturesetResponse updateFeatureset(Function<UpdateFeaturesetRequest.Builder, ObjectBuilder<UpdateFeaturesetRequest>> fn) throws IOException, OpenSearchExceptionUpdate a feature set in the default feature store.- Parameters:
fn- a function that initializes a builder to create theUpdateFeaturesetRequest- Throws:
IOExceptionOpenSearchException
-