Skip to main content

AsyncSeriesMetadataService

Trait AsyncSeriesMetadataService 

Source
pub trait AsyncSeriesMetadataService {
    // Required methods
    fn batch_get(
        &self,
        auth_: BearerToken,
        request: BatchGetSeriesMetadataRequest,
    ) -> impl Future<Output = Result<BatchGetSeriesMetadataResponse, Error>> + Send;
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateSeriesMetadataRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn batch_create(
        &self,
        auth_: BearerToken,
        request: BatchCreateSeriesMetadataRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn create_or_update(
        &self,
        auth_: BearerToken,
        request: CreateSeriesMetadataRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn batch_create_or_update(
        &self,
        auth_: BearerToken,
        request: BatchCreateSeriesMetadataRequest,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn get(
        &self,
        auth_: BearerToken,
        rid: SeriesMetadataRid,
    ) -> impl Future<Output = Result<SeriesMetadata, Error>> + Send;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        rid: SeriesMetadataRid,
        request: UpdateSeriesMetadataRequest,
    ) -> impl Future<Output = Result<SeriesMetadata, Error>> + Send;
    fn batch_create_video_series(
        &self,
        auth_: BearerToken,
        request: BatchCreateVideoSeriesRequest,
    ) -> impl Future<Output = Result<BatchCreateVideoSeriesResponse, Error>> + Send;
}
Expand description

[INTERNAL] Series metadata represents the constant information about data in a series - specifically, the name, units, a description, and the tags. Series metadata can be used to query points from specific series depending on the tag value selections.

Required Methods§

Source

fn batch_get( &self, auth_: BearerToken, request: BatchGetSeriesMetadataRequest, ) -> impl Future<Output = Result<BatchGetSeriesMetadataResponse, Error>> + Send

Batch get series metadata by DataSourceRid.

Source

fn create( &self, auth_: BearerToken, request: CreateSeriesMetadataRequest, ) -> impl Future<Output = Result<(), Error>> + Send

Create new series metadata.

Source

fn batch_create( &self, auth_: BearerToken, request: BatchCreateSeriesMetadataRequest, ) -> impl Future<Output = Result<(), Error>> + Send

Idempotently creates series metadata.

Source

fn create_or_update( &self, auth_: BearerToken, request: CreateSeriesMetadataRequest, ) -> impl Future<Output = Result<(), Error>> + Send

Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data source. If it already exists, updates the locator and any provided unit and description fields while preserving existing values for fields not supplied.

Source

fn batch_create_or_update( &self, auth_: BearerToken, request: BatchCreateSeriesMetadataRequest, ) -> impl Future<Output = Result<(), Error>> + Send

Batch version of createOrUpdate.

Source

fn get( &self, auth_: BearerToken, rid: SeriesMetadataRid, ) -> impl Future<Output = Result<SeriesMetadata, Error>> + Send

Get series metadata from its series metadata rid.

Source

fn update_metadata( &self, auth_: BearerToken, rid: SeriesMetadataRid, request: UpdateSeriesMetadataRequest, ) -> impl Future<Output = Result<SeriesMetadata, Error>> + Send

Update existing series metadata. Throws SeriesMetadataNotFound if the series metadata does not exist.

Source

fn batch_create_video_series( &self, auth_: BearerToken, request: BatchCreateVideoSeriesRequest, ) -> impl Future<Output = Result<BatchCreateVideoSeriesResponse, Error>> + Send

Batch creates series metadata for video channels if they don’t exist. Idempotent - returns existing SeriesMetadataRid if already exists.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§