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

Commit 8befe21

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#259)
* 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 30136a4 commit 8befe21

File tree

4 files changed

+38
-76
lines changed

4 files changed

+38
-76
lines changed

‎google/cloud/functions_v1/services/cloud_functions_service/async_client.py

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,7 @@ async def sample_list_functions():
276276
277277
Args:
278278
request (Optional[Union[google.cloud.functions_v1.types.ListFunctionsRequest, dict]]):
279-
The request object. Request for the `ListFunctions`
280-
method.
279+
The request object. Request for the ``ListFunctions`` method.
281280
retry (google.api_core.retry.Retry): Designation of what errors, if any,
282281
should be retried.
283282
timeout (float): The timeout for this request.
@@ -379,8 +378,7 @@ async def sample_get_function():
379378
380379
Args:
381380
request (Optional[Union[google.cloud.functions_v1.types.GetFunctionRequest, dict]]):
382-
The request object. Request for the `GetFunction`
383-
method.
381+
The request object. Request for the ``GetFunction`` method.
384382
name (:class:`str`):
385383
Required. The name of the function
386384
which details should be obtained.
@@ -504,8 +502,7 @@ async def sample_create_function():
504502
505503
Args:
506504
request (Optional[Union[google.cloud.functions_v1.types.CreateFunctionRequest, dict]]):
507-
The request object. Request for the `CreateFunction`
508-
method.
505+
The request object. Request for the ``CreateFunction`` method.
509506
location (:class:`str`):
510507
Required. The project and location in which the function
511508
should be created, specified in the format
@@ -632,8 +629,7 @@ async def sample_update_function():
632629
633630
Args:
634631
request (Optional[Union[google.cloud.functions_v1.types.UpdateFunctionRequest, dict]]):
635-
The request object. Request for the `UpdateFunction`
636-
method.
632+
The request object. Request for the ``UpdateFunction`` method.
637633
function (:class:`google.cloud.functions_v1.types.CloudFunction`):
638634
Required. New version of the
639635
function.
@@ -764,8 +760,7 @@ async def sample_delete_function():
764760
765761
Args:
766762
request (Optional[Union[google.cloud.functions_v1.types.DeleteFunctionRequest, dict]]):
767-
The request object. Request for the `DeleteFunction`
768-
method.
763+
The request object. Request for the ``DeleteFunction`` method.
769764
name (:class:`str`):
770765
Required. The name of the function
771766
which should be deleted.
@@ -899,8 +894,7 @@ async def sample_call_function():
899894
900895
Args:
901896
request (Optional[Union[google.cloud.functions_v1.types.CallFunctionRequest, dict]]):
902-
The request object. Request for the `CallFunction`
903-
method.
897+
The request object. Request for the ``CallFunction`` method.
904898
name (:class:`str`):
905899
Required. The name of the function to
906900
be called.
@@ -1033,8 +1027,7 @@ async def sample_generate_upload_url():
10331027
10341028
Args:
10351029
request (Optional[Union[google.cloud.functions_v1.types.GenerateUploadUrlRequest, dict]]):
1036-
The request object. Request of `GenerateSourceUploadUrl`
1037-
method.
1030+
The request object. Request of ``GenerateSourceUploadUrl`` method.
10381031
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10391032
should be retried.
10401033
timeout (float): The timeout for this request.
@@ -1115,8 +1108,7 @@ async def sample_generate_download_url():
11151108
11161109
Args:
11171110
request (Optional[Union[google.cloud.functions_v1.types.GenerateDownloadUrlRequest, dict]]):
1118-
The request object. Request of `GenerateDownloadUrl`
1119-
method.
1111+
The request object. Request of ``GenerateDownloadUrl`` method.
11201112
retry (google.api_core.retry.Retry): Designation of what errors, if any,
11211113
should be retried.
11221114
timeout (float): The timeout for this request.
@@ -1195,8 +1187,7 @@ async def sample_set_iam_policy():
11951187
11961188
Args:
11971189
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
1198-
The request object. Request message for `SetIamPolicy`
1199-
method.
1190+
The request object. Request message for ``SetIamPolicy`` method.
12001191
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12011192
should be retried.
12021193
timeout (float): The timeout for this request.
@@ -1340,8 +1331,7 @@ async def sample_get_iam_policy():
13401331
13411332
Args:
13421333
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
1343-
The request object. Request message for `GetIamPolicy`
1344-
method.
1334+
The request object. Request message for ``GetIamPolicy`` method.
13451335
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13461336
should be retried.
13471337
timeout (float): The timeout for this request.
@@ -1486,8 +1476,7 @@ async def sample_test_iam_permissions():
14861476
14871477
Args:
14881478
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
1489-
The request object. Request message for
1490-
`TestIamPermissions` method.
1479+
The request object. Request message for ``TestIamPermissions`` method.
14911480
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14921481
should be retried.
14931482
timeout (float): The timeout for this request.

