Struct FileMetadata 

pub struct FileMetadata {

    pub external_id: Option<String>,
    pub name: String,
    pub directory: Option<String>,
    pub source: Option<String>,
    pub mime_type: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
    pub asset_ids: Option<Vec<i64>>,
    pub data_set_id: Option<i64>,
    pub source_created_time: Option<i64>,
    pub source_modified_time: Option<i64>,
    pub security_categories: Option<Vec<i64>>,
    pub labels: Option<Vec<CogniteExternalId>>,
    pub id: i64,
    pub uploaded: bool,
    pub uploaded_time: Option<i64>,
    pub created_time: i64,
    pub last_updated_time: i64,
}

Description of a CDF file.

Fields

external_id: Option<String>

File external ID. Must be unique accross all files in the project.

name: String

File name.

directory: Option<String>

Directory containing the file. Must be an absolute, unix-style path.

source: Option<String>

Source of the file.

mime_type: Option<String>

File mime type, e.g. application/pdf.

metadata: Option<HashMap<String, String>>

Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 128 bytes, value 10240 bytes, up to 256 key-value pairs, of total size at most 10240.

asset_ids: Option<Vec<i64>>

List of assets the file is tied to.

data_set_id: Option<i64>

Data set the file belongs to.

source_created_time: Option<i64>

Timestamp in milliseconds since epoch when this file was created in the source system.

source_modified_time: Option<i64>

Timestamp in milliseconds since epoch when this file was last modified in the source system.

security_categories: Option<Vec<i64>>

The required security categories to access this file.

labels: Option<Vec<CogniteExternalId>>

List of labels associated with this file.

id: i64

File internal ID.

uploaded: bool

Whether or not the actual file is uploaded.

uploaded_time: Option<i64>

Time this file was uploaded, in milliseconds since epoch.

created_time: i64

Time this file was created, in milliseconds since epoch.

last_updated_time: i64

Time this file was last modified, in milliseconds since epoch.

Trait Implementations

impl CleanResource<FileMetadata> for Files

async fn clean_resource( &self, resources: Vec<FileMetadata>, ) -> Result<(), Error>

Delete the provided resources.

impl Clone for FileMetadata

fn clone(&self) -> FileMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMetadata

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

Formats the value using the given formatter.

impl Default for FileMetadata

fn default() -> FileMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FilterWithRequest<PartitionedFilter<FileFilter>, FileMetadata> for Files

fn filter( &self, filter: TFilter, ) -> impl Future<Output = Result<ItemsVec<TResponse, Cursor>>> + Send

Filter resources.

fn filter_all( &self, filter: TFilter, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TFilter: SetCursor, TResponse: Send,

Filter resources, following cursors until they are exhausted.

fn filter_all_stream( &self, filter: TFilter, ) -> impl TryStream<Ok = TResponse, Error = Error, Item = Result<TResponse>> + Send

where TFilter: SetCursor, TResponse: Send + 'static,

Filter resources, following cursors. This returns a stream, you can abort the stream whenever you want and only resources retrieved up to that point will be returned.

fn filter_all_partitioned( &self, filter: TFilter, num_partitions: u32, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TFilter: SetCursor + WithPartition, TResponse: Send,

Filter resources using partitioned reads, following cursors until all partitions are exhausted.

fn filter_all_partitioned_stream( &self, filter: TFilter, num_partitions: u32, ) -> impl TryStream<Ok = TResponse, Error = Error, Item = Result<TResponse>> + Send

where TFilter: SetCursor + WithPartition, TResponse: Send + 'static,

Filter resources using partitioned reads, following cursors until all partitions are exhausted. This returns a stream.

impl From<FileMetadata> for AddFile

fn from(file: FileMetadata) -> AddFile

Converts to this type from the input type.

impl From<FileMetadata> for Patch<PatchFile>

fn from(file: FileMetadata) -> Self

Converts to this type from the input type.

impl IntoPatch<Patch<PatchFile>> for FileMetadata

fn patch(self, options: &UpsertOptions) -> Patch<PatchFile>

Convert self into a patch, optionally ignoring null values.

impl<R> RetrieveWithIgnoreUnknownIds<IdentityOrInstanceList<R>, FileMetadata> for Files

where IdentityOrInstanceList<R>: Serialize, R: Send + Sync,

fn retrieve( &self, ids: impl Into<TIdt> + Send, ignore_unknown_ids: bool, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Retrieve a list of items from CDF. If ignore_unknown_ids is false, this will fail if any items are missing from CDF.

impl SearchItems<'_, FileFilter, FileSearch, FileMetadata> for Files

fn search( &'a self, filter: TFilter, search: TSearch, limit: Option<u32>, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Fuzzy search resources.

impl Serialize for FileMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Update<Patch<PatchFile>, FileMetadata> for Files

fn update( &self, updates: &[TUpdate], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Update a list of resources.

fn update_from<'a, T>( &self, updates: &'a [T], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where T: Sync + Clone + 'a, TUpdate: From<T>,

Update a list of resources by converting to the update from a different type.

fn update_ignore_unknown_ids( &self, updates: &[TUpdate], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TUpdate: EqIdentity, TResponse: Send,

Update a list of resources, ignoring any that fail due to items missing in CDF.

fn update_from_ignore_unknown_ids<'a, T>( &self, updates: &'a [T], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where T: Sync + Clone + 'a, TUpdate: From<T> + EqIdentity, TResponse: Send,

Update a list of resources by converting from a different type, ignoring any that fail due items missing in CDF.