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

docs: Fix formatting of request arg in docstring #460

Merged
merged 2 commits into from
Mar 23, 2023
Merged

docs: Fix formatting of request arg in docstring #460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
430cb7b
docs: Fix formatting of request arg in docstring
gcf-owl-bot[bot] Mar 22, 2023
e5dbc35
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 19 additions & 25 deletions google/cloud/iot_v1/services/device_manager/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ async def sample_create_device_registry():

Args:
request (Optional[Union[google.cloud.iot_v1.types.CreateDeviceRegistryRequest, dict]]):
The request object. Request for `CreateDeviceRegistry`.
The request object. Request for ``CreateDeviceRegistry``.
parent (:class:`str`):
Required. The project and cloud region where this device
registry must be created. For example,
Expand Down Expand Up @@ -377,7 +377,7 @@ async def sample_get_device_registry():

Args:
request (Optional[Union[google.cloud.iot_v1.types.GetDeviceRegistryRequest, dict]]):
The request object. Request for `GetDeviceRegistry`.
The request object. Request for ``GetDeviceRegistry``.
name (:class:`str`):
Required. The name of the device registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down Expand Up @@ -488,7 +488,7 @@ async def sample_update_device_registry():

Args:
request (Optional[Union[google.cloud.iot_v1.types.UpdateDeviceRegistryRequest, dict]]):
The request object. Request for `UpdateDeviceRegistry`.
The request object. Request for ``UpdateDeviceRegistry``.
device_registry (:class:`google.cloud.iot_v1.types.DeviceRegistry`):
Required. The new values for the device registry. The
``id`` field must be empty, and the ``name`` field must
Expand Down Expand Up @@ -603,7 +603,7 @@ async def sample_delete_device_registry():

Args:
request (Optional[Union[google.cloud.iot_v1.types.DeleteDeviceRegistryRequest, dict]]):
The request object. Request for `DeleteDeviceRegistry`.
The request object. Request for ``DeleteDeviceRegistry``.
name (:class:`str`):
Required. The name of the device registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down Expand Up @@ -708,7 +708,7 @@ async def sample_list_device_registries():

Args:
request (Optional[Union[google.cloud.iot_v1.types.ListDeviceRegistriesRequest, dict]]):
The request object. Request for `ListDeviceRegistries`.
The request object. Request for ``ListDeviceRegistries``.
parent (:class:`str`):
Required. The project and cloud region path. For
example,
Expand Down Expand Up @@ -832,7 +832,7 @@ async def sample_create_device():

Args:
request (Optional[Union[google.cloud.iot_v1.types.CreateDeviceRequest, dict]]):
The request object. Request for `CreateDevice`.
The request object. Request for ``CreateDevice``.
parent (:class:`str`):
Required. The name of the device registry where this
device should be created. For example,
Expand Down Expand Up @@ -943,7 +943,7 @@ async def sample_get_device():

Args:
request (Optional[Union[google.cloud.iot_v1.types.GetDeviceRequest, dict]]):
The request object. Request for `GetDevice`.
The request object. Request for ``GetDevice``.
name (:class:`str`):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1054,7 +1054,7 @@ async def sample_update_device():

Args:
request (Optional[Union[google.cloud.iot_v1.types.UpdateDeviceRequest, dict]]):
The request object. Request for `UpdateDevice`.
The request object. Request for ``UpdateDevice``.
device (:class:`google.cloud.iot_v1.types.Device`):
Required. The new values for the device. The ``id`` and
``num_id`` fields must be empty, and the field ``name``
Expand Down Expand Up @@ -1167,7 +1167,7 @@ async def sample_delete_device():

Args:
request (Optional[Union[google.cloud.iot_v1.types.DeleteDeviceRequest, dict]]):
The request object. Request for `DeleteDevice`.
The request object. Request for ``DeleteDevice``.
name (:class:`str`):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1272,7 +1272,7 @@ async def sample_list_devices():

Args:
request (Optional[Union[google.cloud.iot_v1.types.ListDevicesRequest, dict]]):
The request object. Request for `ListDevices`.
The request object. Request for ``ListDevices``.
parent (:class:`str`):
Required. The device registry path. Required. For
example,
Expand Down Expand Up @@ -1401,8 +1401,7 @@ async def sample_modify_cloud_to_device_config():