‎google/cloud/functions_v1/services/cloud_functions_service/client.py

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -540,8 +540,7 @@ def sample_list_functions():
540540
541541
Args:
542542
request (Union[google.cloud.functions_v1.types.ListFunctionsRequest, dict]):
543-
The request object. Request for the `ListFunctions`
544-
method.
543+
The request object. Request for the ``ListFunctions`` method.
545544
retry (google.api_core.retry.Retry): Designation of what errors, if any,
546545
should be retried.
547546
timeout (float): The timeout for this request.
@@ -634,8 +633,7 @@ def sample_get_function():
634633
635634
Args:
636635
request (Union[google.cloud.functions_v1.types.GetFunctionRequest, dict]):
637-
The request object. Request for the `GetFunction`
638-
method.
636+
The request object. Request for the ``GetFunction`` method.
639637
name (str):
640638
Required. The name of the function
641639
which details should be obtained.
@@ -749,8 +747,7 @@ def sample_create_function():
749747
750748
Args:
751749
request (Union[google.cloud.functions_v1.types.CreateFunctionRequest, dict]):
752-
The request object. Request for the `CreateFunction`
753-
method.
750+
The request object. Request for the ``CreateFunction`` method.
754751
location (str):
755752
Required. The project and location in which the function
756753
should be created, specified in the format
@@ -877,8 +874,7 @@ def sample_update_function():
877874
878875
Args:
879876
request (Union[google.cloud.functions_v1.types.UpdateFunctionRequest, dict]):
880-
The request object. Request for the `UpdateFunction`
881-
method.
877+
The request object. Request for the ``UpdateFunction`` method.
882878
function (google.cloud.functions_v1.types.CloudFunction):
883879
Required. New version of the
884880
function.
@@ -999,8 +995,7 @@ def sample_delete_function():
999995
1000996
Args:
1001997
request (Union[google.cloud.functions_v1.types.DeleteFunctionRequest, dict]):
1002-
The request object. Request for the `DeleteFunction`
1003-
method.
998+
The request object. Request for the ``DeleteFunction`` method.
1004999
name (str):
10051000
Required. The name of the function
10061001
which should be deleted.
@@ -1124,8 +1119,7 @@ def sample_call_function():
11241119
11251120
Args:
11261121
request (Union[google.cloud.functions_v1.types.CallFunctionRequest, dict]):
1127-
The request object. Request for the `CallFunction`
1128-
method.
1122+
The request object. Request for the ``CallFunction`` method.
11291123
name (str):
11301124
Required. The name of the function to
11311125
be called.
@@ -1258,8 +1252,7 @@ def sample_generate_upload_url():
12581252
12591253
Args:
12601254
request (Union[google.cloud.functions_v1.types.GenerateUploadUrlRequest, dict]):
1261-
The request object. Request of `GenerateSourceUploadUrl`
1262-
method.
1255+
The request object. Request of ``GenerateSourceUploadUrl`` method.
12631256
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12641257
should be retried.
12651258
timeout (float): The timeout for this request.
@@ -1341,8 +1334,7 @@ def sample_generate_download_url():
13411334
13421335
Args:
13431336
request (Union[google.cloud.functions_v1.types.GenerateDownloadUrlRequest, dict]):
1344-
The request object. Request of `GenerateDownloadUrl`
1345-
method.
1337+
The request object. Request of ``GenerateDownloadUrl`` method.
13461338
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13471339
should be retried.
13481340
timeout (float): The timeout for this request.
@@ -1422,8 +1414,7 @@ def sample_set_iam_policy():
14221414
14231415
Args:
14241416
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
1425-
The request object. Request message for `SetIamPolicy`
1426-
method.
1417+
The request object. Request message for ``SetIamPolicy`` method.
14271418
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14281419
should be retried.
14291420
timeout (float): The timeout for this request.
@@ -1566,8 +1557,7 @@ def sample_get_iam_policy():
15661557
15671558
Args:
15681559
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
1569-
The request object. Request message for `GetIamPolicy`
1570-
method.
1560+
The request object. Request message for ``GetIamPolicy`` method.
15711561
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15721562
should be retried.
15731563
timeout (float): The timeout for this request.
@@ -1711,8 +1701,7 @@ def sample_test_iam_permissions():
17111701
17121702
Args:
17131703
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
1714-
The request object. Request message for
1715-
`TestIamPermissions` method.
1704+
The request object. Request message for ``TestIamPermissions`` method.
17161705
retry (google.api_core.retry.Retry): Designation of what errors, if any,
17171706
should be retried.
17181707
timeout (float): The timeout for this request.

