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

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

Request for GetDevice.

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

Namespace

Google \ Cloud \ Iot \ V1

Methods

__construct

Constructor.

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

↳ field_mask Google\Protobuf\FieldMask

The fields of the Device resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields have to be provided in snake_case format, for example: last_heartbeat_time.

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getFieldMask

The fields of the Device resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields have to be provided in snake_case format, for example: last_heartbeat_time.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasFieldMask

clearFieldMask

setFieldMask

The fields of the Device resource to be returned in the response. If the field mask is unset or empty, all fields are returned. Fields have to be provided in snake_case format, for example: last_heartbeat_time.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\Iot\V1\GetDeviceRequest