public sealed class Device : IMessage<Device>, IEquatable<Device>, IDeepCloneable<Device>, IBufferMessage, IMessageReference documentation and code samples for the Cloud IoT v1 API class Device.
The device resource.
Namespace
Google.Cloud.Iot.V1Assembly
Google.Cloud.Iot.V1.dll
Constructors
Device()
public Device()Device(Device)
public Device(Device other)| Parameter | |
|---|---|
| Name | Description |
other | Device |
Properties
Blocked
public bool Blocked { get; set; }If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
Config
public DeviceConfig Config { get; set; }The most recent device configuration, which is eventually sent from
Cloud IoT Core to the device. If not present on creation, the
configuration will be initialized with an empty payload and version value
of 1. To update this field after creation, use the
DeviceManager.ModifyCloudToDeviceConfig method.
| Property Value | |
|---|---|
| Type | Description |
DeviceConfig | |
Credentials
public RepeatedField<DeviceCredential> Credentials { get; }The credentials used to authenticate this device. To allow credential
rotation without interruption, multiple device credentials can be bound to
this device. No more than 3 credentials can be bound to a single device at
a time. When new credentials are added to a device, they are verified
against the registry credentials. For details, see the description of the
DeviceRegistry.credentials field.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<DeviceCredential> | |
DeviceName
public DeviceName DeviceName { get; set; }DeviceName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DeviceName | |
GatewayConfig
public GatewayConfig GatewayConfig { get; set; }Gateway-related configuration and state.
| Property Value | |
|---|---|
| Type | Description |
GatewayConfig | |
Id
public string Id { get; set; }The user-defined device identifier. The device ID must be unique within a device registry.
| Property Value | |
|---|---|
| Type | Description |
String | |
LastConfigAckTime
public Timestamp LastConfigAckTime { get; set; }[Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastConfigSendTime
public Timestamp LastConfigSendTime { get; set; }[Output only] The last time a cloud-to-device config version was sent to the device.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastErrorStatus
public Status LastErrorStatus { get; set; }[Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
| Property Value | |
|---|---|
| Type | Description |
Status | |
LastErrorTime
public Timestamp LastErrorTime { get; set; }[Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastEventTime
public Timestamp LastEventTime { get; set; }[Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastHeartbeatTime
public Timestamp LastHeartbeatTime { get; set; }[Output only] The last time an MQTT PINGREQ was received. This field
applies only to devices connecting through MQTT. MQTT clients usually only
send PINGREQ messages if the connection is idle, and no other messages
have been sent. Timestamps are periodically collected and written to
storage; they may be stale by a few minutes.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastStateTime
public Timestamp LastStateTime { get; set; }[Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LogLevel
public LogLevel LogLevel { get; set; }Beta Feature
The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used.
| Property Value | |
|---|---|
| Type | Description |
LogLevel | |
Metadata
public MapField<string, string> Metadata { get; }The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device.
Keys must conform to the regular expression [a-zA-Z][a-zA-Z0-9-_.+~%]+ and be less than 128 bytes in length.
Values are free-form strings. Each value must be less than or equal to 32 KB in size.
The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500.
| Property Value | |
|---|---|
| Type | Description |
MapField<String, String> | |
Name
public string Name { get; set; }The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0 or
projects/p1/locations/us-central1/registries/registry0/devices/{num_id}.
When name is populated as a response from the service, it always ends
in the device numeric ID.
| Property Value | |
|---|---|
| Type | Description |
String | |
NumId
public ulong NumId { get; set; }[Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.
| Property Value | |
|---|---|
| Type | Description |
UInt64 | |
State
public DeviceState State { get; set; }[Output only] The state most recently received from the device. If no state has been reported, this field is not present.
| Property Value | |
|---|---|
| Type | Description |
DeviceState | |