‎google/cloud/functions_v2/services/function_service/async_client.py

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,7 @@ async def sample_get_function():
288288
289289
Args:
290290
request (Optional[Union[google.cloud.functions_v2.types.GetFunctionRequest, dict]]):
291-
The request object. Request for the `GetFunction`
292-
method.
291+
The request object. Request for the ``GetFunction`` method.
293292
name (:class:`str`):
294293
Required. The name of the function
295294
which details should be obtained.
@@ -394,8 +393,7 @@ async def sample_list_functions():
394393
395394
Args:
396395
request (Optional[Union[google.cloud.functions_v2.types.ListFunctionsRequest, dict]]):
397-
The request object. Request for the `ListFunctions`
398-
method.
396+
The request object. Request for the ``ListFunctions`` method.
399397
parent (:class:`str`):
400398
Required. The project and location from which the
401399
function should be listed, specified in the format
@@ -521,8 +519,7 @@ async def sample_create_function():
521519
522520
Args:
523521
request (Optional[Union[google.cloud.functions_v2.types.CreateFunctionRequest, dict]]):
524-
The request object. Request for the `CreateFunction`
525-
method.
522+
The request object. Request for the ``CreateFunction`` method.
526523
parent (:class:`str`):
527524
Required. The project and location in which the function
528525
should be created, specified in the format
@@ -658,8 +655,7 @@ async def sample_update_function():
658655
659656
Args:
660657
request (Optional[Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]]):
661-
The request object. Request for the `UpdateFunction`
662-
method.
658+
The request object. Request for the ``UpdateFunction`` method.
663659
function (:class:`google.cloud.functions_v2.types.Function`):
664660
Required. New version of the
665661
function.
@@ -791,8 +787,7 @@ async def sample_delete_function():
791787
792788
Args:
793789
request (Optional[Union[google.cloud.functions_v2.types.DeleteFunctionRequest, dict]]):
794-
The request object. Request for the `DeleteFunction`
795-
method.
790+
The request object. Request for the ``DeleteFunction`` method.
796791
name (:class:`str`):
797792
Required. The name of the function
798793
which should be deleted.
@@ -935,8 +930,7 @@ async def sample_generate_upload_url():
935930
936931
Args:
937932
request (Optional[Union[google.cloud.functions_v2.types.GenerateUploadUrlRequest, dict]]):
938-
The request object. Request of `GenerateSourceUploadUrl`
939-
method.
933+
The request object. Request of ``GenerateSourceUploadUrl`` method.
940934
retry (google.api_core.retry.Retry): Designation of what errors, if any,
941935
should be retried.
942936
timeout (float): The timeout for this request.
@@ -1018,8 +1012,7 @@ async def sample_generate_download_url():
10181012
10191013
Args:
10201014
request (Optional[Union[google.cloud.functions_v2.types.GenerateDownloadUrlRequest, dict]]):
1021-
The request object. Request of `GenerateDownloadUrl`
1022-
method.
1015+
The request object. Request of ``GenerateDownloadUrl`` method.
10231016
retry (google.api_core.retry.Retry): Designation of what errors, if any,
10241017
should be retried.
10251018
timeout (float): The timeout for this request.
@@ -1098,8 +1091,7 @@ async def sample_list_runtimes():
10981091
10991092
Args:
11001093
request (Optional[Union[google.cloud.functions_v2.types.ListRuntimesRequest, dict]]):
1101-
The request object. Request for the `ListRuntimes`
1102-
method.
1094+
The request object. Request for the ``ListRuntimes`` method.
11031095
parent (:class:`str`):
11041096
Required. The project and location from which the
11051097
runtimes should be listed, specified in the format

