ingest

Services

RPC methods exposed by this API.

IngestService

Method	Request	Response	Description
IngestWithConfigDataStream	IngestWithConfigDataStreamRequest (stream)	IngestWithConfigDataStreamResponse
IngestArbitraryProtobufDataStream	IngestArbitraryProtobufDataStreamRequest (stream)	IngestArbitraryProtobufDataStreamResponse

Messages

Data models used across requests/responses.

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

This message has no fields.

IngestWithConfigDataChannelValue

Field	Type	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
oneof type. bytes	bytes

IngestWithConfigDataStreamRequest

INTERNAL NOTE (remove from public protos): Any updates to this proto message MUST also update the IngestWithConfigDataStreamRequestLite and IngestWithConfigDataStreamChannelValuesOnly proto messages in sift_internal/ingest/v1/ingest.proto. For performance, only the minimal set of fields is deserialized on ingest by the IngestWithConfigDataStreamRequestLite proto message definition; other fields that are expensive and/or large and that are not required to be parsed should not be included there. Additionally, the field number MUST match exactly as we depend on the field numbers to correctly decode the fields despite technically different message definitions.

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

This message has no fields.

Enums

Allowed constant values used in message fields.

Authenticate

Clients

Review

Export

Endpoints & protobuf definitions

Services

IngestService

Messages

IngestArbitraryProtobufDataStreamRequest

IngestArbitraryProtobufDataStreamResponse

IngestWithConfigDataChannelValue

IngestWithConfigDataStreamRequest

IngestWithConfigDataStreamResponse

Enums

​Services

​IngestService

​Messages

​IngestArbitraryProtobufDataStreamRequest

​IngestArbitraryProtobufDataStreamResponse

​IngestWithConfigDataChannelValue

​IngestWithConfigDataStreamRequest

​IngestWithConfigDataStreamResponse

​Enums

Services

IngestService

Messages

IngestArbitraryProtobufDataStreamRequest

IngestArbitraryProtobufDataStreamResponse

IngestWithConfigDataChannelValue

IngestWithConfigDataStreamRequest

IngestWithConfigDataStreamResponse

Enums