IoT Core Service, gRPC: RegistryService.AddDataStreamExport
Adds YDS export for the specified registry.
gRPC request
rpc AddDataStreamExport (AddDataStreamExportRequest) returns (operation.Operation)
AddDataStreamExportRequest
{
"name": "string",
"registryId": "string",
"mqttTopicFilter": "string",
"database": "string",
"stream": "string",
"serviceAccountId": "string"
}
Field |
Description |
name |
string Name of the YDS export. The name must be unique within the folder. |
registryId |
string Required field. ID of the registry to add a YDS export for. To get a registry ID make a RegistryService.List request. |
mqttTopicFilter |
string MQTT topic whose messages export to YDS. |
database |
string Required field. YDS database. |
stream |
string Required field. YDS stream name. |
serviceAccountId |
string Required field. ID of the service account which has permission to write to data stream. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"registryId": "string",
"dataStreamExportId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"name": "string",
"registryId": "string",
"mqttTopicFilter": "string",
"database": "string",
"stream": "string",
"serviceAccountId": "string",
"createdAt": "google.protobuf.Timestamp"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
AddDataStreamExportMetadata
Field |
Description |
registryId |
string ID of the registry for which the YDS export was added. |
dataStreamExportId |
string ID of the added YDS export. |
DataStreamExport
A Yandex Data Streams export.
Field |
Description |
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 |
Creation timestamp. |