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

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

The device configuration. Eventually delivered to devices.

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

Namespace

Google \ Cloud \ Iot \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ version`	`int\|string` [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the `CreateDevice` request if a `config` is specified; the response of `CreateDevice` will always have a value of 1.
`↳ cloud_update_time`	`Google\Protobuf\Timestamp` [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
`↳ device_ack_time`	`Google\Protobuf\Timestamp` [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
`↳ binary_data`	`string` The device configuration data.

getVersion

[Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the CreateDevice request if a config is specified; the response of CreateDevice will always have a value of 1.

Returns
Type	Description
`int\|string`

setVersion

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getCloudUpdateTime

[Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCloudUpdateTime

clearCloudUpdateTime

setCloudUpdateTime

[Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDeviceAckTime

[Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasDeviceAckTime

clearDeviceAckTime

setDeviceAckTime

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getBinaryData

The device configuration data.

Returns
Type	Description
`string`

setBinaryData

The device configuration data.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`