nominal-api 0.1240.0

API bindings for the Nominal platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use conjure_http::endpoint;
/// Nominal periodically scrapes connected databases (Connections) in order to maintain a database of all
/// series that can be read from that database. This service is responsible for executing the scrape, and can
/// be used manually to trigger a rescrape for any reason (for example, when updating a schema).
#[conjure_http::conjure_client(name = "ConnectionBootstrapperService")]
pub trait ConnectionBootstrapperService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Populates the connection with series, by querying within the requested time range. If start or end are both omitted,
    /// will query the last 7 days by default. If one of start or end is omitted, will query a 7 day range from the provided
    /// start or end. Will throw if the requested range is larger than 30 days.
    #[endpoint(
        method = POST,
        path = "/data-source/connection/v1/{rid}/populateSeries",
        name = "populateSeries",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn populate_series(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datasource::connection::api::PopulateSeriesRequest,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Nominal periodically scrapes connected databases (Connections) in order to maintain a database of all
/// series that can be read from that database. This service is responsible for executing the scrape, and can
/// be used manually to trigger a rescrape for any reason (for example, when updating a schema).
#[conjure_http::conjure_client(name = "ConnectionBootstrapperService")]
pub trait AsyncConnectionBootstrapperService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Populates the connection with series, by querying within the requested time range. If start or end are both omitted,
    /// will query the last 7 days by default. If one of start or end is omitted, will query a 7 day range from the provided
    /// start or end. Will throw if the requested range is larger than 30 days.
    #[endpoint(
        method = POST,
        path = "/data-source/connection/v1/{rid}/populateSeries",
        name = "populateSeries",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn populate_series(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datasource::connection::api::PopulateSeriesRequest,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Nominal periodically scrapes connected databases (Connections) in order to maintain a database of all
/// series that can be read from that database. This service is responsible for executing the scrape, and can
/// be used manually to trigger a rescrape for any reason (for example, when updating a schema).
#[conjure_http::conjure_client(name = "ConnectionBootstrapperService", local)]
pub trait LocalAsyncConnectionBootstrapperService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Populates the connection with series, by querying within the requested time range. If start or end are both omitted,
    /// will query the last 7 days by default. If one of start or end is omitted, will query a 7 day range from the provided
    /// start or end. Will throw if the requested range is larger than 30 days.
    #[endpoint(
        method = POST,
        path = "/data-source/connection/v1/{rid}/populateSeries",
        name = "populateSeries",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn populate_series(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::datasource::connection::api::ConnectionRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datasource::connection::api::PopulateSeriesRequest,
    ) -> Result<(), conjure_http::private::Error>;
}