Google Cloud IoT Core V1 Client - Class UpdateDeviceRequest (1.7.4)

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

Request for UpdateDevice.

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

Namespace

Google \ Cloud \ Iot \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ device Google\Cloud\Iot\V1\Device

Required. The new values for the device. The id and num_id fields must be empty, and the field name must specify the name path. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
↳ update_mask Google\Protobuf\FieldMask

Required. Only updates the device fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: credentials, blocked, and metadata

getDevice

Required. The new values for the device. The id and num_id fields must be empty, and the field name must specify the name path. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

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

hasDevice

clearDevice

setDevice

Required. The new values for the device. The id and num_id fields must be empty, and the field name must specify the name path. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.

Parameter
Name Description
var Google\Cloud\Iot\V1\Device
Returns
Type Description
$this

getUpdateMask

Required. Only updates the device fields indicated by this mask.

The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: credentials, blocked, and metadata

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Only updates the device fields indicated by this mask.

The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: credentials, blocked, and metadata

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
device Google\Cloud\Iot\V1\Device

Required. The new values for the device. The id and num_id fields must be empty, and the field name must specify the name path. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0or projects/p0/locations/us-central1/registries/registry0/devices/{num_id}.
updateMask Google\Protobuf\FieldMask

Required. Only updates the device fields indicated by this mask. The field mask must not be empty, and it must not contain fields that are immutable or only set by the server. Mutable top-level fields: credentials, blocked, and metadata
Returns
Type Description
Google\Cloud\Iot\V1\UpdateDeviceRequest