Skip to content

Commit ee2ea73

Browse files
acocuzzogcf-owl-bot[bot]
acocuzzo
and
gcf-owl-bot[bot]
authored
docs: Fix formatting of request arg in docstring (#894)
* chore: Update gapic-generator-python to v1.8.5 PiperOrigin-RevId: 511892190 Source-Link: googleapis/googleapis@a45d9c0 Source-Link: googleapis/googleapis-gen@1907294 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkwNzI5NGIxZDgzNjVlYTI0ZjhjNWYyZTA1OWE2NDEyNGM0ZWQzYiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * remove rest.py * chore: Update gapic-generator-python to v1.9.0 PiperOrigin-RevId: 517425588 Source-Link: googleapis/googleapis@33c93eb Source-Link: googleapis/googleapis-gen@d5f5978 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDVmNTk3ODlkMTlmYzQzMjcwZmYyMTI0OTY3ZDRlYzg5OTJiOGU4ZiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 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: googleapis/googleapis-gen@b2ab4b0 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 8c590cf commit ee2ea73

File tree

9 files changed

+55
-81
lines changed

9 files changed

+55
-81
lines changed

‎google/pubsub_v1/services/publisher/async_client.py‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@ async def sample_list_topics():
740740
741741
Args:
742742
request (Optional[Union[google.pubsub_v1.types.ListTopicsRequest, dict]]):
743-
The request object. Request for the `ListTopics` method.
743+
The request object. Request for the ``ListTopics`` method.
744744
project (:class:`str`):
745745
Required. The name of the project in which to list
746746
topics. Format is ``projects/{project-id}``.
@@ -866,8 +866,7 @@ async def sample_list_topic_subscriptions():
866866
867867
Args:
868868
request (Optional[Union[google.pubsub_v1.types.ListTopicSubscriptionsRequest, dict]]):
869-
The request object. Request for the
870-
`ListTopicSubscriptions` method.
869+
The request object. Request for the ``ListTopicSubscriptions`` method.
871870
topic (:class:`str`):
872871
Required. The name of the topic that subscriptions are
873872
attached to. Format is
@@ -998,8 +997,7 @@ async def sample_list_topic_snapshots():
998997
999998
Args:
1000999
request (Optional[Union[google.pubsub_v1.types.ListTopicSnapshotsRequest, dict]]):
1001-
The request object. Request for the `ListTopicSnapshots`
1002-
method.
1000+
The request object. Request for the ``ListTopicSnapshots`` method.
10031001
topic (:class:`str`):
10041002
Required. The name of the topic that snapshots are
10051003
attached to. Format is
@@ -1126,8 +1124,7 @@ async def sample_delete_topic():
11261124
11271125
Args:
11281126
request (Optional[Union[google.pubsub_v1.types.DeleteTopicRequest, dict]]):
1129-
The request object. Request for the `DeleteTopic`
1130-
method.
1127+
The request object. Request for the ``DeleteTopic`` method.
11311128
topic (:class:`str`):
11321129
Required. Name of the topic to delete. Format is
11331130
``projects/{project}/topics/{topic}``.

‎google/pubsub_v1/services/publisher/client.py‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -976,7 +976,7 @@ def sample_list_topics():
976976
977977
Args:
978978
request (Union[google.pubsub_v1.types.ListTopicsRequest, dict]):
979-
The request object. Request for the `ListTopics` method.
979+
The request object. Request for the ``ListTopics`` method.
980980
project (str):
981981
Required. The name of the project in which to list
982982
topics. Format is ``projects/{project-id}``.
@@ -1091,8 +1091,7 @@ def sample_list_topic_subscriptions():
10911091
10921092
Args:
10931093
request (Union[google.pubsub_v1.types.ListTopicSubscriptionsRequest, dict]):
1094-
The request object. Request for the
1095-
`ListTopicSubscriptions` method.
1094+
The request object. Request for the ``ListTopicSubscriptions`` method.
10961095
topic (str):
10971096
Required. The name of the topic that subscriptions are
10981097
attached to. Format is
@@ -1212,8 +1211,7 @@ def sample_list_topic_snapshots():
12121211
12131212
Args:
12141213
request (Union[google.pubsub_v1.types.ListTopicSnapshotsRequest, dict]):
1215-
The request object. Request for the `ListTopicSnapshots`
1216-
method.
1214+
The request object. Request for the ``ListTopicSnapshots`` method.
12171215
topic (str):
12181216
Required. The name of the topic that snapshots are
12191217
attached to. Format is
@@ -1329,8 +1327,7 @@ def sample_delete_topic():
13291327
13301328
Args:
13311329
request (Union[google.pubsub_v1.types.DeleteTopicRequest, dict]):
1332-
The request object. Request for the `DeleteTopic`
1333-
method.
1330+
The request object. Request for the ``DeleteTopic`` method.
13341331
topic (str):
13351332
Required. Name of the topic to delete. Format is
13361333
``projects/{project}/topics/{topic}``.

‎google/pubsub_v1/services/schema_service/async_client.py‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -486,8 +486,7 @@ async def sample_list_schemas():
486486
487487
Args:
488488
request (Optional[Union[google.pubsub_v1.types.ListSchemasRequest, dict]]):
489-
The request object. Request for the `ListSchemas`
490-
method.
489+
The request object. Request for the ``ListSchemas`` method.
491490
parent (:class:`str`):
492491
Required. The name of the project in which to list
493492
schemas. Format is ``projects/{project-id}``.
@@ -600,8 +599,7 @@ async def sample_list_schema_revisions():
600599
601600
Args:
602601
request (Optional[Union[google.pubsub_v1.types.ListSchemaRevisionsRequest, dict]]):
603-
The request object. Request for the
604-
`ListSchemaRevisions` method.
602+
The request object. Request for the ``ListSchemaRevisions`` method.
605603
name (:class:`str`):
606604
Required. The name of the schema to
607605
list revisions for.
@@ -829,8 +827,7 @@ async def sample_rollback_schema():
829827
830828
Args:
831829
request (Optional[Union[google.pubsub_v1.types.RollbackSchemaRequest, dict]]):
832-
The request object. Request for the `RollbackSchema`
833-
method.
830+
The request object. Request for the ``RollbackSchema`` method.
834831
name (:class:`str`):
835832
Required. The schema being rolled
836833
back with revision id.
@@ -941,8 +938,7 @@ async def sample_delete_schema_revision():
941938
942939
Args:
943940
request (Optional[Union[google.pubsub_v1.types.DeleteSchemaRevisionRequest, dict]]):
944-
The request object. Request for the
945-
`DeleteSchemaRevision` method.
941+
The request object. Request for the ``DeleteSchemaRevision`` method.
946942
name (:class:`str`):
947943
Required. The name of the schema revision to be deleted,
948944
with a revision ID explicitly included.
@@ -1050,8 +1046,7 @@ async def sample_delete_schema():
10501046
10511047
Args:
10521048
request (Optional[Union[google.pubsub_v1.types.DeleteSchemaRequest, dict]]):
1053-
The request object. Request for the `DeleteSchema`
1054-
method.
1049+
The request object. Request for the ``DeleteSchema`` method.
10551050
name (:class:`str`):
10561051
Required. Name of the schema to delete. Format is
10571052
``projects/{project}/schemas/{schema}``.
@@ -1148,8 +1143,7 @@ async def sample_validate_schema():
11481143
11491144
Args:
11501145
request (Optional[Union[google.pubsub_v1.types.ValidateSchemaRequest, dict]]):
1151-
The request object. Request for the `ValidateSchema`
1152-
method.
1146+
The request object. Request for the ``ValidateSchema`` method.
11531147
parent (:class:`str`):
11541148
Required. The name of the project in which to validate
11551149
schemas. Format is ``projects/{project-id}``.
@@ -1259,8 +1253,7 @@ async def sample_validate_message():
12591253
12601254
Args:
12611255
request (Optional[Union[google.pubsub_v1.types.ValidateMessageRequest, dict]]):
1262-
The request object. Request for the `ValidateMessage`
1263-
method.
1256+
The request object. Request for the ``ValidateMessage`` method.
12641257
retry (google.api_core.retry.Retry): Designation of what errors, if any,
12651258
should be retried.
12661259
timeout (float): The timeout for this request.

‎google/pubsub_v1/services/schema_service/client.py‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -718,8 +718,7 @@ def sample_list_schemas():
718718
719719
Args:
720720
request (Union[google.pubsub_v1.types.ListSchemasRequest, dict]):
721-
The request object. Request for the `ListSchemas`
722-
method.
721+
The request object. Request for the ``ListSchemas`` method.
723722
parent (str):
724723
Required. The name of the project in which to list
725724
schemas. Format is ``projects/{project-id}``.
@@ -832,8 +831,7 @@ def sample_list_schema_revisions():
832831
833832
Args:
834833
request (Union[google.pubsub_v1.types.ListSchemaRevisionsRequest, dict]):
835-
The request object. Request for the
836-
`ListSchemaRevisions` method.
834+
The request object. Request for the ``ListSchemaRevisions`` method.
837835
name (str):
838836
Required. The name of the schema to
839837
list revisions for.
@@ -1061,8 +1059,7 @@ def sample_rollback_schema():
10611059
10621060
Args:
10631061
request (Union[google.pubsub_v1.types.RollbackSchemaRequest, dict]):
1064-
The request object. Request for the `RollbackSchema`
1065-
method.
1062+
The request object. Request for the ``RollbackSchema`` method.
10661063
name (str):
10671064
Required. The schema being rolled
10681065
back with revision id.
@@ -1173,8 +1170,7 @@ def sample_delete_schema_revision():
11731170
11741171
Args:
11751172
request (Union[google.pubsub_v1.types.DeleteSchemaRevisionRequest, dict]):
1176-
The request object. Request for the
1177-
`DeleteSchemaRevision` method.
1173+
The request object. Request for the ``DeleteSchemaRevision`` method.
11781174
name (str):
11791175
Required. The name of the schema revision to be deleted,
11801176
with a revision ID explicitly included.
@@ -1282,8 +1278,7 @@ def sample_delete_schema():
12821278
12831279
Args:
12841280
request (Union[google.pubsub_v1.types.DeleteSchemaRequest, dict]):
1285-
The request object. Request for the `DeleteSchema`
1286-
method.
1281+
The request object. Request for the ``DeleteSchema`` method.
12871282
name (str):
12881283
Required. Name of the schema to delete. Format is
12891284
``projects/{project}/schemas/{schema}``.
@@ -1380,8 +1375,7 @@ def sample_validate_schema():
13801375
13811376
Args:
13821377
request (Union[google.pubsub_v1.types.ValidateSchemaRequest, dict]):
1383-
The request object. Request for the `ValidateSchema`
1384-
method.
1378+
The request object. Request for the ``ValidateSchema`` method.
13851379
parent (str):
13861380
Required. The name of the project in which to validate
13871381
schemas. Format is ``projects/{project-id}``.
@@ -1491,8 +1485,7 @@ def sample_validate_message():
14911485
14921486
Args:
14931487
request (Union[google.pubsub_v1.types.ValidateMessageRequest, dict]):
1494-
The request object. Request for the `ValidateMessage`
1495-
method.
1488+
The request object. Request for the ``ValidateMessage`` method.
14961489
retry (google.api_core.retry.Retry): Designation of what errors, if any,
14971490
should be retried.
14981491
timeout (float): The timeout for this request.

‎google/pubsub_v1/services/subscriber/async_client.py‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,10 @@ async def sample_create_subscription():
279279
280280
Args:
281281
request (Optional[Union[google.pubsub_v1.types.Subscription, dict]]):
282-
The request object. A subscription resource. If none of
283-
`push_config` or `bigquery_config` is set, then the
284-
subscriber will pull and ack messages using API methods.
285-
At most one of these fields may be set.
282+
The request object. A subscription resource. If none of ``push_config`` or
283+
``bigquery_config`` is set, then the subscriber will
284+
pull and ack messages using API methods. At most one of
285+
these fields may be set.
286286
name (:class:`str`):
287287
Required. The name of the subscription. It must have the
288288
format
@@ -706,8 +706,7 @@ async def sample_list_subscriptions():
706706
707707
Args:
708708
request (Optional[Union[google.pubsub_v1.types.ListSubscriptionsRequest, dict]]):
709-
The request object. Request for the `ListSubscriptions`
710-
method.
709+
The request object. Request for the ``ListSubscriptions`` method.
711710
project (:class:`str`):
712711
Required. The name of the project in which to list
713712
subscriptions. Format is ``projects/{project-id}``.
@@ -1194,7 +1193,7 @@ async def sample_pull():
11941193
11951194
Args:
11961195
request (Optional[Union[google.pubsub_v1.types.PullRequest, dict]]):
1197-
The request object. Request for the `Pull` method.
1196+
The request object. Request for the ``Pull`` method.
11981197
subscription (:class:`str`):
11991198
Required. The subscription from which messages should be
12001199
pulled. Format is
@@ -1360,11 +1359,10 @@ def request_generator():
13601359
13611360
Args:
13621361
requests (AsyncIterator[`google.pubsub_v1.types.StreamingPullRequest`]):
1363-
The request object AsyncIterator. Request for the `StreamingPull`
1364-
streaming RPC method. This request is used to establish
1365-
the initial stream as well as to stream acknowledgements
1366-
and ack deadline modifications from the client to the
1367-
server.
1362+
The request object AsyncIterator. Request for the ``StreamingPull`` streaming RPC method.
1363+
This request is used to establish the initial stream as
1364+
well as to stream acknowledgements and ack deadline
1365+
modifications from the client to the server.
13681366
retry (google.api_core.retry.Retry): Designation of what errors, if any,
13691367
should be retried.
13701368
timeout (float): The timeout for this request.
@@ -1697,8 +1695,7 @@ async def sample_list_snapshots():
16971695
16981696
Args:
16991697
request (Optional[Union[google.pubsub_v1.types.ListSnapshotsRequest, dict]]):
1700-
The request object. Request for the `ListSnapshots`
1701-
method.
1698+
The request object. Request for the ``ListSnapshots`` method.
17021699
project (:class:`str`):
17031700
Required. The name of the project in which to list
17041701
snapshots. Format is ``projects/{project-id}``.
@@ -1841,8 +1838,7 @@ async def sample_create_snapshot():
18411838
18421839
Args:
18431840
request (Optional[Union[google.pubsub_v1.types.CreateSnapshotRequest, dict]]):
1844-
The request object. Request for the `CreateSnapshot`
1845-
method.
1841+
The request object. Request for the ``CreateSnapshot`` method.
18461842
name (:class:`str`):
18471843
Required. User-provided name for this snapshot. If the
18481844
name is not provided in the request, the server will
@@ -2116,8 +2112,7 @@ async def sample_delete_snapshot():
21162112
21172113
Args:
21182114
request (Optional[Union[google.pubsub_v1.types.DeleteSnapshotRequest, dict]]):
2119-
The request object. Request for the `DeleteSnapshot`
2120-
method.
2115+
The request object. Request for the ``DeleteSnapshot`` method.
21212116
snapshot (:class:`str`):
21222117
Required. The name of the snapshot to delete. Format is
21232118
``projects/{project}/snapshots/{snap}``.
@@ -2225,7 +2220,7 @@ async def sample_seek():
22252220
22262221
Args:
22272222
request (Optional[Union[google.pubsub_v1.types.SeekRequest, dict]]):
2228-
The request object. Request for the `Seek` method.
2223+
The request object. Request for the ``Seek`` method.
22292224
retry (google.api_core.retry.Retry): Designation of what errors, if any,
22302225
should be retried.
22312226
timeout (float): The timeout for this request.

‎google/pubsub_v1/services/subscriber/client.py‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -558,10 +558,10 @@ def sample_create_subscription():
558558
559559
Args:
560560
request (Union[google.pubsub_v1.types.Subscription, dict]):
561-
The request object. A subscription resource. If none of
562-
`push_config` or `bigquery_config` is set, then the
563-
subscriber will pull and ack messages using API methods.
564-
At most one of these fields may be set.
561+
The request object. A subscription resource. If none of ``push_config`` or
562+
``bigquery_config`` is set, then the subscriber will
563+
pull and ack messages using API methods. At most one of
564+
these fields may be set.
565565
name (str):
566566
Required. The name of the subscription. It must have the
567567
format
@@ -954,8 +954,7 @@ def sample_list_subscriptions():
954954
955955
Args:
956956
request (Union[google.pubsub_v1.types.ListSubscriptionsRequest, dict]):
957-
The request object. Request for the `ListSubscriptions`
958-
method.
957+
The request object. Request for the ``ListSubscriptions`` method.
959958
project (str):
960959
Required. The name of the project in which to list
961960
subscriptions. Format is ``projects/{project-id}``.
@@ -1404,7 +1403,7 @@ def sample_pull():
14041403
14051404
Args:
14061405
request (Union[google.pubsub_v1.types.PullRequest, dict]):
1407-
The request object. Request for the `Pull` method.
1406+
The request object. Request for the ``Pull`` method.
14081407
subscription (str):
14091408
Required. The subscription from which messages should be
14101409
pulled. Format is
@@ -1558,11 +1557,10 @@ def request_generator():
15581557
15591558
Args:
15601559
requests (Iterator[google.pubsub_v1.types.StreamingPullRequest]):
1561-
The request object iterator. Request for the `StreamingPull`
1562-
streaming RPC method. This request is used to establish
1563-
the initial stream as well as to stream acknowledgements
1564-
and ack deadline modifications from the client to the
1565-
server.
1560+
The request object iterator. Request for the ``StreamingPull`` streaming RPC method.
1561+
This request is used to establish the initial stream as
1562+
well as to stream acknowledgements and ack deadline
1563+
modifications from the client to the server.
15661564
retry (google.api_core.retry.Retry): Designation of what errors, if any,
15671565
should be retried.
15681566
timeout (float): The timeout for this request.
@@ -1863,8 +1861,7 @@ def sample_list_snapshots():
18631861
18641862
Args:
18651863
request (Union[google.pubsub_v1.types.ListSnapshotsRequest, dict]):
1866-
The request object. Request for the `ListSnapshots`
1867-
method.
1864+
The request object. Request for the ``ListSnapshots`` method.
18681865
project (str):
18691866
Required. The name of the project in which to list
18701867
snapshots. Format is ``projects/{project-id}``.
@@ -1996,8 +1993,7 @@ def sample_create_snapshot():
19961993
19971994
Args:
19981995
request (Union[google.pubsub_v1.types.CreateSnapshotRequest, dict]):
1999-
The request object. Request for the `CreateSnapshot`
2000-
method.
1996+
The request object. Request for the ``CreateSnapshot`` method.
20011997
name (str):
20021998
Required. User-provided name for this snapshot. If the
20031999
name is not provided in the request, the server will
@@ -2253,8 +2249,7 @@ def sample_delete_snapshot():
22532249
22542250
Args:
22552251
request (Union[google.pubsub_v1.types.DeleteSnapshotRequest, dict]):
2256-
The request object. Request for the `DeleteSnapshot`
2257-
method.
2252+
The request object. Request for the ``DeleteSnapshot`` method.
22582253
snapshot (str):
22592254
Required. The name of the snapshot to delete. Format is
22602255
``projects/{project}/snapshots/{snap}``.
@@ -2353,7 +2348,7 @@ def sample_seek():
23532348
23542349
Args:
23552350
request (Union[google.pubsub_v1.types.SeekRequest, dict]):
2356-
The request object. Request for the `Seek` method.
2351+
The request object. Request for the ``Seek`` method.
23572352
retry (google.api_core.retry.Retry): Designation of what errors, if any,
23582353
should be retried.
23592354
timeout (float): The timeout for this request.

0 commit comments

Comments
 (0)