Reference documentation and code samples for the Google Cloud IoT Core V1 Client class ListDevicesRequest.
Request for ListDevices
.
Generated from protobuf message google.cloud.iot.v1.ListDevicesRequest
Namespace
Google \ Cloud \ Iot \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry
.
↳ device_num_ids
array
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
↳ device_ids
array
A list of device string IDs. For example, ['device0', 'device12']
. If empty, this field is ignored. Maximum IDs: 10,000
↳ field_mask
Google\Protobuf\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
↳ 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
string
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.
getParent
Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry
.
string
setParent
Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry
.
var
string
$this
getDeviceNumIds
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
setDeviceNumIds
A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.
$this
getDeviceIds
A list of device string IDs. For example, ['device0', 'device12']
.
If empty, this field is ignored. Maximum IDs: 10,000
setDeviceIds
A list of device string IDs. For example, ['device0', 'device12']
.
If empty, this field is ignored. Maximum IDs: 10,000
var
string[]
$this
getFieldMask
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
.
hasFieldMask
clearFieldMask
setFieldMask
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
.
$this
getGatewayListOptions
Options related to gateways.
hasGatewayListOptions
clearGatewayListOptions
setGatewayListOptions
Options related to gateways.
$this
getPageSize
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.
int
setPageSize
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.
var
int
$this
getPageToken
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.
string
setPageToken
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.
var
string
$this
static::build
parent
string
Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry
. Please see Google\Cloud\Iot\V1\DeviceManagerClient::registryName()
for help formatting this field.
