Skip to content
This repository was archived by the owner on Sep 5, 2023. It is now read-only.

Commit 1fa62df

Browse files
docs: Fix formatting of request arg in docstring (#269)
* docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: googleapis/googleapis@8a085ae Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 0b909e1 commit 1fa62df

File tree

9 files changed

+81
-147
lines changed

9 files changed

+81
-147
lines changed

google/cloud/websecurityscanner_v1/services/web_security_scanner/async_client.py

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,7 @@ async def sample_create_scan_config():
270270
271271
Args:
272272
request (Optional[Union[google.cloud.websecurityscanner_v1.types.CreateScanConfigRequest, dict]]):
273-
The request object. Request for the `CreateScanConfig`
274-
method.
273+
The request object. Request for the ``CreateScanConfig`` method.
275274
retry (google.api_core.retry.Retry): Designation of what errors, if any,
276275
should be retried.
277276
timeout (float): The timeout for this request.
@@ -349,8 +348,7 @@ async def sample_delete_scan_config():
349348
350349
Args:
351350
request (Optional[Union[google.cloud.websecurityscanner_v1.types.DeleteScanConfigRequest, dict]]):
352-
The request object. Request for the `DeleteScanConfig`
353-
method.
351+
The request object. Request for the ``DeleteScanConfig`` method.
354352
retry (google.api_core.retry.Retry): Designation of what errors, if any,
355353
should be retried.
356354
timeout (float): The timeout for this request.
@@ -431,8 +429,7 @@ async def sample_get_scan_config():
431429
432430
Args:
433431
request (Optional[Union[google.cloud.websecurityscanner_v1.types.GetScanConfigRequest, dict]]):
434-
The request object. Request for the `GetScanConfig`
435-
method.
432+
The request object. Request for the ``GetScanConfig`` method.
436433
retry (google.api_core.retry.Retry): Designation of what errors, if any,
437434
should be retried.
438435
timeout (float): The timeout for this request.
@@ -523,8 +520,7 @@ async def sample_list_scan_configs():
523520
524521
Args:
525522
request (Optional[Union[google.cloud.websecurityscanner_v1.types.ListScanConfigsRequest, dict]]):
526-
The request object. Request for the `ListScanConfigs`
527-
method.
523+
The request object. Request for the ``ListScanConfigs`` method.
528524
retry (google.api_core.retry.Retry): Designation of what errors, if any,
529525
should be retried.
530526
timeout (float): The timeout for this request.
@@ -626,8 +622,7 @@ async def sample_update_scan_config():
626622
627623
Args:
628624
request (Optional[Union[google.cloud.websecurityscanner_v1.types.UpdateScanConfigRequest, dict]]):
629-
The request object. Request for the
630-
`UpdateScanConfigRequest` method.
625+
The request object. Request for the ``UpdateScanConfigRequest`` method.
631626
retry (google.api_core.retry.Retry): Designation of what errors, if any,
632627
should be retried.
633628
timeout (float): The timeout for this request.
@@ -707,8 +702,7 @@ async def sample_start_scan_run():
707702
708703
Args:
709704
request (Optional[Union[google.cloud.websecurityscanner_v1.types.StartScanRunRequest, dict]]):
710-
The request object. Request for the `StartScanRun`
711-
method.
705+
The request object. Request for the ``StartScanRun`` method.
712706
retry (google.api_core.retry.Retry): Designation of what errors, if any,
713707
should be retried.
714708
timeout (float): The timeout for this request.
@@ -787,7 +781,7 @@ async def sample_get_scan_run():
787781
788782
Args:
789783
request (Optional[Union[google.cloud.websecurityscanner_v1.types.GetScanRunRequest, dict]]):
790-
The request object. Request for the `GetScanRun` method.
784+
The request object. Request for the ``GetScanRun`` method.
791785
retry (google.api_core.retry.Retry): Designation of what errors, if any,
792786
should be retried.
793787
timeout (float): The timeout for this request.
@@ -878,8 +872,7 @@ async def sample_list_scan_runs():
878872
879873
Args:
880874
request (Optional[Union[google.cloud.websecurityscanner_v1.types.ListScanRunsRequest, dict]]):
881-
The request object. Request for the `ListScanRuns`
882-
method.
875+
The request object. Request for the ``ListScanRuns`` method.
883876
retry (google.api_core.retry.Retry): Designation of what errors, if any,
884877
should be retried.
885878
timeout (float): The timeout for this request.
@@ -978,8 +971,7 @@ async def sample_stop_scan_run():
978971
979972
Args:
980973
request (Optional[Union[google.cloud.websecurityscanner_v1.types.StopScanRunRequest, dict]]):
981-
The request object. Request for the `StopScanRun`
982-
method.
974+
The request object. Request for the ``StopScanRun`` method.
983975
retry (google.api_core.retry.Retry): Designation of what errors, if any,
984976
should be retried.
985977
timeout (float): The timeout for this request.
@@ -1061,8 +1053,7 @@ async def sample_list_crawled_urls():
10611053
10621054
Args:
10631055
request (Optional[Union[google.cloud.websecurityscanner_v1.types.ListCrawledUrlsRequest, dict]]):
1064-
The request object. Request for the `ListCrawledUrls`
1065-
method.
1056+
The request object. Request for the ``ListCrawledUrls`` method.
10661057
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10671058
should be retried.
10681059
timeout (float): The timeout for this request.
@@ -1161,7 +1152,7 @@ async def sample_get_finding():
11611152
11621153
Args:
11631154
request (Optional[Union[google.cloud.websecurityscanner_v1.types.GetFindingRequest, dict]]):
1164-
The request object. Request for the `GetFinding` method.
1155+
The request object. Request for the ``GetFinding`` method.
11651156
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11661157
should be retried.
11671158
timeout (float): The timeout for this request.
@@ -1251,8 +1242,7 @@ async def sample_list_findings():
12511242
12521243
Args:
12531244
request (Optional[Union[google.cloud.websecurityscanner_v1.types.ListFindingsRequest, dict]]):
1254-
The request object. Request for the `ListFindings`
1255-
method.
1245+
The request object. Request for the ``ListFindings`` method.
12561246
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12571247
should be retried.
12581248
timeout (float): The timeout for this request.
@@ -1353,8 +1343,7 @@ async def sample_list_finding_type_stats():
13531343
13541344
Args:
13551345
request (Optional[Union[google.cloud.websecurityscanner_v1.types.ListFindingTypeStatsRequest, dict]]):
1356-
The request object. Request for the
1357-
`ListFindingTypeStats` method.
1346+
The request object. Request for the ``ListFindingTypeStats`` method.
13581347
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13591348
should be retried.
13601349
timeout (float): The timeout for this request.

google/cloud/websecurityscanner_v1/services/web_security_scanner/client.py

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -500,8 +500,7 @@ def sample_create_scan_config():
500500
501501
Args:
502502
request (Union[google.cloud.websecurityscanner_v1.types.CreateScanConfigRequest, dict]):
503-
The request object. Request for the `CreateScanConfig`
504-
method.
503+
The request object. Request for the ``CreateScanConfig`` method.
505504
retry (google.api_core.retry.Retry): Designation of what errors, if any,
506505
should be retried.
507506
timeout (float): The timeout for this request.
@@ -580,8 +579,7 @@ def sample_delete_scan_config():
580579
581580
Args:
582581
request (Union[google.cloud.websecurityscanner_v1.types.DeleteScanConfigRequest, dict]):
583-
The request object. Request for the `DeleteScanConfig`
584-
method.
582+
The request object. Request for the ``DeleteScanConfig`` method.
585583
retry (google.api_core.retry.Retry): Designation of what errors, if any,
586584
should be retried.
587585
timeout (float): The timeout for this request.
@@ -653,8 +651,7 @@ def sample_get_scan_config():
653651
654652
Args:
655653
request (Union[google.cloud.websecurityscanner_v1.types.GetScanConfigRequest, dict]):
656-
The request object. Request for the `GetScanConfig`
657-
method.
654+
The request object. Request for the ``GetScanConfig`` method.
658655
retry (google.api_core.retry.Retry): Designation of what errors, if any,
659656
should be retried.
660657
timeout (float): The timeout for this request.
@@ -736,8 +733,7 @@ def sample_list_scan_configs():
736733
737734
Args:
738735
request (Union[google.cloud.websecurityscanner_v1.types.ListScanConfigsRequest, dict]):
739-
The request object. Request for the `ListScanConfigs`
740-
method.
736+
The request object. Request for the ``ListScanConfigs`` method.
741737
retry (google.api_core.retry.Retry): Designation of what errors, if any,
742738
should be retried.
743739
timeout (float): The timeout for this request.
@@ -830,8 +826,7 @@ def sample_update_scan_config():
830826
831827
Args:
832828
request (Union[google.cloud.websecurityscanner_v1.types.UpdateScanConfigRequest, dict]):
833-
The request object. Request for the
834-
`UpdateScanConfigRequest` method.
829+
The request object. Request for the ``UpdateScanConfigRequest`` method.
835830
retry (google.api_core.retry.Retry): Designation of what errors, if any,
836831
should be retried.
837832
timeout (float): The timeout for this request.
@@ -912,8 +907,7 @@ def sample_start_scan_run():
912907
913908
Args:
914909
request (Union[google.cloud.websecurityscanner_v1.types.StartScanRunRequest, dict]):
915-
The request object. Request for the `StartScanRun`
916-
method.
910+
The request object. Request for the ``StartScanRun`` method.
917911
retry (google.api_core.retry.Retry): Designation of what errors, if any,
918912
should be retried.
919913
timeout (float): The timeout for this request.
@@ -993,7 +987,7 @@ def sample_get_scan_run():
993987
994988
Args:
995989
request (Union[google.cloud.websecurityscanner_v1.types.GetScanRunRequest, dict]):
996-
The request object. Request for the `GetScanRun` method.
990+
The request object. Request for the ``GetScanRun`` method.
997991
retry (google.api_core.retry.Retry): Designation of what errors, if any,
998992
should be retried.
999993
timeout (float): The timeout for this request.
@@ -1075,8 +1069,7 @@ def sample_list_scan_runs():
10751069
10761070
Args:
10771071
request (Union[google.cloud.websecurityscanner_v1.types.ListScanRunsRequest, dict]):
1078-
The request object. Request for the `ListScanRuns`
1079-
method.
1072+
The request object. Request for the ``ListScanRuns`` method.
10801073
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10811074
should be retried.
10821075
timeout (float): The timeout for this request.
@@ -1166,8 +1159,7 @@ def sample_stop_scan_run():
11661159
11671160
Args:
11681161
request (Union[google.cloud.websecurityscanner_v1.types.StopScanRunRequest, dict]):
1169-
The request object. Request for the `StopScanRun`
1170-
method.
1162+
The request object. Request for the ``StopScanRun`` method.
11711163
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11721164
should be retried.
11731165
timeout (float): The timeout for this request.
@@ -1250,8 +1242,7 @@ def sample_list_crawled_urls():
12501242
12511243
Args:
12521244
request (Union[google.cloud.websecurityscanner_v1.types.ListCrawledUrlsRequest, dict]):
1253-
The request object. Request for the `ListCrawledUrls`
1254-
method.
1245+
The request object. Request for the ``ListCrawledUrls`` method.
12551246
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12561247
should be retried.
12571248
timeout (float): The timeout for this request.
@@ -1341,7 +1332,7 @@ def sample_get_finding():
13411332
13421333
Args:
13431334
request (Union[google.cloud.websecurityscanner_v1.types.GetFindingRequest, dict]):
1344-
The request object. Request for the `GetFinding` method.
1335+
The request object. Request for the ``GetFinding`` method.
13451336
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13461337
should be retried.
13471338
timeout (float): The timeout for this request.
@@ -1422,8 +1413,7 @@ def sample_list_findings():
14221413
14231414
Args:
14241415
request (Union[google.cloud.websecurityscanner_v1.types.ListFindingsRequest, dict]):
1425-
The request object. Request for the `ListFindings`
1426-
method.
1416+
The request object. Request for the ``ListFindings`` method.
14271417
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14281418
should be retried.
14291419
timeout (float): The timeout for this request.
@@ -1515,8 +1505,7 @@ def sample_list_finding_type_stats():
15151505
15161506
Args:
15171507
request (Union[google.cloud.websecurityscanner_v1.types.ListFindingTypeStatsRequest, dict]):
1518-
The request object. Request for the
1519-
`ListFindingTypeStats` method.
1508+
The request object. Request for the ``ListFindingTypeStats`` method.
15201509
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15211510
should be retried.
15221511
timeout (float): The timeout for this request.

google/cloud/websecurityscanner_v1alpha/services/web_security_scanner/async_client.py

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -283,8 +283,7 @@ async def sample_create_scan_config():
283283
284284
Args:
285285
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.CreateScanConfigRequest, dict]]):
286-
The request object. Request for the `CreateScanConfig`
287-
method.
286+
The request object. Request for the ``CreateScanConfig`` method.
288287
parent (:class:`str`):
289288
Required. The parent resource name
290289
where the scan is created, which should
@@ -397,8 +396,7 @@ async def sample_delete_scan_config():
397396
398397
Args:
399398
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.DeleteScanConfigRequest, dict]]):
400-
The request object. Request for the `DeleteScanConfig`
401-
method.
399+
The request object. Request for the ``DeleteScanConfig`` method.
402400
name (:class:`str`):
403401
Required. The resource name of the
404402
ScanConfig to be deleted. The name
@@ -504,8 +502,7 @@ async def sample_get_scan_config():
504502
505503
Args:
506504
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.GetScanConfigRequest, dict]]):
507-
The request object. Request for the `GetScanConfig`
508-
method.
505+
The request object. Request for the ``GetScanConfig`` method.
509506
name (:class:`str`):
510507
Required. The resource name of the
511508
ScanConfig to be returned. The name
@@ -622,8 +619,7 @@ async def sample_list_scan_configs():
622619
623620
Args:
624621
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListScanConfigsRequest, dict]]):
625-
The request object. Request for the `ListScanConfigs`
626-
method.
622+
The request object. Request for the ``ListScanConfigs`` method.
627623
parent (:class:`str`):
628624
Required. The parent resource name,
629625
which should be a project resource name
@@ -754,8 +750,7 @@ async def sample_update_scan_config():
754750
755751
Args:
756752
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.UpdateScanConfigRequest, dict]]):
757-
The request object. Request for the
758-
`UpdateScanConfigRequest` method.
753+
The request object. Request for the ``UpdateScanConfigRequest`` method.
759754
scan_config (:class:`google.cloud.websecurityscanner_v1alpha.types.ScanConfig`):
760755
Required. The ScanConfig to be
761756
updated. The name field must be set to
@@ -872,8 +867,7 @@ async def sample_start_scan_run():
872867
873868
Args:
874869
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.StartScanRunRequest, dict]]):
875-
The request object. Request for the `StartScanRun`
876-
method.
870+
The request object. Request for the ``StartScanRun`` method.
877871
name (:class:`str`):
878872
Required. The resource name of the
879873
ScanConfig to be used. The name follows
@@ -976,7 +970,7 @@ async def sample_get_scan_run():
976970
977971
Args:
978972
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.GetScanRunRequest, dict]]):
979-
The request object. Request for the `GetScanRun` method.
973+
The request object. Request for the ``GetScanRun`` method.
980974
name (:class:`str`):
981975
Required. The resource name of the
982976
ScanRun to be returned. The name follows
@@ -1091,8 +1085,7 @@ async def sample_list_scan_runs():
10911085
10921086
Args:
10931087
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListScanRunsRequest, dict]]):
1094-
The request object. Request for the `ListScanRuns`
1095-
method.
1088+
The request object. Request for the ``ListScanRuns`` method.
10961089
parent (:class:`str`):
10971090
Required. The parent resource name,
10981091
which should be a scan resource name in
@@ -1216,8 +1209,7 @@ async def sample_stop_scan_run():
12161209
12171210
Args:
12181211
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.StopScanRunRequest, dict]]):
1219-
The request object. Request for the `StopScanRun`
1220-
method.
1212+
The request object. Request for the ``StopScanRun`` method.
12211213
name (:class:`str`):
12221214
Required. The resource name of the
12231215
ScanRun to be stopped. The name follows
@@ -1323,8 +1315,7 @@ async def sample_list_crawled_urls():
13231315
13241316
Args:
13251317
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListCrawledUrlsRequest, dict]]):
1326-
The request object. Request for the `ListCrawledUrls`
1327-
method.
1318+
The request object. Request for the ``ListCrawledUrls`` method.
13281319
parent (:class:`str`):
13291320
Required. The parent resource name,
13301321
which should be a scan run resource name
@@ -1448,7 +1439,7 @@ async def sample_get_finding():
14481439
14491440
Args:
14501441
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.GetFindingRequest, dict]]):
1451-
The request object. Request for the `GetFinding` method.
1442+
The request object. Request for the ``GetFinding`` method.
14521443
name (:class:`str`):
14531444
Required. The resource name of the
14541445
Finding to be returned. The name follows
@@ -1565,8 +1556,7 @@ async def sample_list_findings():
15651556
15661557
Args:
15671558
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListFindingsRequest, dict]]):
1568-
The request object. Request for the `ListFindings`
1569-
method.
1559+
The request object. Request for the ``ListFindings`` method.
15701560
parent (:class:`str`):
15711561
Required. The parent resource name,
15721562
which should be a scan run resource name
@@ -1702,8 +1692,7 @@ async def sample_list_finding_type_stats():
17021692
17031693
Args:
17041694
request (Optional[Union[google.cloud.websecurityscanner_v1alpha.types.ListFindingTypeStatsRequest, dict]]):
1705-
The request object. Request for the
1706-
`ListFindingTypeStats` method.
1695+
The request object. Request for the ``ListFindingTypeStats`` method.
17071696
parent (:class:`str`):
17081697
Required. The parent resource name,
17091698
which should be a scan run resource name

0 commit comments

Comments
 (0)