Skip to content

Commit e29da94

Browse files
pquentinpquentin
authored
Emit Python warnings for beta and tech preview APIs (#96)
1 parent 8b45de8 commit e29da94

File tree

16 files changed

+247
-13
lines changed

16 files changed

+247
-13
lines changed

‎elasticsearch_serverless/_async/client/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,10 @@
5959
_TYPE_HOST,
6060
CLIENT_META_SERVICE,
6161
SKIP_IN_PATH,
62+
Stability,
6263
_quote,
6364
_rewrite_parameters,
65+
_stability_warning,
6466
client_node_config,
6567
is_requests_http_auth,
6668
is_requests_node_class,
@@ -3070,6 +3072,7 @@ async def render_search_template(
30703072
@_rewrite_parameters(
30713073
body_fields=("context", "context_setup", "script"),
30723074
)
3075+
@_stability_warning(Stability.EXPERIMENTAL)
30733076
async def scripts_painless_execute(
30743077
self,
30753078
*,

‎elasticsearch_serverless/_async/client/connector.py

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,19 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23+
from .utils import (
24+
SKIP_IN_PATH,
25+
Stability,
26+
_quote,
27+
_rewrite_parameters,
28+
_stability_warning,
29+
)
2430

2531

2632
class ConnectorClient(NamespacedClient):
2733

2834
@_rewrite_parameters()
35+
@_stability_warning(Stability.EXPERIMENTAL)
2936
async def check_in(
3037
self,
3138
*,
@@ -67,6 +74,7 @@ async def check_in(
6774
)
6875

6976
@_rewrite_parameters()
77+
@_stability_warning(Stability.BETA)
7078
async def delete(
7179
self,
7280
*,
@@ -115,6 +123,7 @@ async def delete(
115123
)
116124

117125
@_rewrite_parameters()
126+
@_stability_warning(Stability.BETA)
118127
async def get(
119128
self,
120129
*,
@@ -157,6 +166,7 @@ async def get(
157166
@_rewrite_parameters(
158167
parameter_aliases={"from": "from_"},
159168
)
169+
@_stability_warning(Stability.BETA)
160170
async def list(
161171
self,
162172
*,
@@ -230,6 +240,7 @@ async def list(
230240
"service_type",
231241
),
232242
)
243+
@_stability_warning(Stability.BETA)
233244
async def post(
234245
self,
235246
*,
@@ -311,6 +322,7 @@ async def post(
311322
"service_type",
312323
),
313324
)
325+
@_stability_warning(Stability.BETA)
314326
async def put(
315327
self,
316328
*,
@@ -387,6 +399,7 @@ async def put(
387399
)
388400

389401
@_rewrite_parameters()
402+
@_stability_warning(Stability.BETA)
390403
async def sync_job_cancel(
391404
self,
392405
*,
@@ -434,6 +447,7 @@ async def sync_job_cancel(
434447
)
435448

436449
@_rewrite_parameters()
450+
@_stability_warning(Stability.BETA)
437451
async def sync_job_delete(
438452
self,
439453
*,
@@ -478,6 +492,7 @@ async def sync_job_delete(
478492
)
479493

480494
@_rewrite_parameters()
495+
@_stability_warning(Stability.BETA)
481496
async def sync_job_get(
482497
self,
483498
*,
@@ -522,6 +537,7 @@ async def sync_job_get(
522537
@_rewrite_parameters(
523538
parameter_aliases={"from": "from_"},
524539
)
540+
@_stability_warning(Stability.BETA)
525541
async def sync_job_list(
526542
self,
527543
*,
@@ -601,6 +617,7 @@ async def sync_job_list(
601617
@_rewrite_parameters(
602618
body_fields=("id", "job_type", "trigger_method"),
603619
)
620+
@_stability_warning(Stability.BETA)
604621
async def sync_job_post(
605622
self,
606623
*,
@@ -660,6 +677,7 @@ async def sync_job_post(
660677
)
661678

662679
@_rewrite_parameters()
680+
@_stability_warning(Stability.EXPERIMENTAL)
663681
async def update_active_filtering(
664682
self,
665683
*,
@@ -703,6 +721,7 @@ async def update_active_filtering(
703721
@_rewrite_parameters(
704722
body_fields=("api_key_id", "api_key_secret_id"),
705723
)
724+
@_stability_warning(Stability.BETA)
706725
async def update_api_key_id(
707726
self,
708727
*,
@@ -761,6 +780,7 @@ async def update_api_key_id(
761780
@_rewrite_parameters(
762781
body_fields=("configuration", "values"),
763782
)
783+
@_stability_warning(Stability.BETA)
764784
async def update_configuration(
765785
self,
766786
*,
@@ -816,6 +836,7 @@ async def update_configuration(
816836
@_rewrite_parameters(
817837
body_fields=("error",),
818838
)
839+
@_stability_warning(Stability.EXPERIMENTAL)
819840
async def update_error(
820841
self,
821842
*,
@@ -871,6 +892,7 @@ async def update_error(
871892
@_rewrite_parameters(
872893
body_fields=("advanced_snippet", "filtering", "rules"),
873894
)
895+
@_stability_warning(Stability.BETA)
874896
async def update_filtering(
875897
self,
876898
*,
@@ -932,6 +954,7 @@ async def update_filtering(
932954
@_rewrite_parameters(
933955
body_fields=("validation",),
934956
)
957+
@_stability_warning(Stability.EXPERIMENTAL)
935958
async def update_filtering_validation(
936959
self,
937960
*,
@@ -985,6 +1008,7 @@ async def update_filtering_validation(
9851008
@_rewrite_parameters(
9861009
body_fields=("index_name",),
9871010
)
1011+
@_stability_warning(Stability.BETA)
9881012
async def update_index_name(
9891013
self,
9901014
*,
@@ -1038,6 +1062,7 @@ async def update_index_name(
10381062
@_rewrite_parameters(
10391063
body_fields=("description", "name"),
10401064
)
1065+
@_stability_warning(Stability.BETA)
10411066
async def update_name(
10421067
self,
10431068
*,
@@ -1092,6 +1117,7 @@ async def update_name(
10921117
@_rewrite_parameters(
10931118
body_fields=("is_native",),
10941119
)
1120+
@_stability_warning(Stability.BETA)
10951121
async def update_native(
10961122
self,
10971123
*,
@@ -1144,6 +1170,7 @@ async def update_native(
11441170
@_rewrite_parameters(
11451171
body_fields=("pipeline",),
11461172
)
1173+
@_stability_warning(Stability.BETA)
11471174
async def update_pipeline(
11481175
self,
11491176
*,
@@ -1197,6 +1224,7 @@ async def update_pipeline(
11971224
@_rewrite_parameters(
11981225
body_fields=("scheduling",),
11991226
)
1227+
@_stability_warning(Stability.BETA)
12001228
async def update_scheduling(
12011229
self,
12021230
*,
@@ -1249,6 +1277,7 @@ async def update_scheduling(
12491277
@_rewrite_parameters(
12501278
body_fields=("service_type",),
12511279
)
1280+
@_stability_warning(Stability.BETA)
12521281
async def update_service_type(
12531282
self,
12541283
*,
@@ -1301,6 +1330,7 @@ async def update_service_type(
13011330
@_rewrite_parameters(
13021331
body_fields=("status",),
13031332
)
1333+
@_stability_warning(Stability.EXPERIMENTAL)
13041334
async def update_status(
13051335
self,
13061336
*,

‎elasticsearch_serverless/_async/client/inference.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,19 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23+
from .utils import (
24+
SKIP_IN_PATH,
25+
Stability,
26+
_quote,
27+
_rewrite_parameters,
28+
_stability_warning,
29+
)
2430

2531

2632
class InferenceClient(NamespacedClient):
2733

2834
@_rewrite_parameters()
35+
@_stability_warning(Stability.EXPERIMENTAL)
2936
async def delete(
3037
self,
3138
*,
@@ -93,6 +100,7 @@ async def delete(
93100
)
94101

95102
@_rewrite_parameters()
103+
@_stability_warning(Stability.EXPERIMENTAL)
96104
async def get(
97105
self,
98106
*,
@@ -151,6 +159,7 @@ async def get(
151159
@_rewrite_parameters(
152160
body_fields=("input", "query", "task_settings"),
153161
)
162+
@_stability_warning(Stability.EXPERIMENTAL)
154163
async def inference(
155164
self,
156165
*,
@@ -237,6 +246,7 @@ async def inference(
237246
@_rewrite_parameters(
238247
body_name="inference_config",
239248
)
249+
@_stability_warning(Stability.EXPERIMENTAL)
240250
async def put(
241251
self,
242252
*,

‎elasticsearch_serverless/_async/client/ml.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23+
from .utils import (
24+
SKIP_IN_PATH,
25+
Stability,
26+
_quote,
27+
_rewrite_parameters,
28+
_stability_warning,
29+
)
2430

2531

2632
class MlClient(NamespacedClient):
@@ -3919,6 +3925,7 @@ async def update_job(
39193925
@_rewrite_parameters(
39203926
body_fields=("number_of_allocations",),
39213927
)
3928+
@_stability_warning(Stability.BETA)
39223929
async def update_trained_model_deployment(
39233930
self,
39243931
*,

‎elasticsearch_serverless/_async/client/search_application.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,19 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23+
from .utils import (
24+
SKIP_IN_PATH,
25+
Stability,
26+
_quote,
27+
_rewrite_parameters,
28+
_stability_warning,
29+
)
2430

2531

2632
class SearchApplicationClient(NamespacedClient):
2733

2834
@_rewrite_parameters()
35+
@_stability_warning(Stability.BETA)
2936
async def delete(
3037
self,
3138
*,
@@ -67,6 +74,7 @@ async def delete(
6774
)
6875

6976
@_rewrite_parameters()
77+
@_stability_warning(Stability.EXPERIMENTAL)
7078
async def delete_behavioral_analytics(
7179
self,
7280
*,
@@ -108,6 +116,7 @@ async def delete_behavioral_analytics(
108116
)
109117

110118
@_rewrite_parameters()
119+
@_stability_warning(Stability.BETA)
111120
async def get(
112121
self,
113122
*,
@@ -148,6 +157,7 @@ async def get(
148157
)
149158

150159
@_rewrite_parameters()
160+
@_stability_warning(Stability.EXPERIMENTAL)
151161
async def get_behavioral_analytics(
152162
self,
153163
*,
@@ -193,6 +203,7 @@ async def get_behavioral_analytics(
193203
@_rewrite_parameters(
194204
parameter_aliases={"from": "from_"},
195205
)
206+
@_stability_warning(Stability.BETA)
196207
async def list(
197208
self,
198209
*,
@@ -243,6 +254,7 @@ async def list(
243254
@_rewrite_parameters(
244255
body_name="search_application",
245256
)
257+
@_stability_warning(Stability.BETA)
246258
async def put(
247259
self,
248260
*,
@@ -299,6 +311,7 @@ async def put(
299311
)
300312

301313
@_rewrite_parameters()
314+
@_stability_warning(Stability.EXPERIMENTAL)
302315
async def put_behavioral_analytics(
303316
self,
304317
*,
@@ -342,6 +355,7 @@ async def put_behavioral_analytics(
342355
body_fields=("params",),
343356
ignore_deprecated_options={"params"},
344357
)
358+
@_stability_warning(Stability.BETA)
345359
async def search(
346360
self,
347361
*,

‎elasticsearch_serverless/_async/client/tasks.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,19 @@
2020
from elastic_transport import ObjectApiResponse
2121

2222
from ._base import NamespacedClient
23-
from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
23+
from .utils import (
24+
SKIP_IN_PATH,
25+
Stability,
26+
_quote,
27+
_rewrite_parameters,
28+
_stability_warning,
29+
)
2430

2531

2632
class TasksClient(NamespacedClient):
2733

2834
@_rewrite_parameters()
35+
@_stability_warning(Stability.EXPERIMENTAL)
2936
async def get(
3037
self,
3138
*,

0 commit comments

Comments
 (0)