SeriesMetadataService

Trait SeriesMetadataService 

Source
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 get(
        &self,
        auth_: BearerToken,
        rid: SeriesMetadataRid,
    ) -> Result<SeriesMetadata, Error>;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        rid: SeriesMetadataRid,
        request: UpdateSeriesMetadataRequest,
    ) -> Result<SeriesMetadata, Error>;
}
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, ) -> Result<BatchGetSeriesMetadataResponse, Error>

Batch get series metadata by DataSourceRid.

Source

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

Create new series metadata.

Source

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

Idempotently creates series metadata.

Source

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

Get series metadata from its series metadata rid.

Source

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.

Implementors§