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

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

Request for UpdateDeviceRegistry.

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

Namespace

Google \ Cloud \ Iot \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ device_registry Google\Cloud\Iot\V1\DeviceRegistry

Required. The new values for the device registry. The id field must be empty, and the name field must indicate the path of the resource. For example, projects/example-project/locations/us-central1/registries/my-registry.
↳ update_mask Google\Protobuf\FieldMask

Required. Only updates the device_registry 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: event_notification_config, http_config, mqtt_config, and state_notification_config.

getDeviceRegistry

Required. The new values for the device registry. The id field must be empty, and the name field must indicate the path of the resource. For example, projects/example-project/locations/us-central1/registries/my-registry.

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

hasDeviceRegistry

clearDeviceRegistry

setDeviceRegistry

Required. The new values for the device registry. The id field must be empty, and the name field must indicate the path of the resource. For example, projects/example-project/locations/us-central1/registries/my-registry.

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

getUpdateMask

Required. Only updates the device_registry 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: event_notification_config, http_config, mqtt_config, and state_notification_config.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Only updates the device_registry 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: event_notification_config, http_config, mqtt_config, and state_notification_config.

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

static::build

Parameters
Name Description
deviceRegistry Google\Cloud\Iot\V1\DeviceRegistry

Required. The new values for the device registry. The id field must be empty, and the name field must indicate the path of the resource. For example, projects/example-project/locations/us-central1/registries/my-registry.
updateMask Google\Protobuf\FieldMask

Required. Only updates the device_registry 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: event_notification_config, http_config, mqtt_config, and state_notification_config.
Returns
Type Description
Google\Cloud\Iot\V1\UpdateDeviceRegistryRequest