# SPDX-License-Identifier: Apache-2.0 # # The OpenSearch Contributors require contributions made to # this file be licensed under the Apache-2.0 license or a # compatible open source license. # # Modifications Copyright OpenSearch Contributors. See # GitHub history for details. # ------------------------------------------------------------------------------------------ # THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST # # To contribute, kindly make modifications in the opensearch-py client generator # or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md # and https://github.com/opensearch-project/opensearch-api-specification for details. # -----------------------------------------------------------------------------------------+ from typing import Any from ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params class LtrClient(NamespacedClient): @query_params("error_trace", "filter_path", "human", "pretty", "source") async def cache_stats( self, *, params: Any = None, headers: Any = None, ) -> Any: """ Retrieves cache statistics for all feature stores. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ return await self.transport.perform_request( "GET", "/_ltr/_cachestats", params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def clear_cache( self, *, store: Any = None, params: Any = None, headers: Any = None, ) -> Any: """ Clears the store caches. :arg store: The name of the feature store for which to clear the cache. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ return await self.transport.perform_request( "POST", _make_path("_ltr", store, "_clearcache"), params=params, headers=headers, ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def create_default_store( self, *, params: Any = None, headers: Any = None, ) -> Any: """ Creates the default feature store. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ return await self.transport.perform_request( "PUT", "/_ltr", params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def create_store( self, *, store: Any, params: Any = None, headers: Any = None, ) -> Any: """ Creates a new feature store with the specified name. :arg store: The name of the feature store. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ if store in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'store'.") return await self.transport.perform_request( "PUT", _make_path("_ltr", store), params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def delete_default_store( self, *, params: Any = None, headers: Any = None, ) -> Any: """ Deletes the default feature store. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ return await self.transport.perform_request( "DELETE", "/_ltr", params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def delete_store( self, *, store: Any, params: Any = None, headers: Any = None, ) -> Any: """ Deletes a feature store with the specified name. :arg store: The name of the feature store. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ if store in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'store'.") return await self.transport.perform_request( "DELETE", _make_path("_ltr", store), params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def get_store( self, *, store: Any, params: Any = None, headers: Any = None, ) -> Any: """ Checks if a store exists. :arg store: The name of the feature store. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ if store in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'store'.") return await self.transport.perform_request( "GET", _make_path("_ltr", store), params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source") async def list_stores( self, *, params: Any = None, headers: Any = None, ) -> Any: """ Lists all available feature stores. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ return await self.transport.perform_request( "GET", "/_ltr", params=params, headers=headers ) @query_params("error_trace", "filter_path", "human", "pretty", "source", "timeout") async def stats( self, *, node_id: Any = None, stat: Any = None, params: Any = None, headers: Any = None, ) -> Any: """ Provides information about the current status of the LTR plugin. :arg node_id: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes. :arg stat: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. :arg error_trace: Whether to include the stack trace of returned errors. Default is false. :arg filter_path: Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". :arg human: Whether to return human readable values for statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: The time in milliseconds to wait for a response. """ return await self.transport.perform_request( "GET", _make_path("_plugins", "_ltr", node_id, "stats", stat), params=params, headers=headers, )