Class ListDevicesRequest (2.5.0)

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

Request for ListDevices.

Attributes

NameDescription
parent str
Required. The device registry path. Required. For example, ``projects/my-project/locations/us-central1/registries/my-registry``.
device_num_ids Sequence[int]
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
device_ids Sequence[str]
A list of device string IDs. For example, ``['device0', 'device12']``. If empty, this field is ignored. Maximum IDs: 10,000
field_mask google.protobuf.field_mask_pb2.FieldMask
The fields of the ``Device`` resource to be returned in the response. The fields ``id`` and ``num_id`` are always returned, along with any other fields specified in snake_case format, for example: ``last_heartbeat_time``.
gateway_list_options google.cloud.iot_v1.types.GatewayListOptions
Options related to gateways.
page_size int
The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty ``next_page_token`` in the response indicates that more data is available.
page_token str
The value returned by the last ``ListDevicesResponse``; indicates that this is a continuation of a prior ``ListDevices`` call and the system should return the next page of data.

Inheritance

builtins.object > proto.message.Message > ListDevicesRequest