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

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

Request for ModifyCloudToDeviceConfig.

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

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

↳ version_to_update int|string

The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.

↳ binary_data string

Required. The configuration data for the device.

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

getVersionToUpdate

The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.

Returns
Type Description
int|string

setVersionToUpdate

The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getBinaryData

Required. The configuration data for the device.

Returns
Type Description
string

setBinaryData

Required. The configuration data for the device.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

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

binaryData string

Required. The configuration data for the device.

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