Module api

Source

Modules§

absolute_timestamp
async_handle
authentication
batch_granularity_mismatch
channel_config
channel_prefix
complete_multipart_upload_response
containerized_extractor
containerized_extractor_container_failed
containerized_extractor_not_found
containerized_extractor_rid
containerized_extractor_service
containerized_extractors_not_found
containerized_opts
csv_opts
custom_timestamp
data_source_ref_name
dataflash_opts
dataset_file_not_found
dataset_ingest_target
dataset_not_found
dataset_spec
deprecated_new_csv
deprecated_new_data_source
deprecated_timestamp_metadata
deprecated_trigger_ingest
docker_image_source
empty_multipart_upload
environment_variable
epoch_timestamp
existing_dataset_ingest_destination
existing_video_ingest_destination
file_extraction_input
file_filter
file_output_format
file_suffix
frame_count_timestamps_mismatch
gcs_ingest_source
get_containerized_extractors_request
get_containerized_extractors_response
incompatible_connection_type_and_log_query
incompatible_file_for_dataset
incompatible_inputs
incorrect_size_bytes
ingest_data_source
ingest_dataset_file_details
ingest_destination
ingest_details
ingest_job_request
ingest_job_rid
ingest_mcap_request
ingest_mcap_response
ingest_metadata
ingest_options
ingest_progress_v2
ingest_request
ingest_response
ingest_run_data_source
ingest_run_request
ingest_run_response
ingest_service
ingest_source
ingest_source_metadata
ingest_status
ingest_video_file_details
ingest_video_request
ingest_video_response
initiate_multipart_upload_request
initiate_multipart_upload_response
invalid_bucket
invalid_container_image
invalid_custom_timestamp_format
invalid_default_tag
invalid_output_file_format
invalid_s3_path
iso8601_timestamp
journal_json_opts
journal_timestamp_metadata
log_time
mcap_channel_config
mcap_channel_config_type
mcap_channels
mcap_destination
mcap_ingestion_output
mcap_protobuf_timeseries_opts
mcap_source
mcap_timestamp_type
mcap_video_channel_config
missing_metadata_for_reingest
new_data_source
new_dataset_ingest_destination
new_video_ingest_destination
no_timestamp_manifest
parallel_reingest_into_dataset_v1
parquet_opts
part
part_with_size
public_authentication
recursive_reingest
register_containerized_extractor_request
register_containerized_extractor_response
reingest_datasets_request
reingest_datasets_response
reingest_files_mapping
reingest_too_many_files
relative_timestamp
run_rid
s3_ingest_source
s3_path_not_found
scale_parameter
search_containerized_extractors_query
search_containerized_extractors_request
sign_part_response
skip_rows_config
tag_details
time_offset_spec
timestamp_manifest
timestamp_metadata
timestamp_type
trigger_file_ingest
trigger_ingest
triggered_ingest
unsupported_ingest_source
update_containerized_extractor_request
user_and_password_authentication
utc_timestamp
video_file_ingest_details
video_ingest_target
video_opts
video_timestamp_manifest

Structs§

