Class GatewayListOptions (2.6.2)

GatewayListOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Options for limiting the list based on gateway type and associations.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
gateway_type google.cloud.iot_v1.types.GatewayType
If ``GATEWAY`` is specified, only gateways are returned. If ``NON_GATEWAY`` is specified, only non-gateway devices are returned. If ``GATEWAY_TYPE_UNSPECIFIED`` is specified, all devices are returned. This field is a member of `oneof`_ ``filter``.
associations_gateway_id str
If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (``num_id``) or the user-defined string (``id``). For example, if ``123`` is specified, only devices bound to the gateway with ``num_id`` 123 are returned. This field is a member of `oneof`_ ``filter``.
associations_device_id str
If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (``num_id``) or the user-defined string (``id``). For example, if ``456`` is specified, returns only the gateways to which the device with ``num_id`` 456 is bound. This field is a member of `oneof`_ ``filter``.

Inheritance

builtins.object > proto.message.Message > GatewayListOptions