SeriesArchetypeService

Trait SeriesArchetypeService 

Source
pub trait SeriesArchetypeService {
    // Required methods
    fn batch_get(
        &self,
        auth_: BearerToken,
        request: BatchGetSeriesArchetypeRequest,
    ) -> Result<BatchGetSeriesArchetypeResponse, Error>;
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateSeriesArchetypeRequest,
    ) -> Result<(), Error>;
    fn batch_create(
        &self,
        auth_: BearerToken,
        request: BatchCreateSeriesArchetypeRequest,
    ) -> Result<(), Error>;
    fn get(
        &self,
        auth_: BearerToken,
        rid: SeriesArchetypeRid,
    ) -> Result<SeriesArchetype, Error>;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        rid: SeriesArchetypeRid,
        request: UpdateSeriesArchetypeMetadataRequest,
    ) -> Result<SeriesArchetype, Error>;
}
Expand description

[INTERNAL] A series archetype represents the constant information about data in a series - specifically, the name, units, a description, and the tags. Series archetypes 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: BatchGetSeriesArchetypeRequest, ) -> Result<BatchGetSeriesArchetypeResponse, Error>

Batch get series archetypes by DataSourceRid.

Source

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

Create a new series archetype.

Source

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

Idempotently creates series archetypes.

Source

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

Get a series archetype from its series archetype rid.

Source

fn update_metadata( &self, auth_: BearerToken, rid: SeriesArchetypeRid, request: UpdateSeriesArchetypeMetadataRequest, ) -> Result<SeriesArchetype, Error>

Update the metadata on an existing series archetype. Throws SeriesArchetypeNotFound if the series archetype does not exist.

Implementors§