Google Cloud IoT Core V1 Client - Class ListDevicesRequest (1.7.5)

Version latest

• 1.7.5 (latest)
• 1.7.4
• 1.6.4
• 1.5.12

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
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	Google\Cloud\Iot\V1\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	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.

Returns
Type	Description
string

setParent

Required. The device registry path. Required. For example, projects/my-project/locations/us-central1/registries/my-registry.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDeviceNumIds

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDeviceNumIds

A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000.

Parameter
Name	Description
var	int[]|string[]|Google\Protobuf\Internal\RepeatedField

Returns
Type	Description
$this

getDeviceIds

A list of device string IDs. For example, ['device0', 'device12'].

If empty, this field is ignored. Maximum IDs: 10,000

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDeviceIds

A list of device string IDs. For example, ['device0', 'device12'].

If empty, this field is ignored. Maximum IDs: 10,000

Parameter
Name	Description
var	string[]

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\FieldMask|null

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.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getGatewayListOptions

Options related to gateways.

Returns
Type	Description
Google\Cloud\Iot\V1\GatewayListOptions|null

hasGatewayListOptions

clearGatewayListOptions

setGatewayListOptions

Options related to gateways.

Parameter
Name	Description
var	Google\Cloud\Iot\V1\GatewayListOptions

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	int

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
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.

Returns
Type	Description
Google\Cloud\Iot\V1\ListDevicesRequest