Struct DatasetFile 

pub struct DatasetFile { /* private fields */ }

Implementations

impl DatasetFile

pub fn builder() -> Builder<IdStage>

Returns a new builder.

impl DatasetFile

pub fn id(&self) -> DatasetFileId

pub fn dataset_rid(&self) -> &ResourceIdentifier

pub fn name(&self) -> &str

pub fn handle(&self) -> &Handle

pub fn file_size_bytes(&self) -> Option<SafeLong>

Size in bytes of the stored dataset file; for transforming ingests this is the produced output, not the original upload.

pub fn bounds(&self) -> Option<&Bounds>

pub fn uploaded_at(&self) -> DateTime<Utc>

Timestamp that the file was received and stored, but not processed or made available to consumers.

pub fn ingested_at(&self) -> Option<DateTime<Utc>>

Timestamp that the file is ingested at and made available for processing. If the file has failed to be ingested for any reason or is still being processed, then this value will be empty.

pub fn ingest_status(&self) -> &IngestStatusV2

Ingest status. The in-progress sub-phases (queued, parsing, ingesting) are surfaced as inProgress with the phase carried in InProgressResult.inProgressDetails, so consumers see a stable top-level lifecycle.

pub fn timestamp_metadata(&self) -> Option<&TimestampMetadata>

pub fn ingest_tag_metadata(&self) -> Option<&IngestTagMetadata>

pub fn origin_file_paths(&self) -> Option<&[String]>

pub fn ingest_job_rid(&self) -> Option<&ResourceIdentifier>

pub fn ingest_transform_rid(&self) -> Option<&ResourceIdentifier>

The ingest transform within ingestJobRid that produced this file. An ingest job may fan out to many transforms, so this pins the file to the specific unit of work (and extractor) that created it — resolvable via IngestJobService#getIngestTransform. Extractor logs are tagged with this transform’s UUID (the RID locator), so this also links a file to the logs of the transform that produced it. Absent for directly uploaded files and for files ingested before this link was recorded.

pub fn deleted_at(&self) -> Option<DateTime<Utc>>

Timestamp that the file is deleted at, only present if the file has been deleted.

pub fn metadata(&self) -> Option<&DatasetFileMetadata>

File-type-specific metadata. For video files, contains timestamp manifest and segment metadata.

Trait Implementations

impl Clone for DatasetFile

fn clone(&self) -> DatasetFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatasetFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DatasetFile

fn deserialize<__D>( __deserializer: __D, ) -> Result<DatasetFile, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DatasetFile

impl From<DatasetFile> for Builder<Complete>

fn from(v: DatasetFile) -> Builder<Complete>

Converts to this type from the input type.

impl Hash for DatasetFile

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DatasetFile

fn cmp(&self, other: &DatasetFile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DatasetFile

fn eq(&self, other: &DatasetFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DatasetFile

fn partial_cmp(&self, other: &DatasetFile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DatasetFile

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.