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

Commit

Permalink
fix(iot): modify retry and timeout configs; add 2.7 deprecation warni…
Browse files Browse the repository at this point in the history 
…ng; add 'required' to docstring for required args; add 3.8 unit tests (via synth) (#10069)
  • Loading branch information
@yoshi-automation @busunkim96
yoshi-automation authored and busunkim96 committed Jan 8, 2020
1 parent df128f9 commit ce6f5cf
Show file tree
Hide file tree
Showing 12 changed files with 658 additions and 500 deletions.
2 changes: 1 addition & 1 deletion docs/_static/custom.css
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
div#python2-eol {
border-color: red;
border-width: medium;
}
}
1 change: 1 addition & 0 deletions docs/_templates/layout.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

{% extends "!layout.html" %}
{%- block content %}
{%- if theme_fixed_sidebar|lower == 'true' %}
Expand Down
11 changes: 11 additions & 0 deletions google/cloud/iot_v1/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,23 @@


from __future__ import absolute_import
import sys
import warnings

from google.cloud.iot_v1 import types
from google.cloud.iot_v1.gapic import device_manager_client
from google.cloud.iot_v1.gapic import enums


if sys.version_info[:2] == (2, 7):
message = (
"A future version of this library will drop support for Python 2.7."
"More details about Python 2 support for Google Cloud Client Libraries"
"can be found at https://cloud.google.com/python/docs/python2-sunset/"
)
warnings.warn(message, DeprecationWarning)


