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

Commit 17b64b8

Browse files
docs: Fix formatting of request arg in docstring (#268)
* 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 fd2b003 commit 17b64b8

File tree

6 files changed

+50
-94
lines changed

6 files changed

+50
-94
lines changed

google/cloud/recommender_v1/services/recommender/async_client.py

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,7 @@ async def sample_list_insights():
288288
289289
Args:
290290
request (Optional[Union[google.cloud.recommender_v1.types.ListInsightsRequest, dict]]):
291-
The request object. Request for the `ListInsights`
292-
method.
291+
The request object. Request for the ``ListInsights`` method.
293292
parent (:class:`str`):
294293
Required. The container resource on which to execute the
295294
request. Acceptable formats:
@@ -427,7 +426,7 @@ async def sample_get_insight():
427426
428427
Args:
429428
request (Optional[Union[google.cloud.recommender_v1.types.GetInsightRequest, dict]]):
430-
The request object. Request to the `GetInsight` method.
429+
The request object. Request to the ``GetInsight`` method.
431430
name (:class:`str`):
432431
Required. Name of the insight.
433432
This corresponds to the ``name`` field
@@ -550,8 +549,7 @@ async def sample_mark_insight_accepted():
550549
551550
Args:
552551
request (Optional[Union[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest, dict]]):
553-
The request object. Request for the
554-
`MarkInsightAccepted` method.
552+
The request object. Request for the ``MarkInsightAccepted`` method.
555553
name (:class:`str`):
556554
Required. Name of the insight.
557555
This corresponds to the ``name`` field
@@ -677,8 +675,7 @@ async def sample_list_recommendations():
677675
678676
Args:
679677
request (Optional[Union[google.cloud.recommender_v1.types.ListRecommendationsRequest, dict]]):
680-
The request object. Request for the
681-
`ListRecommendations` method.
678+
The request object. Request for the ``ListRecommendations`` method.
682679
parent (:class:`str`):
683680
Required. The container resource on which to execute the
684681
request. Acceptable formats:
@@ -846,8 +843,7 @@ async def sample_get_recommendation():
846843
847844
Args:
848845
request (Optional[Union[google.cloud.recommender_v1.types.GetRecommendationRequest, dict]]):
849-
The request object. Request to the `GetRecommendation`
850-
method.
846+
The request object. Request to the ``GetRecommendation`` method.
851847
name (:class:`str`):
852848
Required. Name of the recommendation.
853849
This corresponds to the ``name`` field
@@ -973,8 +969,7 @@ async def sample_mark_recommendation_claimed():
973969
974970
Args:
975971
request (Optional[Union[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest, dict]]):
976-
The request object. Request for the
977-
`MarkRecommendationClaimed` Method.
972+
The request object. Request for the ``MarkRecommendationClaimed`` Method.
978973
name (:class:`str`):
979974
Required. Name of the recommendation.
980975
This corresponds to the ``name`` field
@@ -1112,8 +1107,7 @@ async def sample_mark_recommendation_succeeded():
11121107
11131108
Args:
11141109
request (Optional[Union[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest, dict]]):
1115-
The request object. Request for the
1116-
`MarkRecommendationSucceeded` Method.
1110+
The request object. Request for the ``MarkRecommendationSucceeded`` Method.
11171111
name (:class:`str`):
11181112
Required. Name of the recommendation.
11191113
This corresponds to the ``name`` field
@@ -1251,8 +1245,7 @@ async def sample_mark_recommendation_failed():
12511245
12521246
Args:
12531247
request (Optional[Union[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest, dict]]):
1254-
The request object. Request for the
1255-
`MarkRecommendationFailed` Method.
1248+
The request object. Request for the ``MarkRecommendationFailed`` Method.
12561249
name (:class:`str`):
12571250
Required. Name of the recommendation.
12581251
This corresponds to the ``name`` field
@@ -1378,8 +1371,7 @@ async def sample_get_recommender_config():
13781371
13791372
Args:
13801373
request (Optional[Union[google.cloud.recommender_v1.types.GetRecommenderConfigRequest, dict]]):
1381-
The request object. Request for the
1382-
GetRecommenderConfig` method.
1374+
The request object. Request for the GetRecommenderConfig\` method.
13831375
name (:class:`str`):
13841376
Required. Name of the Recommendation Config to get.
13851377
@@ -1488,8 +1480,7 @@ async def sample_update_recommender_config():
14881480
14891481
Args:
14901482
request (Optional[Union[google.cloud.recommender_v1.types.UpdateRecommenderConfigRequest, dict]]):
1491-
The request object. Request for the
1492-
`UpdateRecommenderConfig` method.
1483+
The request object. Request for the ``UpdateRecommenderConfig`` method.
14931484
recommender_config (:class:`google.cloud.recommender_v1.types.RecommenderConfig`):
14941485
Required. The RecommenderConfig to
14951486
update.
@@ -1600,8 +1591,7 @@ async def sample_get_insight_type_config():
16001591
16011592
Args:
16021593
request (Optional[Union[google.cloud.recommender_v1.types.GetInsightTypeConfigRequest, dict]]):
1603-
The request object. Request for the
1604-
GetInsightTypeConfig` method.
1594+
The request object. Request for the GetInsightTypeConfig\` method.
16051595
name (:class:`str`):
16061596
Required. Name of the InsightTypeConfig to get.
16071597
@@ -1710,8 +1700,7 @@ async def sample_update_insight_type_config():
17101700
17111701
Args:
17121702
request (Optional[Union[google.cloud.recommender_v1.types.UpdateInsightTypeConfigRequest, dict]]):
1713-
The request object. Request for the
1714-
`UpdateInsightTypeConfig` method.
1703+
The request object. Request for the ``UpdateInsightTypeConfig`` method.
17151704
insight_type_config (:class:`google.cloud.recommender_v1.types.InsightTypeConfig`):
17161705
Required. The InsightTypeConfig to
17171706
update.

google/cloud/recommender_v1/services/recommender/client.py

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,7 @@ def sample_list_insights():
619619
620620
Args:
621621
request (Union[google.cloud.recommender_v1.types.ListInsightsRequest, dict]):
622-
The request object. Request for the `ListInsights`
623-
method.
622+
The request object. Request for the ``ListInsights`` method.
624623
parent (str):
625624
Required. The container resource on which to execute the
626625
request. Acceptable formats:
@@ -748,7 +747,7 @@ def sample_get_insight():
748747
749748
Args:
750749
request (Union[google.cloud.recommender_v1.types.GetInsightRequest, dict]):
751-
The request object. Request to the `GetInsight` method.
750+
The request object. Request to the ``GetInsight`` method.
752751
name (str):
753752
Required. Name of the insight.
754753
This corresponds to the ``name`` field
@@ -861,8 +860,7 @@ def sample_mark_insight_accepted():
861860
862861
Args:
863862
request (Union[google.cloud.recommender_v1.types.MarkInsightAcceptedRequest, dict]):
864-
The request object. Request for the
865-
`MarkInsightAccepted` method.
863+
The request object. Request for the ``MarkInsightAccepted`` method.
866864
name (str):
867865
Required. Name of the insight.
868866
This corresponds to the ``name`` field
@@ -987,8 +985,7 @@ def sample_list_recommendations():
987985
988986
Args:
989987
request (Union[google.cloud.recommender_v1.types.ListRecommendationsRequest, dict]):
990-
The request object. Request for the
991-
`ListRecommendations` method.
988+
The request object. Request for the ``ListRecommendations`` method.
992989
parent (str):
993990
Required. The container resource on which to execute the
994991
request. Acceptable formats:
@@ -1146,8 +1143,7 @@ def sample_get_recommendation():
11461143
11471144
Args:
11481145
request (Union[google.cloud.recommender_v1.types.GetRecommendationRequest, dict]):
1149-
The request object. Request to the `GetRecommendation`
1150-
method.
1146+
The request object. Request to the ``GetRecommendation`` method.
11511147
name (str):
11521148
Required. Name of the recommendation.
11531149
This corresponds to the ``name`` field
@@ -1263,8 +1259,7 @@ def sample_mark_recommendation_claimed():
12631259
12641260
Args:
12651261
request (Union[google.cloud.recommender_v1.types.MarkRecommendationClaimedRequest, dict]):
1266-
The request object. Request for the
1267-
`MarkRecommendationClaimed` Method.
1262+
The request object. Request for the ``MarkRecommendationClaimed`` Method.
12681263
name (str):
12691264
Required. Name of the recommendation.
12701265
This corresponds to the ``name`` field
@@ -1405,8 +1400,7 @@ def sample_mark_recommendation_succeeded():
14051400
14061401
Args:
14071402
request (Union[google.cloud.recommender_v1.types.MarkRecommendationSucceededRequest, dict]):
1408-
The request object. Request for the
1409-
`MarkRecommendationSucceeded` Method.
1403+
The request object. Request for the ``MarkRecommendationSucceeded`` Method.
14101404
name (str):
14111405
Required. Name of the recommendation.
14121406
This corresponds to the ``name`` field
@@ -1547,8 +1541,7 @@ def sample_mark_recommendation_failed():
15471541
15481542
Args:
15491543
request (Union[google.cloud.recommender_v1.types.MarkRecommendationFailedRequest, dict]):
1550-
The request object. Request for the
1551-
`MarkRecommendationFailed` Method.
1544+
The request object. Request for the ``MarkRecommendationFailed`` Method.
15521545
name (str):
15531546
Required. Name of the recommendation.
15541547
This corresponds to the ``name`` field
@@ -1675,8 +1668,7 @@ def sample_get_recommender_config():
16751668
16761669
Args:
16771670
request (Union[google.cloud.recommender_v1.types.GetRecommenderConfigRequest, dict]):
1678-
The request object. Request for the
1679-
GetRecommenderConfig` method.
1671+
The request object. Request for the GetRecommenderConfig\` method.
16801672
name (str):
16811673
Required. Name of the Recommendation Config to get.
16821674
@@ -1785,8 +1777,7 @@ def sample_update_recommender_config():
17851777
17861778
Args:
17871779
request (Union[google.cloud.recommender_v1.types.UpdateRecommenderConfigRequest, dict]):
1788-
The request object. Request for the
1789-
`UpdateRecommenderConfig` method.
1780+
The request object. Request for the ``UpdateRecommenderConfig`` method.
17901781
recommender_config (google.cloud.recommender_v1.types.RecommenderConfig):
17911782
Required. The RecommenderConfig to
17921783
update.
@@ -1899,8 +1890,7 @@ def sample_get_insight_type_config():
18991890
19001891
Args:
19011892
request (Union[google.cloud.recommender_v1.types.GetInsightTypeConfigRequest, dict]):
1902-
The request object. Request for the
1903-
GetInsightTypeConfig` method.
1893+
The request object. Request for the GetInsightTypeConfig\` method.
19041894
name (str):
19051895
Required. Name of the InsightTypeConfig to get.
19061896
@@ -2009,8 +1999,7 @@ def sample_update_insight_type_config():
20091999
20102000
Args:
20112001
request (Union[google.cloud.recommender_v1.types.UpdateInsightTypeConfigRequest, dict]):
2012-
The request object. Request for the
2013-
`UpdateInsightTypeConfig` method.
2002+
The request object. Request for the ``UpdateInsightTypeConfig`` method.
20142003
insight_type_config (google.cloud.recommender_v1.types.InsightTypeConfig):
20152004
Required. The InsightTypeConfig to
20162005
update.

google/cloud/recommender_v1beta1/services/recommender/async_client.py

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,7 @@ async def sample_list_insights():
288288
289289
Args:
290290
request (Optional[Union[google.cloud.recommender_v1beta1.types.ListInsightsRequest, dict]]):
291-
The request object. Request for the `ListInsights`
292-
method.
291+
The request object. Request for the ``ListInsights`` method.
293292
parent (:class:`str`):
294293
Required. The container resource on which to execute the
295294
request. Acceptable formats:
@@ -427,7 +426,7 @@ async def sample_get_insight():
427426
428427
Args:
429428
request (Optional[Union[google.cloud.recommender_v1beta1.types.GetInsightRequest, dict]]):
430-
The request object. Request to the `GetInsight` method.
429+
The request object. Request to the ``GetInsight`` method.
431430
name (:class:`str`):
432431
Required. Name of the insight.
433432
This corresponds to the ``name`` field
@@ -550,8 +549,7 @@ async def sample_mark_insight_accepted():
550549
551550
Args:
552551
request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest, dict]]):
553-
The request object. Request for the
554-
`MarkInsightAccepted` method.
552+
The request object. Request for the ``MarkInsightAccepted`` method.
555553
name (:class:`str`):
556554
Required. Name of the insight.
557555
This corresponds to the ``name`` field
@@ -677,8 +675,7 @@ async def sample_list_recommendations():
677675
678676
Args:
679677
request (Optional[Union[google.cloud.recommender_v1beta1.types.ListRecommendationsRequest, dict]]):
680-
The request object. Request for the
681-
`ListRecommendations` method.
678+
The request object. Request for the ``ListRecommendations`` method.
682679
parent (:class:`str`):
683680
Required. The container resource on which to execute the
684681
request. Acceptable formats:
@@ -846,8 +843,7 @@ async def sample_get_recommendation():
846843
847844
Args:
848845
request (Optional[Union[google.cloud.recommender_v1beta1.types.GetRecommendationRequest, dict]]):
849-
The request object. Request to the `GetRecommendation`
850-
method.
846+
The request object. Request to the ``GetRecommendation`` method.
851847
name (:class:`str`):
852848
Required. Name of the recommendation.
853849
This corresponds to the ``name`` field
@@ -973,8 +969,7 @@ async def sample_mark_recommendation_claimed():
973969
974970
Args:
975971
request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest, dict]]):
976-
The request object. Request for the
977-
`MarkRecommendationClaimed` Method.
972+
The request object. Request for the ``MarkRecommendationClaimed`` Method.
978973
name (:class:`str`):
979974
Required. Name of the recommendation.
980975
This corresponds to the ``name`` field
@@ -1112,8 +1107,7 @@ async def sample_mark_recommendation_succeeded():
11121107
11131108
Args:
11141109
request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest, dict]]):
1115-
The request object. Request for the
1116-
`MarkRecommendationSucceeded` Method.
1110+
The request object. Request for the ``MarkRecommendationSucceeded`` Method.
11171111
name (:class:`str`):
11181112
Required. Name of the recommendation.
11191113
This corresponds to the ``name`` field
@@ -1251,8 +1245,7 @@ async def sample_mark_recommendation_failed():
12511245
12521246
Args:
12531247
request (Optional[Union[google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest, dict]]):
1254-
The request object. Request for the
1255-
`MarkRecommendationFailed` Method.
1248+
The request object. Request for the ``MarkRecommendationFailed`` Method.
12561249
name (:class:`str`):
12571250
Required. Name of the recommendation.
12581251
This corresponds to the ``name`` field
@@ -1378,8 +1371,7 @@ async def sample_get_recommender_config():
13781371
13791372
Args:
13801373
request (Optional[Union[google.cloud.recommender_v1beta1.types.GetRecommenderConfigRequest, dict]]):
1381-
The request object. Request for the
1382-
GetRecommenderConfig` method.
1374+
The request object. Request for the GetRecommenderConfig\` method.
13831375
name (:class:`str`):
13841376
Required. Name of the Recommendation Config to get.
13851377
@@ -1488,8 +1480,7 @@ async def sample_update_recommender_config():
14881480
14891481
Args:
14901482
request (Optional[Union[google.cloud.recommender_v1beta1.types.UpdateRecommenderConfigRequest, dict]]):
1491-
The request object. Request for the
1492-
`UpdateRecommenderConfig` method.
1483+
The request object. Request for the ``UpdateRecommenderConfig`` method.
14931484
recommender_config (:class:`google.cloud.recommender_v1beta1.types.RecommenderConfig`):
14941485
Required. The RecommenderConfig to
14951486
update.
@@ -1600,8 +1591,7 @@ async def sample_get_insight_type_config():
16001591
16011592
Args:
16021593
request (Optional[Union[google.cloud.recommender_v1beta1.types.GetInsightTypeConfigRequest, dict]]):
1603-
The request object. Request for the
1604-
GetInsightTypeConfig` method.
1594+
The request object. Request for the GetInsightTypeConfig\` method.
16051595
name (:class:`str`):
16061596
Required. Name of the InsightTypeConfig to get.
16071597
@@ -1710,8 +1700,7 @@ async def sample_update_insight_type_config():
17101700
17111701
Args:
17121702
request (Optional[Union[google.cloud.recommender_v1beta1.types.UpdateInsightTypeConfigRequest, dict]]):
1713-
The request object. Request for the
1714-
`UpdateInsightTypeConfig` method.
1703+
The request object. Request for the ``UpdateInsightTypeConfig`` method.
17151704
insight_type_config (:class:`google.cloud.recommender_v1beta1.types.InsightTypeConfig`):
17161705
Required. The InsightTypeConfig to
17171706
update.

0 commit comments

Comments
 (0)