Skip to main content

types

DataStreamExport​

A Yandex Data Streams export.

id : string​

ID of the YDS export.

name : string​

Name of the YDS export.

registryId : string​

ID of the registry that the YDS export belongs to.

mqttTopicFilter : string​

MQTT topic whose messages export to YDS.

database : string​

YDS database.

stream : string​

YDS stream name.

serviceAccountId : string​

ID of the service account which has permission to write to data stream.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

Device​

A device. For more information, see Device.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Device is being created.

  • ACTIVE

    Device is ready to use.

  • DELETING

    Device is being deleted.

id : string​

ID of the device.

registryId : string​

ID of the registry that the device belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the device. The name is unique within the registry.

description : string​

Description of the device. 0-256 characters long.

topicAliases : string​

Alias of a device topic.

Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. my/custom/alias match to $device/abcdef/events.

status : Status​

Status of the device.

monitoringData : DeviceMonitoringData​

Device monitoring data, returns if FULL view specified.

DeviceAlias​

A device topic alias.

Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. my/custom/alias match to $device/abcdef/events. For more information, see Using topic aliases.

deviceId : string​

ID of the device that the alias belongs to.

topicPrefix : string​

Prefix of a canonical topic name to be aliased, e.g. $devices/abcdef.

alias : string​

Alias of a device topic.

DeviceCertificate​

A device certificate. For more information, see Managing device certificates.

deviceId : string​

ID of the device that the certificate belongs to.

fingerprint : string​

SHA256 hash of the certificate.

certificateData : string​

Public part of the certificate.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

DeviceMonitoringData​

lastAuthIp : string​
lastAuthTime : google.protobuf.Timestamp​
lastPubActivityTime : google.protobuf.Timestamp​
lastSubActivityTime : google.protobuf.Timestamp​
lastOnlineTime : google.protobuf.Timestamp​

DevicePassword​

A device password.

deviceId : string​

ID of the device that the password belongs to.

id : string​

ID of the password.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

LogOptions​

disabled : bool​

Is logging from registry disabled.

One of destination​

Log entries destination.

  • logGroupId : string​

    Entry should be written to log group resolved by ID.

  • folderId : string​

    Entry should be written to default log group for specified folder.

minLevel : yandex.cloud.logging.v1.LogLevel.Level​

Minimum log entry level.

See LogLevel.Level for details.

Registry​

A registry. For more information, see Registry.

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Registry is being created.

  • ACTIVE

    Registry is ready to use.

  • DELETING

    Registry is being deleted.

  • DISABLED

    Registry is disabled.

id : string​

ID of the registry.

folderId : string​

ID of the folder that the registry belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

name : string​

Name of the registry. The name is unique within the folder.

description : string​

Description of the registry. 0-256 characters long.

labels : string​

Resource labels as key:value pairs. Maximum of 64 per resource.

status : Status​

Status of the registry.

logGroupId : string​

ID of the logs group for the specified registry.

logOptions : LogOptions​

Options for logging registry events

RegistryCertificate​

A registry certificate. For more information, see Managing registry certificates.

registryId : string​

ID of the registry that the certificate belongs to.

fingerprint : string​

SHA256 hash of the certificates.

certificateData : string​

Public part of the certificate.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

RegistryPassword​

A registry password.

registryId : string​

ID of the registry that the password belongs to.

id : string​

ID of the password.

createdAt : google.protobuf.Timestamp​

Creation timestamp.