AsyncContainerizedExtractorServiceEndpoints
AsyncHandle
AsyncIngestServiceEndpoints
BatchGranularityMismatch
All dataset granularities must match.
ChannelConfig
ChannelPrefix
A string to prefix before every channel name in this file. Defaults to no prefix.
CompleteMultipartUploadResponse
ContainerizedExtractor
Represents a containerized extractor that processes input files using a container.
ContainerizedExtractorContainerFailed
ContainerizedExtractorNotFound
ContainerizedExtractorRid
ContainerizedExtractorServiceAsyncClient
The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
ContainerizedExtractorServiceClient
The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
ContainerizedExtractorServiceEndpoints
ContainerizedExtractorsNotFound
ContainerizedOpts
CsvOpts
Options for ingesting csv files. Supported file formats include .csv, .csv.gz
CustomTimestamp
DataSourceRefName
DataflashOpts
DatasetFileNotFound
The target dataset file could not be found.
DatasetNotFound
The target dataset could not be found.
DatasetSpec
DeprecatedNewCsv
DeprecatedTimestampMetadata
DeprecatedTriggerIngest
DockerImageSource
Docker container image source definition.
EmptyMultipartUpload
EnvironmentVariable
Name of an environment variable to be passed to the container during extraction.
EpochTimestamp
ExistingDatasetIngestDestination
ExistingVideoIngestDestination
FileExtractionInput
Defines an input file to be provided to the extractor.
FileSuffix
The expected suffix of the file. For example, “parquet”, “json”, “csv”, etc.
FrameCountTimestampsMismatch
GcsIngestSource
GetContainerizedExtractorsRequest
GetContainerizedExtractorsResponse
IncompatibleConnectionTypeAndLogQuery
IncompatibleFileForDataset
IncompatibleInputs
The inputs provided to the ingest job are incompatible with each other
IncorrectSizeBytes
IngestDatasetFileDetails
IngestJobRid
Unique resource identifier for an Ingest Job.
IngestMcapRequest
IngestMcapResponse
Returns references to the data ingested from an MCAP file.
IngestMetadata
IngestProgressV2
IngestRequest
IngestResponse
IngestRunDataSource
IngestRunRequest
IngestRunResponse
IngestServiceAsyncClient
The Ingest Service handles the data ingestion into Nominal/Clickhouse.
IngestServiceClient
The Ingest Service handles the data ingestion into Nominal/Clickhouse.
IngestServiceEndpoints
IngestSourceMetadata
IngestVideoFileDetails
IngestVideoRequest
IngestVideoResponse
InitiateMultipartUploadRequest
InitiateMultipartUploadResponse
InvalidBucket
InvalidContainerImage
InvalidCustomTimestampFormat
InvalidDefaultTag
InvalidOutputFileFormat
InvalidS3Path
Iso8601Timestamp
JournalJsonOpts
JournalTimestampMetadata
LogTime
McapChannelConfig
McapIngestionOutput
McapProtobufTimeseriesOpts
McapVideoChannelConfig
Ingest a channel as video. This requires:
MissingMetadataForReingest
The timestamp metadata required to reingest the dataset is missing and must be provided in the request.
NewDataSource
NewDatasetIngestDestination
NewVideoIngestDestination
NoTimestampManifest
ParallelReingestIntoDatasetV1
Cannot ingest multiple datasets in parallel into older datasets. It is recommended to reingest all source datasets and the target dataset into a new dataset destination.
ParquetOpts
Options for ingesting parquet files. Supported file formats include .parquet, .parquet.gz and archives such as .tar, .tar.gz, and .zip (must set the isArchive flag).
Part
PartWithSize
PublicAuthentication
RecursiveReingest
The target dataset is included in the source datasets.
RegisterContainerizedExtractorRequest
RegisterContainerizedExtractorResponse
ReingestDatasetsRequest
ReingestDatasetsResponse
The response to a reingest request. Maps the source dataset RID and file ID to the destination dataset RID and file ID.
ReingestFilesMapping
Maps the source dataset file ID to the destination dataset and file ID.
ReingestTooManyFiles
The number of files to reingest is too large.
RelativeTimestamp
RunRid
S3IngestSource
S3PathNotFound
SearchContainerizedExtractorsRequest
SignPartResponse
SkipRowsConfig
TagDetails
TimestampManifest
The timestamp manifest files will contain a list of absolute timestamps, in nanoseconds, that correspond to each frame in a video. Each file should be of type JSON and store a single list, the length of which equals the number of frames in its corresponding video.
TimestampMetadata
TriggerFileIngest
TriggerIngest
TriggeredIngest
UnsupportedIngestSource
UpdateContainerizedExtractorRequest
UserAndPasswordAuthentication
Username and password authentication.
UtcTimestamp
VideoFileIngestDetails
VideoOpts

Enums§

AbsoluteTimestamp
Authentication
DatasetIngestTarget
DeprecatedNewDataSource
FileFilter
FileOutputFormat
IngestDataSource
IngestDestination
IngestDetails
IngestJobRequest
IngestOptions
IngestSource
IngestStatus
McapChannelConfigType
McapChannels
McapDestination
McapSource
McapTimestampType
ScaleParameter
SearchContainerizedExtractorsQuery
TimeOffsetSpec
TimestampType
VideoIngestTarget
VideoTimestampManifest

Traits§

AsyncContainerizedExtractorService
The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
AsyncIngestService
The Ingest Service handles the data ingestion into Nominal/Clickhouse.
ContainerizedExtractorService
The Containerized Extractor service provides functionality for creating, updating, and archiving containerized extractors.
IngestService
The Ingest Service handles the data ingestion into Nominal/Clickhouse.