Trait SeriesMetadataService 

pub trait SeriesMetadataService {
    // Required methods
    fn batch_get(
        &self,
        auth_: BearerToken,
        request: BatchGetSeriesMetadataRequest,
    ) -> Result<BatchGetSeriesMetadataResponse, Error>;
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateSeriesMetadataRequest,
    ) -> Result<(), Error>;
    fn batch_create(
        &self,
        auth_: BearerToken,
        request: BatchCreateSeriesMetadataRequest,
    ) -> Result<(), Error>;
    fn create_or_update(
        &self,
        auth_: BearerToken,
        request: CreateSeriesMetadataRequest,
    ) -> Result<(), Error>;
    fn batch_create_or_update(
        &self,
        auth_: BearerToken,
        request: BatchCreateSeriesMetadataRequest,
    ) -> Result<(), Error>;
    fn get(
        &self,
        auth_: BearerToken,
        rid: SeriesMetadataRid,
    ) -> Result<SeriesMetadata, Error>;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        rid: SeriesMetadataRid,
        request: UpdateSeriesMetadataRequest,
    ) -> Result<SeriesMetadata, Error>;
    fn batch_create_video_series(
        &self,
        auth_: BearerToken,
        request: BatchCreateVideoSeriesRequest,
    ) -> Result<BatchCreateVideoSeriesResponse, Error>;
}

[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

fn batch_get( &self, auth_: BearerToken, request: BatchGetSeriesMetadataRequest, ) -> Result<BatchGetSeriesMetadataResponse, Error>

Batch get series metadata by DataSourceRid.

fn create( &self, auth_: BearerToken, request: CreateSeriesMetadataRequest, ) -> Result<(), Error>

Create new series metadata.

fn batch_create( &self, auth_: BearerToken, request: BatchCreateSeriesMetadataRequest, ) -> Result<(), Error>

Idempotently creates series metadata.

fn create_or_update( &self, auth_: BearerToken, request: CreateSeriesMetadataRequest, ) -> Result<(), Error>

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.

fn batch_create_or_update( &self, auth_: BearerToken, request: BatchCreateSeriesMetadataRequest, ) -> Result<(), Error>

Batch version of createOrUpdate.

fn get( &self, auth_: BearerToken, rid: SeriesMetadataRid, ) -> Result<SeriesMetadata, Error>

Get series metadata from its series metadata rid.

fn update_metadata( &self, auth_: BearerToken, rid: SeriesMetadataRid, request: UpdateSeriesMetadataRequest, ) -> Result<SeriesMetadata, Error>

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

fn batch_create_video_series( &self, auth_: BearerToken, request: BatchCreateVideoSeriesRequest, ) -> Result<BatchCreateVideoSeriesResponse, Error>

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

Implementors