Args:
request (Optional[Union[google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest, dict]]):
The request object. Request for
`ModifyCloudToDeviceConfig`.
The request object. Request for ``ModifyCloudToDeviceConfig``.
name (:class:`str`):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1528,8 +1527,7 @@ async def sample_list_device_config_versions():

Args:
request (Optional[Union[google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest, dict]]):
The request object. Request for
`ListDeviceConfigVersions`.
The request object. Request for ``ListDeviceConfigVersions``.
name (:class:`str`):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1641,7 +1639,7 @@ async def sample_list_device_states():

Args:
request (Optional[Union[google.cloud.iot_v1.types.ListDeviceStatesRequest, dict]]):
The request object. Request for `ListDeviceStates`.
The request object. Request for ``ListDeviceStates``.
name (:class:`str`):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1754,8 +1752,7 @@ async def sample_set_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -1922,8 +1919,7 @@ async def sample_get_iam_policy():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2092,8 +2088,7 @@ async def sample_test_iam_permissions():

Args:
request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (:class:`str`):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down Expand Up @@ -2227,7 +2222,7 @@ async def sample_send_command_to_device():

Args:
request (Optional[Union[google.cloud.iot_v1.types.SendCommandToDeviceRequest, dict]]):
The request object. Request for `SendCommandToDevice`.
The request object. Request for ``SendCommandToDevice``.
name (:class:`str`):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -2372,7 +2367,7 @@ async def sample_bind_device_to_gateway():

Args:
request (Optional[Union[google.cloud.iot_v1.types.BindDeviceToGatewayRequest, dict]]):
The request object. Request for `BindDeviceToGateway`.
The request object. Request for ``BindDeviceToGateway``.
parent (:class:`str`):
Required. The name of the registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down Expand Up @@ -2497,8 +2492,7 @@ async def sample_unbind_device_from_gateway():

Args:
request (Optional[Union[google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest, dict]]):
The request object. Request for
`UnbindDeviceFromGateway`.
The request object. Request for ``UnbindDeviceFromGateway``.
parent (:class:`str`):
Required. The name of the registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down
44 changes: 19 additions & 25 deletions google/cloud/iot_v1/services/device_manager/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ def sample_create_device_registry():

Args:
request (Union[google.cloud.iot_v1.types.CreateDeviceRegistryRequest, dict]):
The request object. Request for `CreateDeviceRegistry`.
The request object. Request for ``CreateDeviceRegistry``.
parent (str):
Required. The project and cloud region where this device
registry must be created. For example,
Expand Down Expand Up @@ -626,7 +626,7 @@ def sample_get_device_registry():

Args:
request (Union[google.cloud.iot_v1.types.GetDeviceRegistryRequest, dict]):
The request object. Request for `GetDeviceRegistry`.
The request object. Request for ``GetDeviceRegistry``.
name (str):
Required. The name of the device registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down Expand Up @@ -727,7 +727,7 @@ def sample_update_device_registry():

Args:
request (Union[google.cloud.iot_v1.types.UpdateDeviceRegistryRequest, dict]):
The request object. Request for `UpdateDeviceRegistry`.
The request object. Request for ``UpdateDeviceRegistry``.
device_registry (google.cloud.iot_v1.types.DeviceRegistry):
Required. The new values for the device registry. The
``id`` field must be empty, and the ``name`` field must
Expand Down Expand Up @@ -842,7 +842,7 @@ def sample_delete_device_registry():

Args:
request (Union[google.cloud.iot_v1.types.DeleteDeviceRegistryRequest, dict]):
The request object. Request for `DeleteDeviceRegistry`.
The request object. Request for ``DeleteDeviceRegistry``.
name (str):
Required. The name of the device registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down Expand Up @@ -937,7 +937,7 @@ def sample_list_device_registries():

Args:
request (Union[google.cloud.iot_v1.types.ListDeviceRegistriesRequest, dict]):
The request object. Request for `ListDeviceRegistries`.
The request object. Request for ``ListDeviceRegistries``.
parent (str):
Required. The project and cloud region path. For
example,
Expand Down Expand Up @@ -1051,7 +1051,7 @@ def sample_create_device():

