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

Commit c97f63e

Browse files
docs: Fix formatting of request arg in docstring (#460)
* 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 70bdacb commit c97f63e

File tree

2 files changed

+38
-50
lines changed

2 files changed

+38
-50
lines changed

google/cloud/iot_v1/services/device_manager/async_client.py

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ async def sample_create_device_registry():
266266
267267
Args:
268268
request (Optional[Union[google.cloud.iot_v1.types.CreateDeviceRegistryRequest, dict]]):
269-
The request object. Request for `CreateDeviceRegistry`.
269+
The request object. Request for ``CreateDeviceRegistry``.
270270
parent (:class:`str`):
271271
Required. The project and cloud region where this device
272272
registry must be created. For example,
@@ -377,7 +377,7 @@ async def sample_get_device_registry():
377377
378378
Args:
379379
request (Optional[Union[google.cloud.iot_v1.types.GetDeviceRegistryRequest, dict]]):
380-
The request object. Request for `GetDeviceRegistry`.
380+
The request object. Request for ``GetDeviceRegistry``.
381381
name (:class:`str`):
382382
Required. The name of the device registry. For example,
383383
``projects/example-project/locations/us-central1/registries/my-registry``.
@@ -488,7 +488,7 @@ async def sample_update_device_registry():
488488
489489
Args:
490490
request (Optional[Union[google.cloud.iot_v1.types.UpdateDeviceRegistryRequest, dict]]):
491-
The request object. Request for `UpdateDeviceRegistry`.
491+
The request object. Request for ``UpdateDeviceRegistry``.
492492
device_registry (:class:`google.cloud.iot_v1.types.DeviceRegistry`):
493493
Required. The new values for the device registry. The
494494
``id`` field must be empty, and the ``name`` field must
@@ -603,7 +603,7 @@ async def sample_delete_device_registry():
603603
604604
Args:
605605
request (Optional[Union[google.cloud.iot_v1.types.DeleteDeviceRegistryRequest, dict]]):
606-
The request object. Request for `DeleteDeviceRegistry`.
606+
The request object. Request for ``DeleteDeviceRegistry``.
607607
name (:class:`str`):
608608
Required. The name of the device registry. For example,
609609
``projects/example-project/locations/us-central1/registries/my-registry``.
@@ -708,7 +708,7 @@ async def sample_list_device_registries():
708708
709709
Args:
710710
request (Optional[Union[google.cloud.iot_v1.types.ListDeviceRegistriesRequest, dict]]):
711-
The request object. Request for `ListDeviceRegistries`.
711+
The request object. Request for ``ListDeviceRegistries``.
712712
parent (:class:`str`):
713713
Required. The project and cloud region path. For
714714
example,
@@ -832,7 +832,7 @@ async def sample_create_device():
832832
833833
Args:
834834
request (Optional[Union[google.cloud.iot_v1.types.CreateDeviceRequest, dict]]):
835-
The request object. Request for `CreateDevice`.
835+
The request object. Request for ``CreateDevice``.
836836
parent (:class:`str`):
837837
Required. The name of the device registry where this
838838
device should be created. For example,
@@ -943,7 +943,7 @@ async def sample_get_device():
943943
944944
Args:
945945
request (Optional[Union[google.cloud.iot_v1.types.GetDeviceRequest, dict]]):
946-
The request object. Request for `GetDevice`.
946+
The request object. Request for ``GetDevice``.
947947
name (:class:`str`):
948948
Required. The name of the device. For example,
949949
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1054,7 +1054,7 @@ async def sample_update_device():
10541054
10551055
Args:
10561056
request (Optional[Union[google.cloud.iot_v1.types.UpdateDeviceRequest, dict]]):
1057-
The request object. Request for `UpdateDevice`.
1057+
The request object. Request for ``UpdateDevice``.
10581058
device (:class:`google.cloud.iot_v1.types.Device`):
10591059
Required. The new values for the device. The ``id`` and
10601060
``num_id`` fields must be empty, and the field ``name``
@@ -1167,7 +1167,7 @@ async def sample_delete_device():
11671167
11681168
Args:
11691169
request (Optional[Union[google.cloud.iot_v1.types.DeleteDeviceRequest, dict]]):
1170-
The request object. Request for `DeleteDevice`.
1170+
The request object. Request for ``DeleteDevice``.
11711171
name (:class:`str`):
11721172
Required. The name of the device. For example,
11731173
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1272,7 +1272,7 @@ async def sample_list_devices():
12721272
12731273
Args:
12741274
request (Optional[Union[google.cloud.iot_v1.types.ListDevicesRequest, dict]]):
1275-
The request object. Request for `ListDevices`.
1275+
The request object. Request for ``ListDevices``.
12761276
parent (:class:`str`):
12771277
Required. The device registry path. Required. For
12781278
example,
@@ -1401,8 +1401,7 @@ async def sample_modify_cloud_to_device_config():
14011401
14021402
Args:
14031403
request (Optional[Union[google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest, dict]]):
1404-
The request object. Request for
1405-
`ModifyCloudToDeviceConfig`.
1404+
The request object. Request for ``ModifyCloudToDeviceConfig``.
14061405
name (:class:`str`):
14071406
Required. The name of the device. For example,
14081407
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1528,8 +1527,7 @@ async def sample_list_device_config_versions():
15281527
15291528
Args:
15301529
request (Optional[Union[google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest, dict]]):
1531-
The request object. Request for
1532-
`ListDeviceConfigVersions`.
1530+
The request object. Request for ``ListDeviceConfigVersions``.
15331531
name (:class:`str`):
15341532
Required. The name of the device. For example,
15351533
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1641,7 +1639,7 @@ async def sample_list_device_states():
16411639
16421640
Args:
16431641
request (Optional[Union[google.cloud.iot_v1.types.ListDeviceStatesRequest, dict]]):
1644-
The request object. Request for `ListDeviceStates`.
1642+
The request object. Request for ``ListDeviceStates``.
16451643
name (:class:`str`):
16461644
Required. The name of the device. For example,
16471645
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1754,8 +1752,7 @@ async def sample_set_iam_policy():
17541752
17551753
Args:
17561754
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
1757-
The request object. Request message for `SetIamPolicy`
1758-
method.
1755+
The request object. Request message for ``SetIamPolicy`` method.
17591756
resource (:class:`str`):
17601757
REQUIRED: The resource for which the
17611758
policy is being specified. See the
@@ -1922,8 +1919,7 @@ async def sample_get_iam_policy():
19221919
19231920
Args:
19241921
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
1925-
The request object. Request message for `GetIamPolicy`
1926-
method.
1922+
The request object. Request message for ``GetIamPolicy`` method.
19271923
resource (:class:`str`):
19281924
REQUIRED: The resource for which the
19291925
policy is being requested. See the
@@ -2092,8 +2088,7 @@ async def sample_test_iam_permissions():
20922088
20932089
Args:
20942090
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
2095-
The request object. Request message for
2096-
`TestIamPermissions` method.
2091+
The request object. Request message for ``TestIamPermissions`` method.
20972092
resource (:class:`str`):
20982093
REQUIRED: The resource for which the
20992094
policy detail is being requested. See
@@ -2227,7 +2222,7 @@ async def sample_send_command_to_device():
22272222
22282223
Args:
22292224
request (Optional[Union[google.cloud.iot_v1.types.SendCommandToDeviceRequest, dict]]):
2230-
The request object. Request for `SendCommandToDevice`.
2225+
The request object. Request for ``SendCommandToDevice``.
22312226
name (:class:`str`):
22322227
Required. The name of the device. For example,
22332228
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -2372,7 +2367,7 @@ async def sample_bind_device_to_gateway():
23722367
23732368
Args:
23742369
request (Optional[Union[google.cloud.iot_v1.types.BindDeviceToGatewayRequest, dict]]):
2375-
The request object. Request for `BindDeviceToGateway`.
2370+
The request object. Request for ``BindDeviceToGateway``.
23762371
parent (:class:`str`):
23772372
Required. The name of the registry. For example,
23782373
``projects/example-project/locations/us-central1/registries/my-registry``.
@@ -2497,8 +2492,7 @@ async def sample_unbind_device_from_gateway():
24972492
24982493
Args:
24992494
request (Optional[Union[google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest, dict]]):
2500-
The request object. Request for
2501-
`UnbindDeviceFromGateway`.
2495+
The request object. Request for ``UnbindDeviceFromGateway``.
25022496
parent (:class:`str`):
25032497
Required. The name of the registry. For example,
25042498
``projects/example-project/locations/us-central1/registries/my-registry``.

google/cloud/iot_v1/services/device_manager/client.py

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ def sample_create_device_registry():
515515
516516
Args:
517517
request (Union[google.cloud.iot_v1.types.CreateDeviceRegistryRequest, dict]):
518-
The request object. Request for `CreateDeviceRegistry`.
518+
The request object. Request for ``CreateDeviceRegistry``.
519519
parent (str):
520520
Required. The project and cloud region where this device
521521
registry must be created. For example,
@@ -626,7 +626,7 @@ def sample_get_device_registry():
626626
627627
Args:
628628
request (Union[google.cloud.iot_v1.types.GetDeviceRegistryRequest, dict]):
629-
The request object. Request for `GetDeviceRegistry`.
629+
The request object. Request for ``GetDeviceRegistry``.
630630
name (str):
631631
Required. The name of the device registry. For example,
632632
``projects/example-project/locations/us-central1/registries/my-registry``.
@@ -727,7 +727,7 @@ def sample_update_device_registry():
727727
728728
Args:
729729
request (Union[google.cloud.iot_v1.types.UpdateDeviceRegistryRequest, dict]):
730-
The request object. Request for `UpdateDeviceRegistry`.
730+
The request object. Request for ``UpdateDeviceRegistry``.
731731
device_registry (google.cloud.iot_v1.types.DeviceRegistry):
732732
Required. The new values for the device registry. The
733733
``id`` field must be empty, and the ``name`` field must
@@ -842,7 +842,7 @@ def sample_delete_device_registry():
842842
843843
Args:
844844
request (Union[google.cloud.iot_v1.types.DeleteDeviceRegistryRequest, dict]):
845-
The request object. Request for `DeleteDeviceRegistry`.
845+
The request object. Request for ``DeleteDeviceRegistry``.
846846
name (str):
847847
Required. The name of the device registry. For example,
848848
``projects/example-project/locations/us-central1/registries/my-registry``.
@@ -937,7 +937,7 @@ def sample_list_device_registries():
937937
938938
Args:
939939
request (Union[google.cloud.iot_v1.types.ListDeviceRegistriesRequest, dict]):
940-
The request object. Request for `ListDeviceRegistries`.
940+
The request object. Request for ``ListDeviceRegistries``.
941941
parent (str):
942942
Required. The project and cloud region path. For
943943
example,
@@ -1051,7 +1051,7 @@ def sample_create_device():
10511051
10521052
Args:
10531053
request (Union[google.cloud.iot_v1.types.CreateDeviceRequest, dict]):
1054-
The request object. Request for `CreateDevice`.
1054+
The request object. Request for ``CreateDevice``.
10551055
parent (str):
10561056
Required. The name of the device registry where this
10571057
device should be created. For example,
@@ -1162,7 +1162,7 @@ def sample_get_device():
11621162
11631163
Args:
11641164
request (Union[google.cloud.iot_v1.types.GetDeviceRequest, dict]):
1165-
The request object. Request for `GetDevice`.
1165+
The request object. Request for ``GetDevice``.
11661166
name (str):
11671167
Required. The name of the device. For example,
11681168
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1263,7 +1263,7 @@ def sample_update_device():
12631263
12641264
Args:
12651265
request (Union[google.cloud.iot_v1.types.UpdateDeviceRequest, dict]):
1266-
The request object. Request for `UpdateDevice`.
1266+
The request object. Request for ``UpdateDevice``.
12671267
device (google.cloud.iot_v1.types.Device):
12681268
Required. The new values for the device. The ``id`` and
12691269
``num_id`` fields must be empty, and the field ``name``
@@ -1376,7 +1376,7 @@ def sample_delete_device():
13761376
13771377
Args:
13781378
request (Union[google.cloud.iot_v1.types.DeleteDeviceRequest, dict]):
1379-
The request object. Request for `DeleteDevice`.
1379+
The request object. Request for ``DeleteDevice``.
13801380
name (str):
13811381
Required. The name of the device. For example,
13821382
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1471,7 +1471,7 @@ def sample_list_devices():
14711471
14721472
Args:
14731473
request (Union[google.cloud.iot_v1.types.ListDevicesRequest, dict]):
1474-
The request object. Request for `ListDevices`.
1474+
The request object. Request for ``ListDevices``.
14751475
parent (str):
14761476
Required. The device registry path. Required. For
14771477
example,
@@ -1590,8 +1590,7 @@ def sample_modify_cloud_to_device_config():
15901590
15911591
Args:
15921592
request (Union[google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest, dict]):
1593-
The request object. Request for
1594-
`ModifyCloudToDeviceConfig`.
1593+
The request object. Request for ``ModifyCloudToDeviceConfig``.
15951594
name (str):
15961595
Required. The name of the device. For example,
15971596
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1708,8 +1707,7 @@ def sample_list_device_config_versions():
17081707
17091708
Args:
17101709
request (Union[google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest, dict]):
1711-
The request object. Request for
1712-
`ListDeviceConfigVersions`.
1710+
The request object. Request for ``ListDeviceConfigVersions``.
17131711
name (str):
17141712
Required. The name of the device. For example,
17151713
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1813,7 +1811,7 @@ def sample_list_device_states():
18131811
18141812
Args:
18151813
request (Union[google.cloud.iot_v1.types.ListDeviceStatesRequest, dict]):
1816-
The request object. Request for `ListDeviceStates`.
1814+
The request object. Request for ``ListDeviceStates``.
18171815
name (str):
18181816
Required. The name of the device. For example,
18191817
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -1916,8 +1914,7 @@ def sample_set_iam_policy():
19161914
19171915
Args:
19181916
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
1919-
The request object. Request message for `SetIamPolicy`
1920-
method.
1917+
The request object. Request message for ``SetIamPolicy`` method.
19211918
resource (str):
19221919
REQUIRED: The resource for which the
19231920
policy is being specified. See the
@@ -2081,8 +2078,7 @@ def sample_get_iam_policy():
20812078
20822079
Args:
20832080
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
2084-
The request object. Request message for `GetIamPolicy`
2085-
method.
2081+
The request object. Request message for ``GetIamPolicy`` method.
20862082
resource (str):
20872083
REQUIRED: The resource for which the
20882084
policy is being requested. See the
@@ -2248,8 +2244,7 @@ def sample_test_iam_permissions():
22482244
22492245
Args:
22502246
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
2251-
The request object. Request message for
2252-
`TestIamPermissions` method.
2247+
The request object. Request message for ``TestIamPermissions`` method.
22532248
resource (str):
22542249
REQUIRED: The resource for which the
22552250
policy detail is being requested. See
@@ -2381,7 +2376,7 @@ def sample_send_command_to_device():
23812376
23822377
Args:
23832378
request (Union[google.cloud.iot_v1.types.SendCommandToDeviceRequest, dict]):
2384-
The request object. Request for `SendCommandToDevice`.
2379+
The request object. Request for ``SendCommandToDevice``.
23852380
name (str):
23862381
Required. The name of the device. For example,
23872382
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
@@ -2515,7 +2510,7 @@ def sample_bind_device_to_gateway():
25152510
25162511
Args:
25172512
request (Union[google.cloud.iot_v1.types.BindDeviceToGatewayRequest, dict]):
2518-
The request object. Request for `BindDeviceToGateway`.
2513+
The request object. Request for ``BindDeviceToGateway``.
25192514
parent (str):
25202515
Required. The name of the registry. For example,
25212516
``projects/example-project/locations/us-central1/registries/my-registry``.
@@ -2640,8 +2635,7 @@ def sample_unbind_device_from_gateway():
26402635
26412636
Args:
26422637
request (Union[google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest, dict]):
2643-
The request object. Request for
2644-
`UnbindDeviceFromGateway`.
2638+
The request object. Request for ``UnbindDeviceFromGateway``.
26452639
parent (str):
26462640
Required. The name of the registry. For example,
26472641
``projects/example-project/locations/us-central1/registries/my-registry``.

0 commit comments

Comments
 (0)