diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index cd64c279c..2b6c33572 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -85,9 +85,9 @@ CLIENT_META_SERVICE, SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, client_node_configs, is_requests_http_auth, is_requests_node_class, @@ -3094,7 +3094,7 @@ async def info( ), parameter_aliases={"_source": "source"}, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def knn_search( self, *, @@ -4417,7 +4417,7 @@ async def render_search_template( @_rewrite_parameters( body_fields=("context", "context_setup", "script"), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def scripts_painless_execute( self, *, diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index 8de430f83..03396a875 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -20,12 +20,20 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters +from .utils import ( + SKIP_IN_PATH, + Stability, + Visibility, + _availability_warning, + _quote, + _rewrite_parameters, +) class AutoscalingClient(NamespacedClient): @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def delete_autoscaling_policy( self, *, @@ -81,6 +89,7 @@ async def delete_autoscaling_policy( ) @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def get_autoscaling_capacity( self, *, @@ -134,6 +143,7 @@ async def get_autoscaling_capacity( ) @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def get_autoscaling_policy( self, *, @@ -186,6 +196,7 @@ async def get_autoscaling_policy( @_rewrite_parameters( body_name="policy", ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def put_autoscaling_policy( self, *, diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py index 8a048de5f..673ccf3a2 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -3455,7 +3455,7 @@ async def snapshots( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def tasks( self, *, diff --git a/elasticsearch/_async/client/connector.py b/elasticsearch/_async/client/connector.py index 3ad9943ad..d84e0516f 100644 --- a/elasticsearch/_async/client/connector.py +++ b/elasticsearch/_async/client/connector.py @@ -23,16 +23,17 @@ from .utils import ( SKIP_IN_PATH, Stability, + Visibility, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class ConnectorClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def check_in( self, *, @@ -77,7 +78,7 @@ async def check_in( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def delete( self, *, @@ -130,7 +131,7 @@ async def delete( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def get( self, *, @@ -190,7 +191,7 @@ async def get( "sync_cursor", ), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE) async def last_sync( self, *, @@ -324,7 +325,7 @@ async def last_sync( @_rewrite_parameters( parameter_aliases={"from": "from_"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def list( self, *, @@ -402,7 +403,7 @@ async def list( "service_type", ), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def post( self, *, @@ -486,7 +487,7 @@ async def post( "service_type", ), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def put( self, *, @@ -566,7 +567,7 @@ async def put( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def sync_job_cancel( self, *, @@ -616,7 +617,7 @@ async def sync_job_cancel( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def sync_job_check_in( self, *, @@ -670,7 +671,7 @@ async def sync_job_check_in( @_rewrite_parameters( body_fields=("worker_hostname", "sync_cursor"), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def sync_job_claim( self, *, @@ -739,7 +740,7 @@ async def sync_job_claim( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def sync_job_delete( self, *, @@ -790,7 +791,7 @@ async def sync_job_delete( @_rewrite_parameters( body_fields=("error",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def sync_job_error( self, *, @@ -849,7 +850,7 @@ async def sync_job_error( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def sync_job_get( self, *, @@ -897,7 +898,7 @@ async def sync_job_get( @_rewrite_parameters( parameter_aliases={"from": "from_"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def sync_job_list( self, *, @@ -980,7 +981,7 @@ async def sync_job_list( @_rewrite_parameters( body_fields=("id", "job_type", "trigger_method"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def sync_job_post( self, *, @@ -1052,7 +1053,7 @@ async def sync_job_post( "total_document_count", ), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def sync_job_update_stats( self, *, @@ -1146,7 +1147,7 @@ async def sync_job_update_stats( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def update_active_filtering( self, *, @@ -1193,7 +1194,7 @@ async def update_active_filtering( @_rewrite_parameters( body_fields=("api_key_id", "api_key_secret_id"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_api_key_id( self, *, @@ -1255,7 +1256,7 @@ async def update_api_key_id( @_rewrite_parameters( body_fields=("configuration", "values"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_configuration( self, *, @@ -1314,7 +1315,7 @@ async def update_configuration( @_rewrite_parameters( body_fields=("error",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def update_error( self, *, @@ -1373,7 +1374,7 @@ async def update_error( @_rewrite_parameters( body_fields=("features",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def update_features( self, *, @@ -1441,7 +1442,7 @@ async def update_features( @_rewrite_parameters( body_fields=("advanced_snippet", "filtering", "rules"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_filtering( self, *, @@ -1506,7 +1507,7 @@ async def update_filtering( @_rewrite_parameters( body_fields=("validation",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def update_filtering_validation( self, *, @@ -1563,7 +1564,7 @@ async def update_filtering_validation( @_rewrite_parameters( body_fields=("index_name",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_index_name( self, *, @@ -1620,7 +1621,7 @@ async def update_index_name( @_rewrite_parameters( body_fields=("description", "name"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_name( self, *, @@ -1678,7 +1679,7 @@ async def update_name( @_rewrite_parameters( body_fields=("is_native",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_native( self, *, @@ -1734,7 +1735,7 @@ async def update_native( @_rewrite_parameters( body_fields=("pipeline",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_pipeline( self, *, @@ -1791,7 +1792,7 @@ async def update_pipeline( @_rewrite_parameters( body_fields=("scheduling",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_scheduling( self, *, @@ -1847,7 +1848,7 @@ async def update_scheduling( @_rewrite_parameters( body_fields=("service_type",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def update_service_type( self, *, @@ -1903,7 +1904,7 @@ async def update_service_type( @_rewrite_parameters( body_fields=("status",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def update_status( self, *, diff --git a/elasticsearch/_async/client/features.py b/elasticsearch/_async/client/features.py index 4b2b787ae..2c337c2f5 100644 --- a/elasticsearch/_async/client/features.py +++ b/elasticsearch/_async/client/features.py @@ -20,7 +20,7 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import Stability, _rewrite_parameters, _stability_warning +from .utils import Stability, _availability_warning, _rewrite_parameters class FeaturesClient(NamespacedClient): @@ -76,7 +76,7 @@ async def get_features( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def reset_features( self, *, diff --git a/elasticsearch/_async/client/fleet.py b/elasticsearch/_async/client/fleet.py index ef534dcfd..925b0b9fe 100644 --- a/elasticsearch/_async/client/fleet.py +++ b/elasticsearch/_async/client/fleet.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -101,7 +101,7 @@ async def global_checkpoints( @_rewrite_parameters( body_name="searches", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def msearch( self, *, @@ -292,7 +292,7 @@ async def msearch( "from": "from_", }, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def search( self, *, diff --git a/elasticsearch/_async/client/indices.py b/elasticsearch/_async/client/indices.py index 1b31232f5..1a8a8feb0 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -244,7 +244,7 @@ async def analyze( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def cancel_migrate_reindex( self, *, @@ -770,7 +770,7 @@ async def create_data_stream( @_rewrite_parameters( body_name="create_from", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def create_from( self, *, @@ -1284,7 +1284,7 @@ async def delete_template( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def disk_usage( self, *, @@ -1376,7 +1376,7 @@ async def disk_usage( @_rewrite_parameters( body_name="config", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def downsample( self, *, @@ -1787,7 +1787,7 @@ async def explain_data_lifecycle( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def field_usage_stats( self, *, @@ -2761,7 +2761,7 @@ async def get_mapping( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get_migrate_reindex_status( self, *, @@ -2977,7 +2977,7 @@ async def get_template( @_rewrite_parameters( body_name="reindex", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def migrate_reindex( self, *, diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index af9a4b946..881648953 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -20,7 +20,14 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters +from .utils import ( + SKIP_IN_PATH, + Stability, + Visibility, + _availability_warning, + _quote, + _rewrite_parameters, +) class MlClient(NamespacedClient): @@ -5697,6 +5704,7 @@ async def upgrade_job_snapshot( "results_index_name", ), ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def validate( self, *, @@ -5778,6 +5786,7 @@ async def validate( @_rewrite_parameters( body_name="detector", ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def validate_detector( self, *, diff --git a/elasticsearch/_async/client/monitoring.py b/elasticsearch/_async/client/monitoring.py index 761e772f4..3b32f7bdd 100644 --- a/elasticsearch/_async/client/monitoring.py +++ b/elasticsearch/_async/client/monitoring.py @@ -20,7 +20,7 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import _rewrite_parameters +from .utils import Stability, Visibility, _availability_warning, _rewrite_parameters class MonitoringClient(NamespacedClient): @@ -28,6 +28,7 @@ class MonitoringClient(NamespacedClient): @_rewrite_parameters( body_name="operations", ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def bulk( self, *, diff --git a/elasticsearch/_async/client/nodes.py b/elasticsearch/_async/client/nodes.py index 471e7c523..fef93be9e 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class NodesClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def clear_repositories_metering_archive( self, *, @@ -86,7 +86,7 @@ async def clear_repositories_metering_archive( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get_repositories_metering_info( self, *, diff --git a/elasticsearch/_async/client/rollup.py b/elasticsearch/_async/client/rollup.py index 1c589b5ed..004acdbea 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class RollupClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def delete_job( self, *, @@ -95,7 +95,7 @@ async def delete_job( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get_jobs( self, *, @@ -147,7 +147,7 @@ async def get_jobs( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get_rollup_caps( self, *, @@ -203,7 +203,7 @@ async def get_rollup_caps( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get_rollup_index_caps( self, *, @@ -266,7 +266,7 @@ async def get_rollup_index_caps( ), ignore_deprecated_options={"headers"}, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def put_job( self, *, @@ -392,7 +392,7 @@ async def put_job( @_rewrite_parameters( body_fields=("aggregations", "aggs", "query", "size"), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def rollup_search( self, *, @@ -503,7 +503,7 @@ async def rollup_search( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def start_job( self, *, @@ -549,7 +549,7 @@ async def start_job( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def stop_job( self, *, diff --git a/elasticsearch/_async/client/search_application.py b/elasticsearch/_async/client/search_application.py index f1bca27fd..d351cf99f 100644 --- a/elasticsearch/_async/client/search_application.py +++ b/elasticsearch/_async/client/search_application.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class SearchApplicationClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def delete( self, *, @@ -77,7 +77,7 @@ async def delete( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def delete_behavioral_analytics( self, *, @@ -122,7 +122,7 @@ async def delete_behavioral_analytics( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def get( self, *, @@ -166,7 +166,7 @@ async def get( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get_behavioral_analytics( self, *, @@ -215,7 +215,7 @@ async def get_behavioral_analytics( @_rewrite_parameters( parameter_aliases={"from": "from_"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def list( self, *, @@ -270,7 +270,7 @@ async def list( @_rewrite_parameters( body_name="payload", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def post_behavioral_analytics_event( self, *, @@ -338,7 +338,7 @@ async def post_behavioral_analytics_event( @_rewrite_parameters( body_name="search_application", ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def put( self, *, @@ -398,7 +398,7 @@ async def put( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def put_behavioral_analytics( self, *, @@ -445,7 +445,7 @@ async def put_behavioral_analytics( body_fields=("params",), ignore_deprecated_options={"params"}, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def render_query( self, *, @@ -510,7 +510,7 @@ async def render_query( body_fields=("params",), ignore_deprecated_options={"params"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) async def search( self, *, diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index b15bf0705..245fd6c98 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class SearchableSnapshotsClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def cache_stats( self, *, @@ -84,7 +84,7 @@ async def cache_stats( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def clear_cache( self, *, diff --git a/elasticsearch/_async/client/shutdown.py b/elasticsearch/_async/client/shutdown.py index 3696668d0..8732cf550 100644 --- a/elasticsearch/_async/client/shutdown.py +++ b/elasticsearch/_async/client/shutdown.py @@ -20,12 +20,20 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters +from .utils import ( + SKIP_IN_PATH, + Stability, + Visibility, + _availability_warning, + _quote, + _rewrite_parameters, +) class ShutdownClient(NamespacedClient): @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def delete_node( self, *, @@ -86,6 +94,7 @@ async def delete_node( ) @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def get_node( self, *, @@ -144,6 +153,7 @@ async def get_node( @_rewrite_parameters( body_fields=("reason", "type", "allocation_delay", "target_node_name"), ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) async def put_node( self, *, diff --git a/elasticsearch/_async/client/simulate.py b/elasticsearch/_async/client/simulate.py index 6880607b8..97fafd5b2 100644 --- a/elasticsearch/_async/client/simulate.py +++ b/elasticsearch/_async/client/simulate.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -40,7 +40,7 @@ class SimulateClient(NamespacedClient): "pipeline_substitutions", ), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def ingest( self, *, diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index 6ed65a1d7..0d5429606 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -913,7 +913,7 @@ async def repository_analyze( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def repository_verify_integrity( self, *, diff --git a/elasticsearch/_async/client/streams.py b/elasticsearch/_async/client/streams.py index 65e934646..1310bfa2b 100644 --- a/elasticsearch/_async/client/streams.py +++ b/elasticsearch/_async/client/streams.py @@ -23,15 +23,15 @@ from ._base import NamespacedClient from .utils import ( Stability, + _availability_warning, _rewrite_parameters, - _stability_warning, ) class StreamsClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def logs_disable( self, *, @@ -83,7 +83,7 @@ async def logs_disable( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def logs_enable( self, *, @@ -138,7 +138,7 @@ async def logs_enable( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def status( self, *, diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index 9c3ca19b7..5dcbb3f74 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class TasksClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def cancel( self, *, @@ -106,7 +106,7 @@ async def cancel( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def get( self, *, @@ -164,7 +164,7 @@ async def get( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) async def list( self, *, diff --git a/elasticsearch/_async/client/utils.py b/elasticsearch/_async/client/utils.py index 97918d9e4..3ccd0fc36 100644 --- a/elasticsearch/_async/client/utils.py +++ b/elasticsearch/_async/client/utils.py @@ -21,11 +21,12 @@ CLIENT_META_SERVICE, SKIP_IN_PATH, Stability, + Visibility, + _availability_warning, _base64_auth_header, _quote, _quote_query, _rewrite_parameters, - _stability_warning, client_node_configs, is_requests_http_auth, is_requests_node_class, @@ -40,9 +41,10 @@ "_TYPE_HOSTS", "SKIP_IN_PATH", "Stability", + "Visibility", "client_node_configs", "_rewrite_parameters", - "_stability_warning", + "_availability_warning", "is_requests_http_auth", "is_requests_node_class", ] diff --git a/elasticsearch/_sync/client/__init__.py b/elasticsearch/_sync/client/__init__.py index 05c7a7cea..1a7d75ae7 100644 --- a/elasticsearch/_sync/client/__init__.py +++ b/elasticsearch/_sync/client/__init__.py @@ -85,9 +85,9 @@ CLIENT_META_SERVICE, SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, client_node_configs, is_requests_http_auth, is_requests_node_class, @@ -3094,7 +3094,7 @@ def info( ), parameter_aliases={"_source": "source"}, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def knn_search( self, *, @@ -4417,7 +4417,7 @@ def render_search_template( @_rewrite_parameters( body_fields=("context", "context_setup", "script"), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def scripts_painless_execute( self, *, diff --git a/elasticsearch/_sync/client/autoscaling.py b/elasticsearch/_sync/client/autoscaling.py index 53cfe405a..b6029b757 100644 --- a/elasticsearch/_sync/client/autoscaling.py +++ b/elasticsearch/_sync/client/autoscaling.py @@ -20,12 +20,20 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters +from .utils import ( + SKIP_IN_PATH, + Stability, + Visibility, + _availability_warning, + _quote, + _rewrite_parameters, +) class AutoscalingClient(NamespacedClient): @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def delete_autoscaling_policy( self, *, @@ -81,6 +89,7 @@ def delete_autoscaling_policy( ) @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def get_autoscaling_capacity( self, *, @@ -134,6 +143,7 @@ def get_autoscaling_capacity( ) @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def get_autoscaling_policy( self, *, @@ -186,6 +196,7 @@ def get_autoscaling_policy( @_rewrite_parameters( body_name="policy", ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def put_autoscaling_policy( self, *, diff --git a/elasticsearch/_sync/client/cat.py b/elasticsearch/_sync/client/cat.py index 5be8efaba..f51bbaccd 100644 --- a/elasticsearch/_sync/client/cat.py +++ b/elasticsearch/_sync/client/cat.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -3455,7 +3455,7 @@ def snapshots( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def tasks( self, *, diff --git a/elasticsearch/_sync/client/connector.py b/elasticsearch/_sync/client/connector.py index b31f6f654..04511aedb 100644 --- a/elasticsearch/_sync/client/connector.py +++ b/elasticsearch/_sync/client/connector.py @@ -23,16 +23,17 @@ from .utils import ( SKIP_IN_PATH, Stability, + Visibility, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class ConnectorClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def check_in( self, *, @@ -77,7 +78,7 @@ def check_in( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def delete( self, *, @@ -130,7 +131,7 @@ def delete( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def get( self, *, @@ -190,7 +191,7 @@ def get( "sync_cursor", ), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL, Visibility.PRIVATE) def last_sync( self, *, @@ -324,7 +325,7 @@ def last_sync( @_rewrite_parameters( parameter_aliases={"from": "from_"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def list( self, *, @@ -402,7 +403,7 @@ def list( "service_type", ), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def post( self, *, @@ -486,7 +487,7 @@ def post( "service_type", ), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def put( self, *, @@ -566,7 +567,7 @@ def put( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def sync_job_cancel( self, *, @@ -616,7 +617,7 @@ def sync_job_cancel( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def sync_job_check_in( self, *, @@ -670,7 +671,7 @@ def sync_job_check_in( @_rewrite_parameters( body_fields=("worker_hostname", "sync_cursor"), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def sync_job_claim( self, *, @@ -739,7 +740,7 @@ def sync_job_claim( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def sync_job_delete( self, *, @@ -790,7 +791,7 @@ def sync_job_delete( @_rewrite_parameters( body_fields=("error",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def sync_job_error( self, *, @@ -849,7 +850,7 @@ def sync_job_error( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def sync_job_get( self, *, @@ -897,7 +898,7 @@ def sync_job_get( @_rewrite_parameters( parameter_aliases={"from": "from_"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def sync_job_list( self, *, @@ -980,7 +981,7 @@ def sync_job_list( @_rewrite_parameters( body_fields=("id", "job_type", "trigger_method"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def sync_job_post( self, *, @@ -1052,7 +1053,7 @@ def sync_job_post( "total_document_count", ), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def sync_job_update_stats( self, *, @@ -1146,7 +1147,7 @@ def sync_job_update_stats( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def update_active_filtering( self, *, @@ -1193,7 +1194,7 @@ def update_active_filtering( @_rewrite_parameters( body_fields=("api_key_id", "api_key_secret_id"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_api_key_id( self, *, @@ -1255,7 +1256,7 @@ def update_api_key_id( @_rewrite_parameters( body_fields=("configuration", "values"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_configuration( self, *, @@ -1314,7 +1315,7 @@ def update_configuration( @_rewrite_parameters( body_fields=("error",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def update_error( self, *, @@ -1373,7 +1374,7 @@ def update_error( @_rewrite_parameters( body_fields=("features",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def update_features( self, *, @@ -1441,7 +1442,7 @@ def update_features( @_rewrite_parameters( body_fields=("advanced_snippet", "filtering", "rules"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_filtering( self, *, @@ -1506,7 +1507,7 @@ def update_filtering( @_rewrite_parameters( body_fields=("validation",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def update_filtering_validation( self, *, @@ -1563,7 +1564,7 @@ def update_filtering_validation( @_rewrite_parameters( body_fields=("index_name",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_index_name( self, *, @@ -1620,7 +1621,7 @@ def update_index_name( @_rewrite_parameters( body_fields=("description", "name"), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_name( self, *, @@ -1678,7 +1679,7 @@ def update_name( @_rewrite_parameters( body_fields=("is_native",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_native( self, *, @@ -1734,7 +1735,7 @@ def update_native( @_rewrite_parameters( body_fields=("pipeline",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_pipeline( self, *, @@ -1791,7 +1792,7 @@ def update_pipeline( @_rewrite_parameters( body_fields=("scheduling",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_scheduling( self, *, @@ -1847,7 +1848,7 @@ def update_scheduling( @_rewrite_parameters( body_fields=("service_type",), ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def update_service_type( self, *, @@ -1903,7 +1904,7 @@ def update_service_type( @_rewrite_parameters( body_fields=("status",), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def update_status( self, *, diff --git a/elasticsearch/_sync/client/features.py b/elasticsearch/_sync/client/features.py index a4e1964c4..40afb1a48 100644 --- a/elasticsearch/_sync/client/features.py +++ b/elasticsearch/_sync/client/features.py @@ -20,7 +20,7 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import Stability, _rewrite_parameters, _stability_warning +from .utils import Stability, _availability_warning, _rewrite_parameters class FeaturesClient(NamespacedClient): @@ -76,7 +76,7 @@ def get_features( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def reset_features( self, *, diff --git a/elasticsearch/_sync/client/fleet.py b/elasticsearch/_sync/client/fleet.py index 96c8334c1..4ce7456b7 100644 --- a/elasticsearch/_sync/client/fleet.py +++ b/elasticsearch/_sync/client/fleet.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -101,7 +101,7 @@ def global_checkpoints( @_rewrite_parameters( body_name="searches", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def msearch( self, *, @@ -292,7 +292,7 @@ def msearch( "from": "from_", }, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def search( self, *, diff --git a/elasticsearch/_sync/client/indices.py b/elasticsearch/_sync/client/indices.py index d09c243cf..9981b2bf4 100644 --- a/elasticsearch/_sync/client/indices.py +++ b/elasticsearch/_sync/client/indices.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -244,7 +244,7 @@ def analyze( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def cancel_migrate_reindex( self, *, @@ -770,7 +770,7 @@ def create_data_stream( @_rewrite_parameters( body_name="create_from", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def create_from( self, *, @@ -1284,7 +1284,7 @@ def delete_template( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def disk_usage( self, *, @@ -1376,7 +1376,7 @@ def disk_usage( @_rewrite_parameters( body_name="config", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def downsample( self, *, @@ -1787,7 +1787,7 @@ def explain_data_lifecycle( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def field_usage_stats( self, *, @@ -2761,7 +2761,7 @@ def get_mapping( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get_migrate_reindex_status( self, *, @@ -2977,7 +2977,7 @@ def get_template( @_rewrite_parameters( body_name="reindex", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def migrate_reindex( self, *, diff --git a/elasticsearch/_sync/client/ml.py b/elasticsearch/_sync/client/ml.py index f4b4612fd..b057c339e 100644 --- a/elasticsearch/_sync/client/ml.py +++ b/elasticsearch/_sync/client/ml.py @@ -20,7 +20,14 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters +from .utils import ( + SKIP_IN_PATH, + Stability, + Visibility, + _availability_warning, + _quote, + _rewrite_parameters, +) class MlClient(NamespacedClient): @@ -5697,6 +5704,7 @@ def upgrade_job_snapshot( "results_index_name", ), ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def validate( self, *, @@ -5778,6 +5786,7 @@ def validate( @_rewrite_parameters( body_name="detector", ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def validate_detector( self, *, diff --git a/elasticsearch/_sync/client/monitoring.py b/elasticsearch/_sync/client/monitoring.py index 033982ad1..d8638442c 100644 --- a/elasticsearch/_sync/client/monitoring.py +++ b/elasticsearch/_sync/client/monitoring.py @@ -20,7 +20,7 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import _rewrite_parameters +from .utils import Stability, Visibility, _availability_warning, _rewrite_parameters class MonitoringClient(NamespacedClient): @@ -28,6 +28,7 @@ class MonitoringClient(NamespacedClient): @_rewrite_parameters( body_name="operations", ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def bulk( self, *, diff --git a/elasticsearch/_sync/client/nodes.py b/elasticsearch/_sync/client/nodes.py index 54c8d188a..81b457ab7 100644 --- a/elasticsearch/_sync/client/nodes.py +++ b/elasticsearch/_sync/client/nodes.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class NodesClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def clear_repositories_metering_archive( self, *, @@ -86,7 +86,7 @@ def clear_repositories_metering_archive( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get_repositories_metering_info( self, *, diff --git a/elasticsearch/_sync/client/rollup.py b/elasticsearch/_sync/client/rollup.py index ae8b0c946..ff8bdb075 100644 --- a/elasticsearch/_sync/client/rollup.py +++ b/elasticsearch/_sync/client/rollup.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class RollupClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def delete_job( self, *, @@ -95,7 +95,7 @@ def delete_job( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get_jobs( self, *, @@ -147,7 +147,7 @@ def get_jobs( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get_rollup_caps( self, *, @@ -203,7 +203,7 @@ def get_rollup_caps( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get_rollup_index_caps( self, *, @@ -266,7 +266,7 @@ def get_rollup_index_caps( ), ignore_deprecated_options={"headers"}, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def put_job( self, *, @@ -392,7 +392,7 @@ def put_job( @_rewrite_parameters( body_fields=("aggregations", "aggs", "query", "size"), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def rollup_search( self, *, @@ -503,7 +503,7 @@ def rollup_search( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def start_job( self, *, @@ -549,7 +549,7 @@ def start_job( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def stop_job( self, *, diff --git a/elasticsearch/_sync/client/search_application.py b/elasticsearch/_sync/client/search_application.py index d50dc454b..eb013bff7 100644 --- a/elasticsearch/_sync/client/search_application.py +++ b/elasticsearch/_sync/client/search_application.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class SearchApplicationClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def delete( self, *, @@ -77,7 +77,7 @@ def delete( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def delete_behavioral_analytics( self, *, @@ -122,7 +122,7 @@ def delete_behavioral_analytics( ) @_rewrite_parameters() - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def get( self, *, @@ -166,7 +166,7 @@ def get( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get_behavioral_analytics( self, *, @@ -215,7 +215,7 @@ def get_behavioral_analytics( @_rewrite_parameters( parameter_aliases={"from": "from_"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def list( self, *, @@ -270,7 +270,7 @@ def list( @_rewrite_parameters( body_name="payload", ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def post_behavioral_analytics_event( self, *, @@ -338,7 +338,7 @@ def post_behavioral_analytics_event( @_rewrite_parameters( body_name="search_application", ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def put( self, *, @@ -398,7 +398,7 @@ def put( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def put_behavioral_analytics( self, *, @@ -445,7 +445,7 @@ def put_behavioral_analytics( body_fields=("params",), ignore_deprecated_options={"params"}, ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def render_query( self, *, @@ -510,7 +510,7 @@ def render_query( body_fields=("params",), ignore_deprecated_options={"params"}, ) - @_stability_warning(Stability.BETA) + @_availability_warning(Stability.BETA) def search( self, *, diff --git a/elasticsearch/_sync/client/searchable_snapshots.py b/elasticsearch/_sync/client/searchable_snapshots.py index b5eee7a42..522f9af98 100644 --- a/elasticsearch/_sync/client/searchable_snapshots.py +++ b/elasticsearch/_sync/client/searchable_snapshots.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class SearchableSnapshotsClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def cache_stats( self, *, @@ -84,7 +84,7 @@ def cache_stats( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def clear_cache( self, *, diff --git a/elasticsearch/_sync/client/shutdown.py b/elasticsearch/_sync/client/shutdown.py index f0b144a85..1688dfdce 100644 --- a/elasticsearch/_sync/client/shutdown.py +++ b/elasticsearch/_sync/client/shutdown.py @@ -20,12 +20,20 @@ from elastic_transport import ObjectApiResponse from ._base import NamespacedClient -from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters +from .utils import ( + SKIP_IN_PATH, + Stability, + Visibility, + _availability_warning, + _quote, + _rewrite_parameters, +) class ShutdownClient(NamespacedClient): @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def delete_node( self, *, @@ -86,6 +94,7 @@ def delete_node( ) @_rewrite_parameters() + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def get_node( self, *, @@ -144,6 +153,7 @@ def get_node( @_rewrite_parameters( body_fields=("reason", "type", "allocation_delay", "target_node_name"), ) + @_availability_warning(Stability.STABLE, Visibility.PRIVATE) def put_node( self, *, diff --git a/elasticsearch/_sync/client/simulate.py b/elasticsearch/_sync/client/simulate.py index 3a32869ee..796ceb77d 100644 --- a/elasticsearch/_sync/client/simulate.py +++ b/elasticsearch/_sync/client/simulate.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -40,7 +40,7 @@ class SimulateClient(NamespacedClient): "pipeline_substitutions", ), ) - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def ingest( self, *, diff --git a/elasticsearch/_sync/client/snapshot.py b/elasticsearch/_sync/client/snapshot.py index 705161d89..dd55e5b4a 100644 --- a/elasticsearch/_sync/client/snapshot.py +++ b/elasticsearch/_sync/client/snapshot.py @@ -23,9 +23,9 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) @@ -913,7 +913,7 @@ def repository_analyze( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def repository_verify_integrity( self, *, diff --git a/elasticsearch/_sync/client/streams.py b/elasticsearch/_sync/client/streams.py index ba6ff1062..ed208cde8 100644 --- a/elasticsearch/_sync/client/streams.py +++ b/elasticsearch/_sync/client/streams.py @@ -23,15 +23,15 @@ from ._base import NamespacedClient from .utils import ( Stability, + _availability_warning, _rewrite_parameters, - _stability_warning, ) class StreamsClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def logs_disable( self, *, @@ -83,7 +83,7 @@ def logs_disable( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def logs_enable( self, *, @@ -138,7 +138,7 @@ def logs_enable( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def status( self, *, diff --git a/elasticsearch/_sync/client/tasks.py b/elasticsearch/_sync/client/tasks.py index 946b911ba..5a27d7752 100644 --- a/elasticsearch/_sync/client/tasks.py +++ b/elasticsearch/_sync/client/tasks.py @@ -23,16 +23,16 @@ from .utils import ( SKIP_IN_PATH, Stability, + _availability_warning, _quote, _rewrite_parameters, - _stability_warning, ) class TasksClient(NamespacedClient): @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def cancel( self, *, @@ -106,7 +106,7 @@ def cancel( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def get( self, *, @@ -164,7 +164,7 @@ def get( ) @_rewrite_parameters() - @_stability_warning(Stability.EXPERIMENTAL) + @_availability_warning(Stability.EXPERIMENTAL) def list( self, *, diff --git a/elasticsearch/_sync/client/utils.py b/elasticsearch/_sync/client/utils.py index 51afe1c78..df1a6fced 100644 --- a/elasticsearch/_sync/client/utils.py +++ b/elasticsearch/_sync/client/utils.py @@ -79,6 +79,12 @@ class Stability(Enum): EXPERIMENTAL = auto() +class Visibility(Enum): + PUBLIC = auto() + FEATURE_FLAG = auto() + PRIVATE = auto() + + _TYPE_HOSTS = Union[ str, Sequence[Union[str, Mapping[str, Union[str, int]], NodeConfig]] ] @@ -456,15 +462,23 @@ def wrapped(*args: Any, **kwargs: Any) -> Any: return wrapper -def _stability_warning( +def _availability_warning( stability: Stability, + visibility: Visibility = Visibility.PUBLIC, version: Optional[str] = None, message: Optional[str] = None, ) -> Callable[[F], F]: def wrapper(api: F) -> F: @wraps(api) def wrapped(*args: Any, **kwargs: Any) -> Any: - if stability == Stability.BETA: + if visibility == Visibility.PRIVATE: + warnings.warn( + "This API is private. " + "Private APIs are not subject to the support SLA of official GA features.", + category=GeneralAvailabilityWarning, + stacklevel=warn_stacklevel(), + ) + elif stability == Stability.BETA: warnings.warn( "This API is in beta and is subject to change. " "The design and code is less mature than official GA features and is being provided as-is with no warranties. " diff --git a/test_elasticsearch/test_client/test_utils.py b/test_elasticsearch/test_client/test_utils.py index e4713ff1c..714c727aa 100644 --- a/test_elasticsearch/test_client/test_utils.py +++ b/test_elasticsearch/test_client/test_utils.py @@ -20,7 +20,12 @@ import pytest -from elasticsearch._sync.client.utils import Stability, _quote, _stability_warning +from elasticsearch._sync.client.utils import ( + Stability, + Visibility, + _availability_warning, + _quote, +) from elasticsearch.exceptions import GeneralAvailabilityWarning @@ -43,10 +48,10 @@ def test_handles_unicode2(): assert "%E4%B8%AD*%E6%96%87," == _quote(string) -class TestStabilityWarning: +class TestAvailabilityWarning: def test_default(self): - @_stability_warning(stability=Stability.STABLE) + @_availability_warning(stability=Stability.STABLE) def func_default(*args, **kwargs): pass @@ -56,7 +61,7 @@ def func_default(*args, **kwargs): def test_beta(self, recwarn): - @_stability_warning(stability=Stability.BETA) + @_availability_warning(stability=Stability.BETA) def func_beta(*args, **kwargs): pass @@ -68,7 +73,7 @@ def func_beta(*args, **kwargs): def test_experimental(self, recwarn): - @_stability_warning(stability=Stability.EXPERIMENTAL) + @_availability_warning(stability=Stability.EXPERIMENTAL) def func_experimental(*args, **kwargs): pass @@ -77,3 +82,29 @@ def func_experimental(*args, **kwargs): match="This API is in technical preview and may be changed or removed in a future release.", ): func_experimental() + + def test_private(self, recwarn): + + @_availability_warning( + stability=Stability.STABLE, visibility=Visibility.PRIVATE + ) + def func_private(*args, **kwargs): + pass + + with pytest.warns( + GeneralAvailabilityWarning, + match="This API is private.", + ): + func_private() + + def test_private_and_beta(self, recwarn): + + @_availability_warning(stability=Stability.BETA, visibility=Visibility.PRIVATE) + def func_private_and_beta(*args, **kwargs): + pass + + with pytest.warns( + GeneralAvailabilityWarning, + match="This API is private.", + ): + func_private_and_beta()