Args:
request (Union[google.cloud.iot_v1.types.CreateDeviceRequest, dict]):
The request object. Request for `CreateDevice`.
The request object. Request for ``CreateDevice``.
parent (str):
Required. The name of the device registry where this
device should be created. For example,
Expand Down Expand Up @@ -1162,7 +1162,7 @@ def sample_get_device():

Args:
request (Union[google.cloud.iot_v1.types.GetDeviceRequest, dict]):
The request object. Request for `GetDevice`.
The request object. Request for ``GetDevice``.
name (str):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1263,7 +1263,7 @@ def sample_update_device():

Args:
request (Union[google.cloud.iot_v1.types.UpdateDeviceRequest, dict]):
The request object. Request for `UpdateDevice`.
The request object. Request for ``UpdateDevice``.
device (google.cloud.iot_v1.types.Device):
Required. The new values for the device. The ``id`` and
``num_id`` fields must be empty, and the field ``name``
Expand Down Expand Up @@ -1376,7 +1376,7 @@ def sample_delete_device():

Args:
request (Union[google.cloud.iot_v1.types.DeleteDeviceRequest, dict]):
The request object. Request for `DeleteDevice`.
The request object. Request for ``DeleteDevice``.
name (str):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1471,7 +1471,7 @@ def sample_list_devices():

Args:
request (Union[google.cloud.iot_v1.types.ListDevicesRequest, dict]):
The request object. Request for `ListDevices`.
The request object. Request for ``ListDevices``.
parent (str):
Required. The device registry path. Required. For
example,
Expand Down Expand Up @@ -1590,8 +1590,7 @@ def sample_modify_cloud_to_device_config():

Args:
request (Union[google.cloud.iot_v1.types.ModifyCloudToDeviceConfigRequest, dict]):
The request object. Request for
`ModifyCloudToDeviceConfig`.
The request object. Request for ``ModifyCloudToDeviceConfig``.
name (str):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1708,8 +1707,7 @@ def sample_list_device_config_versions():

Args:
request (Union[google.cloud.iot_v1.types.ListDeviceConfigVersionsRequest, dict]):
The request object. Request for
`ListDeviceConfigVersions`.
The request object. Request for ``ListDeviceConfigVersions``.
name (str):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1813,7 +1811,7 @@ def sample_list_device_states():

Args:
request (Union[google.cloud.iot_v1.types.ListDeviceStatesRequest, dict]):
The request object. Request for `ListDeviceStates`.
The request object. Request for ``ListDeviceStates``.
name (str):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -1916,8 +1914,7 @@ def sample_set_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]):
The request object. Request message for `SetIamPolicy`
method.
The request object. Request message for ``SetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being specified. See the
Expand Down Expand Up @@ -2081,8 +2078,7 @@ def sample_get_iam_policy():

Args:
request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]):
The request object. Request message for `GetIamPolicy`
method.
The request object. Request message for ``GetIamPolicy`` method.
resource (str):
REQUIRED: The resource for which the
policy is being requested. See the
Expand Down Expand Up @@ -2248,8 +2244,7 @@ def sample_test_iam_permissions():

Args:
request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]):
The request object. Request message for
`TestIamPermissions` method.
The request object. Request message for ``TestIamPermissions`` method.
resource (str):
REQUIRED: The resource for which the
policy detail is being requested. See
Expand Down Expand Up @@ -2381,7 +2376,7 @@ def sample_send_command_to_device():

Args:
request (Union[google.cloud.iot_v1.types.SendCommandToDeviceRequest, dict]):
The request object. Request for `SendCommandToDevice`.
The request object. Request for ``SendCommandToDevice``.
name (str):
Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
Expand Down Expand Up @@ -2515,7 +2510,7 @@ def sample_bind_device_to_gateway():

Args:
request (Union[google.cloud.iot_v1.types.BindDeviceToGatewayRequest, dict]):
The request object. Request for `BindDeviceToGateway`.
The request object. Request for ``BindDeviceToGateway``.
parent (str):
Required. The name of the registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down Expand Up @@ -2640,8 +2635,7 @@ def sample_unbind_device_from_gateway():

Args:
request (Union[google.cloud.iot_v1.types.UnbindDeviceFromGatewayRequest, dict]):
The request object. Request for
`UnbindDeviceFromGateway`.
The request object. Request for ``UnbindDeviceFromGateway``.
parent (str):
Required. The name of the registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
Expand Down