‎google/cloud/functions_v2/services/function_service/client.py

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -698,8 +698,7 @@ def sample_get_function():
698698
699699
Args:
700700
request (Union[google.cloud.functions_v2.types.GetFunctionRequest, dict]):
701-
The request object. Request for the `GetFunction`
702-
method.
701+
The request object. Request for the ``GetFunction`` method.
703702
name (str):
704703
Required. The name of the function
705704
which details should be obtained.
@@ -804,8 +803,7 @@ def sample_list_functions():
804803
805804
Args:
806805
request (Union[google.cloud.functions_v2.types.ListFunctionsRequest, dict]):
807-
The request object. Request for the `ListFunctions`
808-
method.
806+
The request object. Request for the ``ListFunctions`` method.
809807
parent (str):
810808
Required. The project and location from which the
811809
function should be listed, specified in the format
@@ -931,8 +929,7 @@ def sample_create_function():
931929
932930
Args:
933931
request (Union[google.cloud.functions_v2.types.CreateFunctionRequest, dict]):
934-
The request object. Request for the `CreateFunction`
935-
method.
932+
The request object. Request for the ``CreateFunction`` method.
936933
parent (str):
937934
Required. The project and location in which the function
938935
should be created, specified in the format
@@ -1068,8 +1065,7 @@ def sample_update_function():
10681065
10691066
Args:
10701067
request (Union[google.cloud.functions_v2.types.UpdateFunctionRequest, dict]):
1071-
The request object. Request for the `UpdateFunction`
1072-
method.
1068+
The request object. Request for the ``UpdateFunction`` method.
10731069
function (google.cloud.functions_v2.types.Function):
10741070
Required. New version of the
10751071
function.
@@ -1201,8 +1197,7 @@ def sample_delete_function():
12011197
12021198
Args:
12031199
request (Union[google.cloud.functions_v2.types.DeleteFunctionRequest, dict]):
1204-
The request object. Request for the `DeleteFunction`
1205-
method.
1200+
The request object. Request for the ``DeleteFunction`` method.
12061201
name (str):
12071202
Required. The name of the function
12081203
which should be deleted.
@@ -1345,8 +1340,7 @@ def sample_generate_upload_url():
13451340
13461341
Args:
13471342
request (Union[google.cloud.functions_v2.types.GenerateUploadUrlRequest, dict]):
1348-
The request object. Request of `GenerateSourceUploadUrl`
1349-
method.
1343+
The request object. Request of ``GenerateSourceUploadUrl`` method.
13501344
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13511345
should be retried.
13521346
timeout (float): The timeout for this request.
@@ -1429,8 +1423,7 @@ def sample_generate_download_url():
14291423
14301424
Args:
14311425
request (Union[google.cloud.functions_v2.types.GenerateDownloadUrlRequest, dict]):
1432-
The request object. Request of `GenerateDownloadUrl`
1433-
method.
1426+
The request object. Request of ``GenerateDownloadUrl`` method.
14341427
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14351428
should be retried.
14361429
timeout (float): The timeout for this request.
@@ -1510,8 +1503,7 @@ def sample_list_runtimes():
15101503
15111504
Args:
15121505
request (Union[google.cloud.functions_v2.types.ListRuntimesRequest, dict]):
1513-
The request object. Request for the `ListRuntimes`
1514-
method.
1506+
The request object. Request for the ``ListRuntimes`` method.
15151507
parent (str):
15161508
Required. The project and location from which the
15171509
runtimes should be listed, specified in the format

0 commit comments

Comments
 (0)