Device

google.cloud.iot.v1. Device

Represents a Device.

Constructor

new Device(propertiesopt)

Constructs a new Device.

Parameters:
Name Type Attributes Description
properties google.cloud.iot.v1.IDevice <optional>

Properties to set

Implements:
  • IDevice

Members

blocked

Device blocked.

config

Device config.

credentials

Device credentials.

gatewayConfig

Device gatewayConfig.

id

Device id.

lastConfigAckTime

Device lastConfigAckTime.

lastConfigSendTime

Device lastConfigSendTime.

lastErrorStatus

Device lastErrorStatus.

lastErrorTime

Device lastErrorTime.

lastEventTime

Device lastEventTime.

lastHeartbeatTime

Device lastHeartbeatTime.

lastStateTime

Device lastStateTime.

logLevel

Device logLevel.

metadata

Device metadata.

name

Device name.

numId

Device numId.

state

Device state.

Methods

(static) create(propertiesopt) → {google.cloud.iot.v1.Device}

Creates a new Device instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.iot.v1.IDevice <optional>

Properties to set

Returns:
Type Description
google.cloud.iot.v1.Device

Device instance

(static) decode(reader, lengthopt) → {google.cloud.iot.v1.Device}

Decodes a Device message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.iot.v1.Device

Device

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.iot.v1.Device}

Decodes a Device message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.iot.v1.Device

Device

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Device message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.iot.v1.IDevice

Device message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Device message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.iot.v1.IDevice

Device message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.iot.v1.Device}

Creates a Device message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.iot.v1.Device

Device

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Device message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.iot.v1.Device

Device

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Device message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Device to JSON.

Returns:
Type Description
Object.<string, *>

JSON object