Google Cloud IoT Core V1 Client - Class ListDeviceStatesRequest (1.6.4)

Reference documentation and code samples for the Google Cloud IoT Core V1 Client class ListDeviceStatesRequest.

Request for ListDeviceStates.

Generated from protobuf message google.cloud.iot.v1.ListDeviceStatesRequest

Namespace

Google \ Cloud \ Iot \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` 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}`.
`↳ num_states`	`int` The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.

getName

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}.

Returns
Type	Description
`string`

setName

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}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNumStates

The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.

Returns
Type	Description
`int`

setNumStates

The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` 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}`. Please see Google\Cloud\Iot\V1\DeviceManagerClient::deviceName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Iot\V1\ListDeviceStatesRequest`