ingest
Protocol buffer definition for ingest
sift/ingest/v1/ingest.proto
IngestArbitraryProtobufDataStreamRequest
| Field | Type | Label | Description |
|---|---|---|---|
| message_type_identifier | string | ||
| message_type_display_name | string | optional | |
| asset_name | string | ||
| timestamp | google.protobuf.Timestamp | ||
| value | bytes | ||
| run_id | string | ||
| namespace | string | ||
| organization_id | string | ||
| end_stream_on_validation_error | bool | By default, if this request fails to parse for any reason, the request is stored in an error queue and the stream continues to accept data. This ensures all data is saved, but only valid data is fully ingested. If this is set to true, any validation errors end the stream and return the error to the client. |
IngestArbitraryProtobufDataStreamResponse
IngestWithConfigDataChannelValue
| Field | Type | Label | Description |
|---|---|---|---|
| oneof type.string | string | ||
| oneof type.double | double | ||
| oneof type.float | float | ||
| oneof type.bool | bool | ||
| oneof type.int32 | int32 | ||
| oneof type.uint32 | uint32 | ||
| oneof type.int64 | int64 | ||
| oneof type.uint64 | uint64 | ||
| oneof type.bit_field | bytes | ||
| oneof type.enum | uint32 | ||
| oneof type.empty | google.protobuf.Empty | If there's not a new data point for a channel at the given timestamp, pass empty to skip it |
IngestWithConfigDataStreamRequest
| Field | Type | Label | Description |
|---|---|---|---|
| ingestion_config_id | string | ||
| flow | string | ||
| timestamp | google.protobuf.Timestamp | ||
| channel_values | IngestWithConfigDataChannelValue | repeated | |
| run_id | string | The run_id MUST be included if this data is part of a run. | |
| end_stream_on_validation_error | bool | By default, if this request contains any channel values that do not match the supplied ingestion config, the request is stored in an error queue and the stream continues to accept data. This ensures all data is saved, but only valid data is fully ingested. If this is set to true, any validation errors end the stream and return the error to the client. | |
| organization_id | string |
IngestWithConfigDataStreamResponse
IngestService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| IngestWithConfigDataStream | IngestWithConfigDataStreamRequest stream | IngestWithConfigDataStreamResponse | |
| IngestArbitraryProtobufDataStream | IngestArbitraryProtobufDataStreamRequest stream | IngestArbitraryProtobufDataStreamResponse |