Skip to content

Commit bb3cfcc

Browse files
scaleway-botscaleway-bot
authored
docs(serverless): add note about mnq region availability (#365)
1 parent 48866fd commit bb3cfcc

File tree

8 files changed

+112
-96
lines changed

8 files changed

+112
-96
lines changed

‎scaleway-async/scaleway_async/container/v1beta1/api.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1692,10 +1692,10 @@ async def create_trigger(
16921692
:param name: Name of the trigger.
16931693
:param container_id: ID of the container to trigger.
16941694
:param description: Description of the trigger.
1695-
:param scw_sqs_config: Configuration for a Scaleway M&Q SQS queue.
1695+
:param scw_sqs_config: Configuration for a Scaleway Messaging and Queuing SQS queue.
16961696
16971697
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
1698-
:param scw_nats_config: Configuration for a Scaleway M&Q NATS subject.
1698+
:param scw_nats_config: Configuration for a Scaleway Messaging and Queuing NATS subject.
16991699
17001700
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
17011701
:param sqs_config: Configuration for an AWS SQS queue.

‎scaleway-async/scaleway_async/container/v1beta1/types.py‎

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -327,29 +327,30 @@ class CreateTriggerRequestMnqNatsClientConfig:
327327
Create trigger request. mnq nats client config.
328328
"""
329329

330-
mnq_namespace_id: Optional[str]
330+
subject: str
331331
"""
332-
:deprecated
332+
Name of the NATS subject the trigger should listen to.
333333
"""
334334

335-
subject: str
335+
mnq_namespace_id: Optional[str]
336336
"""
337-
Name of the NATS subject the trigger should listen to.
337+
:deprecated
338338
"""
339339

340340
mnq_nats_account_id: str
341341
"""
342-
ID of the M&Q NATS account.
342+
ID of the Messaging and Queuing NATS account.
343343
"""
344344

345345
mnq_project_id: str
346346
"""
347-
ID of the M&Q project.
347+
ID of the Messaging and Queuing project.
348348
"""
349349

350350
mnq_region: str
351351
"""
352-
Region of the M&Q project.
352+
Region in which the Messaging and Queuing project is activated.
353+
Currently, only the `fr-par` region is available.
353354
"""
354355

355356

@@ -359,25 +360,26 @@ class CreateTriggerRequestMnqSqsClientConfig:
359360
Create trigger request. mnq sqs client config.
360361
"""
361362

362-
queue: str
363+
mnq_namespace_id: Optional[str]
363364
"""
364-
Name of the SQS queue the trigger should listen to.
365+
:deprecated
365366
"""
366367

367-
mnq_namespace_id: Optional[str]
368+
queue: str
368369
"""
369-
:deprecated
370+
Name of the SQS queue the trigger should listen to.
370371
"""
371372

372373
mnq_project_id: str
373374
"""
374-
ID of the M&Q project.
375+
ID of the Messaging and Queuing project.
375376
You must have activated SQS on this project.
376377
"""
377378

378379
mnq_region: str
379380
"""
380-
Region in which the M&Q project is activated.
381+
Region in which the Messaging and Queuing project is activated.
382+
Currently, only the `fr-par` region is available.
381383
"""
382384

383385

@@ -773,14 +775,14 @@ class Trigger:
773775

774776
scw_sqs_config: Optional[TriggerMnqSqsClientConfig]
775777
"""
776-
Configuration for a Scaleway M&Q SQS queue.
778+
Configuration for a Scaleway Messaging and Queuing SQS queue.
777779
778780
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
779781
"""
780782

781783
scw_nats_config: Optional[TriggerMnqNatsClientConfig]
782784
"""
783-
Configuration for a Scaleway M&Q NATS subject.
785+
Configuration for a Scaleway Messaging and Queuing NATS subject.
784786
785787
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
786788
"""
@@ -799,34 +801,35 @@ class TriggerMnqNatsClientConfig:
799801
Trigger. mnq nats client config.
800802
"""
801803

802-
subject: str
804+
mnq_namespace_id: Optional[str]
803805
"""
804-
Name of the NATS subject the trigger listens to.
806+
:deprecated
805807
"""
806808

807-
mnq_namespace_id: Optional[str]
809+
subject: str
808810
"""
809-
:deprecated
811+
Name of the NATS subject the trigger listens to.
810812
"""
811813

812814
mnq_nats_account_id: str
813815
"""
814-
ID of the M&Q NATS account.
816+
ID of the Messaging and Queuing NATS account.
815817
"""
816818

817819
mnq_project_id: str
818820
"""
819-
ID of the M&Q project.
821+
ID of the Messaging and Queuing project.
820822
"""
821823

822824
mnq_region: str
823825
"""
824-
Region of the M&Q project.
826+
Region in which the Messaging and Queuing project is activated.
827+
Currently, only the `fr-par` region is available.
825828
"""
826829

827830
mnq_credential_id: Optional[str]
828831
"""
829-
ID of the M&Q credentials used to subscribe to the NATS subject.
832+
ID of the Messaging and Queuing credentials used to subscribe to the NATS subject.
830833
"""
831834

832835

@@ -848,17 +851,18 @@ class TriggerMnqSqsClientConfig:
848851

849852
mnq_project_id: str
850853
"""
851-
ID of the M&Q project.
854+
ID of the Messaging and Queuing project.
852855
"""
853856

854857
mnq_region: str
855858
"""
856-
Region in which the M&Q project is activated.
859+
Region in which the Messaging and Queuing project is activated.
860+
Currently, only the `fr-par` region is available.
857861
"""
858862

859863
mnq_credential_id: Optional[str]
860864
"""
861-
ID of the M&Q credentials used to read from the SQS queue.
865+
ID of the Messaging and Queuing credentials used to read from the SQS queue.
862866
"""
863867

864868

@@ -1610,14 +1614,14 @@ class CreateTriggerRequest:
16101614

16111615
scw_sqs_config: Optional[CreateTriggerRequestMnqSqsClientConfig]
16121616
"""
1613-
Configuration for a Scaleway M&Q SQS queue.
1617+
Configuration for a Scaleway Messaging and Queuing SQS queue.
16141618
16151619
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
16161620
"""
16171621

16181622
scw_nats_config: Optional[CreateTriggerRequestMnqNatsClientConfig]
16191623
"""
1620-
Configuration for a Scaleway M&Q NATS subject.
1624+
Configuration for a Scaleway Messaging and Queuing NATS subject.
16211625
16221626
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
16231627
"""

‎scaleway-async/scaleway_async/function/v1beta1/api.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1777,10 +1777,10 @@ async def create_trigger(
17771777
:param name: Name of the trigger.
17781778
:param function_id: ID of the function to trigger.
17791779
:param description: Description of the trigger.
1780-
:param scw_sqs_config: Configuration for a Scaleway M&Q SQS queue.
1780+
:param scw_sqs_config: Configuration for a Scaleway Messaging and Queuing SQS queue.
17811781
17821782
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
1783-
:param scw_nats_config: Configuration for a Scaleway M&Q NATS subject.
1783+
:param scw_nats_config: Configuration for a Scaleway Messaging and Queuing NATS subject.
17841784
17851785
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
17861786
:param sqs_config: Configuration for an AWS SQS queue.

‎scaleway-async/scaleway_async/function/v1beta1/types.py‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -258,17 +258,18 @@ class CreateTriggerRequestMnqNatsClientConfig:
258258

259259
mnq_nats_account_id: str
260260
"""
261-
ID of the M&Q NATS account.
261+
ID of the Messaging and Queuing NATS account.
262262
"""
263263

264264
mnq_project_id: str
265265
"""
266-
ID of the M&Q project.
266+
ID of the Messaging and Queuing project.
267267
"""
268268

269269
mnq_region: str
270270
"""
271-
Region of the M&Q project.
271+
Region in which the Messaging and Queuing project is activated.
272+
Currently, only the `fr-par` region is available.
272273
"""
273274

274275

@@ -290,13 +291,14 @@ class CreateTriggerRequestMnqSqsClientConfig:
290291

291292
mnq_project_id: str
292293
"""
293-
ID of the M&Q project.
294+
ID of the Messaging and Queuing project.
294295
You must have activated SQS on this project.
295296
"""
296297

297298
mnq_region: str
298299
"""
299-
Region in which the M&Q project is activated.
300+
Region in which the Messaging and Queuing project is activated.
301+
Currently, only the `fr-par` region is available.
300302
"""
301303

302304

@@ -863,14 +865,14 @@ class Trigger:
863865

864866
scw_sqs_config: Optional[TriggerMnqSqsClientConfig]
865867
"""
866-
Configuration for a Scaleway M&Q SQS queue.
868+
Configuration for a Scaleway Messaging and Queuing SQS queue.
867869
868870
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
869871
"""
870872

871873
scw_nats_config: Optional[TriggerMnqNatsClientConfig]
872874
"""
873-
Configuration for a Scaleway M&Q NATS subject.
875+
Configuration for a Scaleway Messaging and Queuing NATS subject.
874876
875877
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
876878
"""
@@ -901,22 +903,23 @@ class TriggerMnqNatsClientConfig:
901903

902904
mnq_nats_account_id: str
903905
"""
904-
ID of the M&Q NATS account.
906+
ID of the Messaging and Queuing NATS account.
905907
"""
906908

907909
mnq_project_id: str
908910
"""
909-
ID of the M&Q project.
911+
ID of the Messaging and Queuing project.
910912
"""
911913

912914
mnq_region: str
913915
"""
914-
Region of the M&Q project.
916+
Region in which the Messaging and Queuing project is activated.
917+
Currently, only the `fr-par` region is available.
915918
"""
916919

917920
mnq_credential_id: Optional[str]
918921
"""
919-
ID of the M&Q credentials used to subscribe to the NATS subject.
922+
ID of the Messaging and Queuing credentials used to subscribe to the NATS subject.
920923
"""
921924

922925

@@ -926,29 +929,30 @@ class TriggerMnqSqsClientConfig:
926929
Trigger. mnq sqs client config.
927930
"""
928931

929-
queue: str
932+
mnq_namespace_id: Optional[str]
930933
"""
931-
Name of the SQS queue the trigger listens to.
934+
:deprecated
932935
"""
933936

934-
mnq_namespace_id: Optional[str]
937+
queue: str
935938
"""
936-
:deprecated
939+
Name of the SQS queue the trigger listens to.
937940
"""
938941

939942
mnq_project_id: str
940943
"""
941-
ID of the M&Q project.
944+
ID of the Messaging and Queuing project.
942945
"""
943946

944947
mnq_region: str
945948
"""
946-
Region in which the M&Q project is activated.
949+
Region in which the Messaging and Queuing project is activated.
950+
Currently, only the `fr-par` region is available.
947951
"""
948952

949953
mnq_credential_id: Optional[str]
950954
"""
951-
ID of the M&Q credentials used to read from the SQS queue.
955+
ID of the Messaging and Queuing credentials used to read from the SQS queue.
952956
"""
953957

954958

@@ -1729,14 +1733,14 @@ class CreateTriggerRequest:
17291733

17301734
scw_sqs_config: Optional[CreateTriggerRequestMnqSqsClientConfig]
17311735
"""
1732-
Configuration for a Scaleway M&Q SQS queue.
1736+
Configuration for a Scaleway Messaging and Queuing SQS queue.
17331737
17341738
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
17351739
"""
17361740

17371741
scw_nats_config: Optional[CreateTriggerRequestMnqNatsClientConfig]
17381742
"""
1739-
Configuration for a Scaleway M&Q NATS subject.
1743+
Configuration for a Scaleway Messaging and Queuing NATS subject.
17401744
17411745
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
17421746
"""

‎scaleway/scaleway/container/v1beta1/api.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1688,10 +1688,10 @@ def create_trigger(
16881688
:param name: Name of the trigger.
16891689
:param container_id: ID of the container to trigger.
16901690
:param description: Description of the trigger.
1691-
:param scw_sqs_config: Configuration for a Scaleway M&Q SQS queue.
1691+
:param scw_sqs_config: Configuration for a Scaleway Messaging and Queuing SQS queue.
16921692
16931693
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
1694-
:param scw_nats_config: Configuration for a Scaleway M&Q NATS subject.
1694+
:param scw_nats_config: Configuration for a Scaleway Messaging and Queuing NATS subject.
16951695
16961696
One-of ('config'): at most one of 'scw_sqs_config', 'scw_nats_config', 'sqs_config' could be set.
16971697
:param sqs_config: Configuration for an AWS SQS queue.

0 commit comments

Comments
 (0)