exports

Protocol buffer definition for exports

sift/exports/v1/exports.proto

AssetsAndTimeRange

FieldTypeLabelDescription
asset_idsstringrepeated
start_timegoogle.protobuf.Timestamp
stop_timegoogle.protobuf.Timestamp

CalculatedChannelConfig

FieldTypeLabelDescription
namestring
expressionstring
channel_referencessift.calculated_channels.v2.CalculatedChannelAbstractChannelReferencerepeated
unitsstringoptional

ExportDataRequest

FieldTypeLabelDescription
oneof time_selection.time_rangeTimeRangeIf time_range used, channel_ids or calculated_chanel_configs must be provided to scope data.
oneof time_selection.runs_and_time_rangeRunsAndTimeRangeRuns used to perform time selection and scope data. Times can optionally be provided to further scope within runs. If channel_ids or calculated_channel_configs not provided, all channels from Run Assets are added to scope.
oneof time_selection.assets_and_time_rangeAssetsAndTimeRangeAssets and times provided to scope data. If channel_ids or calculated_channel_configs not provided, all channels from Assets are added to scope.
channel_idsstringrepeated
calculated_channel_configsCalculatedChannelConfigrepeated
output_formatExportOutputFormat
export_optionsExportOptions

ExportDataResponse

FieldTypeLabelDescription
presigned_urlstringPre-signed URL of exported zip containing export files.

ExportOptions

FieldTypeLabelDescription
use_legacy_formatboolWhether to use legacy format string for channel headers which contains key-value metadata.
simplify_channel_namesboolWhether to simplify channel names by removing the component part of the name if name is unique in export file
combine_runsboolWhether to combine runs. e.g. channels from the same asset in different runs will be combined into a single column of data.
split_export_by_assetboolSplit each asset into their own export file
split_export_by_runboolSplit each run into their own export file

RunsAndTimeRange

FieldTypeLabelDescription
run_idsstringrepeated
start_timegoogle.protobuf.Timestamp
stop_timegoogle.protobuf.Timestamp

TimeRange

FieldTypeLabelDescription
start_timegoogle.protobuf.Timestamp
stop_timegoogle.protobuf.Timestamp

ExportOutputFormat

NameNumberDescription
EXPORT_OUTPUT_FORMAT_UNSPECIFIED0
EXPORT_OUTPUT_FORMAT_CSV1
EXPORT_OUTPUT_FORMAT_SUN2

ExportService

Method NameRequest TypeResponse TypeDescription
ExportDataExportDataRequestExportDataResponse

On this page