Represents a Device.
Package
@google-cloud/iotConstructors
(constructor)(properties)
constructor(properties?: google.cloud.iot.v1.IDevice);Constructs a new Device.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDevice
Properties to set |
Properties
blocked
public blocked: boolean;Device blocked.
config
public config?: (google.cloud.iot.v1.IDeviceConfig|null);Device config.
credentials
public credentials: google.cloud.iot.v1.IDeviceCredential[];Device credentials.
gatewayConfig
public gatewayConfig?: (google.cloud.iot.v1.IGatewayConfig|null);Device gatewayConfig.
id
public id: string;Device id.
lastConfigAckTime
public lastConfigAckTime?: (google.protobuf.ITimestamp|null);Device lastConfigAckTime.
lastConfigSendTime
public lastConfigSendTime?: (google.protobuf.ITimestamp|null);Device lastConfigSendTime.
lastErrorStatus
public lastErrorStatus?: (google.rpc.IStatus|null);Device lastErrorStatus.
lastErrorTime
public lastErrorTime?: (google.protobuf.ITimestamp|null);Device lastErrorTime.
lastEventTime
public lastEventTime?: (google.protobuf.ITimestamp|null);Device lastEventTime.
lastHeartbeatTime
public lastHeartbeatTime?: (google.protobuf.ITimestamp|null);Device lastHeartbeatTime.
lastStateTime
public lastStateTime?: (google.protobuf.ITimestamp|null);Device lastStateTime.
logLevel
public logLevel: (google.cloud.iot.v1.LogLevel|keyof typeof google.cloud.iot.v1.LogLevel);Device logLevel.
metadata
public metadata: { [k: string]: string };Device metadata.
name
public name: string;Device name.
numId
public numId: (number|Long|string);Device numId.
state
public state?: (google.cloud.iot.v1.IDeviceState|null);Device state.
Methods
create(properties)
public static create(properties?: google.cloud.iot.v1.IDevice): google.cloud.iot.v1.Device;Creates a new Device instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDevice
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Device |
Device instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.iot.v1.Device;Decodes a Device message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Device |
Device |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.iot.v1.Device;Decodes a Device message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Device |
Device |
encode(message, writer)
public static encode(message: google.cloud.iot.v1.IDevice, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Device message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDevice
Device message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.iot.v1.IDevice, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Device message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDevice
Device message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.iot.v1.Device;Creates a Device message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Device |
Device |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Device
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Device to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.iot.v1.Device, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Device message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Device
Device |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Device message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|