class DeviceManagerClient(device_manager_client.DeviceManagerClient):
__doc__ = device_manager_client.DeviceManagerClient.__doc__
enums = enums
Expand Down
95 changes: 50 additions & 45 deletions google/cloud/iot_v1/gapic/device_manager_client.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,12 @@ def create_device_registry(
>>> response = client.create_device_registry(parent, device_registry)
Args:
parent (str): The project and cloud region where this device registry must be created.
For example, ``projects/example-project/locations/us-central1``.
device_registry (Union[dict, ~google.cloud.iot_v1.types.DeviceRegistry]): The device registry. The field ``name`` must be empty. The server will
generate that field from the device registry ``id`` provided and the
``parent`` field.
parent (str): Required. The project and cloud region where this device registry must
be created. For example,
``projects/example-project/locations/us-central1``.
device_registry (Union[dict, ~google.cloud.iot_v1.types.DeviceRegistry]): Required. The device registry. The field ``name`` must be empty. The
server will generate that field from the device registry ``id`` provided
and the ``parent`` field.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.iot_v1.types.DeviceRegistry`
Expand Down Expand Up @@ -322,7 +323,7 @@ def get_device_registry(
>>> response = client.get_device_registry(name)
Args:
name (str): The name of the device registry. For example,
name (str): Required. The name of the device registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -397,16 +398,16 @@ def update_device_registry(
>>> response = client.update_device_registry(device_registry, update_mask)
Args:
device_registry (Union[dict, ~google.cloud.iot_v1.types.DeviceRegistry]): The new values for the device registry. The ``id`` field must be empty,
and the ``name`` field must indicate the path of the resource. For
example,
device_registry (Union[dict, ~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 indicate the path of the resource.
For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.iot_v1.types.DeviceRegistry`
update_mask (Union[dict, ~google.cloud.iot_v1.types.FieldMask]): Only updates the ``device_registry`` fields indicated by this mask. The
field mask must not be empty, and it must not contain fields that are
immutable or only set by the server. Mutable top-level fields:
update_mask (Union[dict, ~google.cloud.iot_v1.types.FieldMask]): Required. Only updates the ``device_registry`` fields indicated by this
mask. The field mask must not be empty, and it must not contain fields
that are immutable or only set by the server. Mutable top-level fields:
``event_notification_config``, ``http_config``, ``mqtt_config``, and
``state_notification_config``.
Expand Down Expand Up @@ -482,7 +483,7 @@ def delete_device_registry(
>>> client.delete_device_registry(name)
Args:
name (str): The name of the device registry. For example,
name (str): Required. The name of the device registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -562,7 +563,7 @@ def list_device_registries(
... pass
Args:
parent (str): The project and cloud region path. For example,
parent (str): Required. The project and cloud region path. For example,
``projects/example-project/locations/us-central1``.
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
Expand Down Expand Up @@ -657,12 +658,12 @@ def create_device(
>>> response = client.create_device(parent, device)
Args:
parent (str): The name of the device registry where this device should be created. For
example,
parent (str): Required. The name of the device registry where this device should be
created. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
device (Union[dict, ~google.cloud.iot_v1.types.Device]): The device registration details. The field ``name`` must be empty. The
server generates ``name`` from the device registry ``id`` and the
``parent`` field.
device (Union[dict, ~google.cloud.iot_v1.types.Device]): Required. The device registration details. The field ``name`` must be
empty. The server generates ``name`` from the device registry ``id`` and
the ``parent`` field.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.iot_v1.types.Device`
Expand Down Expand Up @@ -735,7 +736,7 @@ def get_device(
>>> response = client.get_device(name)
Args:
name (str): The name of the device. For example,
name (str): Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
Expand Down Expand Up @@ -817,15 +818,16 @@ def update_device(
>>> response = client.update_device(device, update_mask)
Args:
device (Union[dict, ~google.cloud.iot_v1.types.Device]): The new values for the device. The ``id`` and ``num_id`` fields must be
empty, and the field ``name`` must specify the name path. For example,
device (Union[dict, ~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`` must specify the name path.
For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``\ or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.iot_v1.types.Device`
update_mask (Union[dict, ~google.cloud.iot_v1.types.FieldMask]): Only updates the ``device`` fields indicated by this mask. The field
mask must not be empty, and it must not contain fields that are
update_mask (Union[dict, ~google.cloud.iot_v1.types.FieldMask]): Required. Only updates the ``device`` fields indicated by this mask. The
field mask must not be empty, and it must not contain fields that are
immutable or only set by the server. Mutable top-level fields:
``credentials``, ``blocked``, and ``metadata``
Expand Down Expand Up @@ -901,7 +903,7 @@ def delete_device(
>>> client.delete_device(name)
Args:
name (str): The name of the device. For example,
name (str): Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
Expand Down Expand Up @@ -987,7 +989,7 @@ def list_devices(
... pass
Args:
parent (str): The device registry path. Required. For example,
parent (str): Required. The device registry path. Required. For example,
``projects/my-project/locations/us-central1/registries/my-registry``.
device_num_ids (list[long]): A list of device numeric IDs. If empty, this field is ignored. Maximum
IDs: 10,000.
Expand Down Expand Up @@ -1104,11 +1106,11 @@ def modify_cloud_to_device_config(
>>> response = client.modify_cloud_to_device_config(name, binary_data)
Args:
name (str): The name of the device. For example,
name (str): Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
binary_data (bytes): The configuration data for the device.
binary_data (bytes): Required. The configuration data for the device.
version_to_update (long): The version number to update. If this value is zero, it will not check the
version number of the server and will always update the current version;
otherwise, this update will fail if the version number found on the server
Expand Down Expand Up @@ -1188,7 +1190,7 @@ def list_device_config_versions(
>>> response = client.list_device_config_versions(name)
Args:
name (str): The name of the device. For example,
name (str): Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
Expand Down Expand Up @@ -1269,7 +1271,7 @@ def list_device_states(
>>> response = client.list_device_states(name)
Args:
name (str): The name of the device. For example,
name (str): Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
Expand Down Expand Up @@ -1343,7 +1345,8 @@ def set_iam_policy(
>>>
>>> client = iot_v1.DeviceManagerClient()
>>>
>>> resource = client.registry_path('[PROJECT]', '[LOCATION]', '[REGISTRY]')
>>> # TODO: Initialize `resource`:
>>> resource = ''
>>>
>>> # TODO: Initialize `policy`:
>>> policy = {}
Expand Down Expand Up @@ -1426,7 +1429,8 @@ def get_iam_policy(
>>>
>>> client = iot_v1.DeviceManagerClient()
>>>
>>> resource = client.registry_path('[PROJECT]', '[LOCATION]', '[REGISTRY]')
>>> # TODO: Initialize `resource`:
>>> resource = ''
>>>
>>> response = client.get_iam_policy(resource)
Expand Down Expand Up @@ -1506,7 +1510,8 @@ def test_iam_permissions(
>>>
>>> client = iot_v1.DeviceManagerClient()
>>>
>>> resource = client.registry_path('[PROJECT]', '[LOCATION]', '[REGISTRY]')
>>> # TODO: Initialize `resource`:
>>> resource = ''
>>>
>>> # TODO: Initialize `permissions`:
>>> permissions = []
Expand Down Expand Up @@ -1609,11 +1614,11 @@ def send_command_to_device(
>>> response = client.send_command_to_device(name, binary_data)
Args:
name (str): The name of the device. For example,
name (str): Required. The name of the device. For example,
``projects/p0/locations/us-central1/registries/registry0/devices/device0``
or
``projects/p0/locations/us-central1/registries/registry0/devices/{num_id}``.
binary_data (bytes): The command data to send to the device.
binary_data (bytes): Required. The command data to send to the device.
subfolder (str): Optional subfolder for the command. If empty, the command will be delivered
to the /devices/{device-id}/commands topic, otherwise it will be delivered
to the /devices/{device-id}/commands/{subfolder} topic. Multi-level
Expand Down Expand Up @@ -1697,12 +1702,12 @@ def bind_device_to_gateway(
>>> response = client.bind_device_to_gateway(parent, gateway_id, device_id)
Args:
parent (str): The name of the registry. For example,
parent (str): Required. The name of the registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
gateway_id (str): The value of ``gateway_id`` can be either the device numeric ID or the
user-defined device identifier.
device_id (str): The device to associate with the specified gateway. The value of
``device_id`` can be either the device numeric ID or the user-defined
gateway_id (str): Required. The value of ``gateway_id`` can be either the device numeric
ID or the user-defined device identifier.
device_id (str): Required. The device to associate with the specified gateway. The value
of ``device_id`` can be either the device numeric ID or the user-defined
device identifier.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
Expand Down Expand Up @@ -1782,13 +1787,13 @@ def unbind_device_from_gateway(
>>> response = client.unbind_device_from_gateway(parent, gateway_id, device_id)
Args:
parent (str): The name of the registry. For example,
parent (str): Required. The name of the registry. For example,
``projects/example-project/locations/us-central1/registries/my-registry``.
gateway_id (str): The value of ``gateway_id`` can be either the device numeric ID or the
gateway_id (str): Required. The value of ``gateway_id`` can be either the device numeric
ID or the user-defined device identifier.
device_id (str): Required. The device to disassociate from the specified gateway. The
value of ``device_id`` can be either the device numeric ID or the
user-defined device identifier.
device_id (str): The device to disassociate from the specified gateway. The value of
``device_id`` can be either the device numeric ID or the user-defined
device identifier.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will
be retried using a default configuration.
Expand Down
30 changes: 8 additions & 22 deletions google/cloud/iot_v1/gapic/device_manager_client_config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
"retry_codes": {
"idempotent": ["DEADLINE_EXCEEDED", "UNAVAILABLE"],
"non_idempotent": [],
"rate_limited_aware": [
"DEADLINE_EXCEEDED",
"RESOURCE_EXHAUSTED",
"UNAVAILABLE",
],
},
"retry_params": {
"default": {
Expand All @@ -18,17 +13,8 @@
"initial_rpc_timeout_millis": 20000,
"rpc_timeout_multiplier": 1.0,
"max_rpc_timeout_millis": 20000,
"total_timeout_millis": 120000,
},
"rate_limited_aware": {
"initial_retry_delay_millis": 1000,
"retry_delay_multiplier": 1.3,
"max_retry_delay_millis": 60000,
"initial_rpc_timeout_millis": 20000,
"rpc_timeout_multiplier": 1.0,
"max_rpc_timeout_millis": 20000,
"total_timeout_millis": 120000,
},
"total_timeout_millis": 600000,
}
},
"methods": {
"CreateDeviceRegistry": {
Expand All @@ -48,7 +34,7 @@
},
"DeleteDeviceRegistry": {
"timeout_millis": 60000,
"retry_codes_name": "idempotent",
"retry_codes_name": "non_idempotent",
"retry_params_name": "default",
},
"ListDeviceRegistries": {
Expand All @@ -73,7 +59,7 @@
},
"DeleteDevice": {
"timeout_millis": 60000,
"retry_codes_name": "idempotent",
"retry_codes_name": "non_idempotent",
"retry_params_name": "default",
},
"ListDevices": {
Expand All @@ -83,8 +69,8 @@
},
"ModifyCloudToDeviceConfig": {
"timeout_millis": 60000,
"retry_codes_name": "rate_limited_aware",
"retry_params_name": "rate_limited_aware",
"retry_codes_name": "non_idempotent",
"retry_params_name": "default",
},
"ListDeviceConfigVersions": {
"timeout_millis": 60000,
Expand Down Expand Up @@ -113,8 +99,8 @@
},
"SendCommandToDevice": {
"timeout_millis": 60000,
"retry_codes_name": "rate_limited_aware",
"retry_params_name": "rate_limited_aware",
"retry_codes_name": "non_idempotent",
"retry_params_name": "default",
},
"BindDeviceToGateway": {
"timeout_millis": 60000,
Expand Down
Loading

0 comments on commit ce6f5cf

Please sign in to comment.