nominal-api 0.1239.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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use conjure_http::endpoint;
/// Data frame metadata lookup. This includes metadata about the data sources
/// reachable from the data frame.
#[conjure_http::conjure_endpoints(
    name = "DataFrameMetadataService",
    use_legacy_error_serialization
)]
pub trait DataFrameMetadataService {
    /// Resolves metadata for the data frame.
    #[endpoint(
        method = POST,
        path = "/dataframe/metadata/v1/metadata",
        name = "getDataFrameMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_data_frame_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::super::objects::scout::dataframe::api::GetDataFrameMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::dataframe::api::DataFrameMetadata,
        conjure_http::private::Error,
    >;
    /// Batched form of `getDataFrameMetadata`.
    #[endpoint(
        method = POST,
        path = "/dataframe/metadata/v1/metadata/batch",
        name = "batchGetDataFrameMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn batch_get_data_frame_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::super::objects::scout::dataframe::api::BatchGetDataFrameMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::dataframe::api::BatchDataFrameMetadata,
        conjure_http::private::Error,
    >;
}
/// Data frame metadata lookup. This includes metadata about the data sources
/// reachable from the data frame.
#[conjure_http::conjure_endpoints(
    name = "DataFrameMetadataService",
    use_legacy_error_serialization
)]
pub trait AsyncDataFrameMetadataService {
    /// Resolves metadata for the data frame.
    #[endpoint(
        method = POST,
        path = "/dataframe/metadata/v1/metadata",
        name = "getDataFrameMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_data_frame_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::super::objects::scout::dataframe::api::GetDataFrameMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::dataframe::api::DataFrameMetadata,
        conjure_http::private::Error,
    >;
    /// Batched form of `getDataFrameMetadata`.
    #[endpoint(
        method = POST,
        path = "/dataframe/metadata/v1/metadata/batch",
        name = "batchGetDataFrameMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_get_data_frame_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::super::objects::scout::dataframe::api::BatchGetDataFrameMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::dataframe::api::BatchDataFrameMetadata,
        conjure_http::private::Error,
    >;
}
/// Data frame metadata lookup. This includes metadata about the data sources
/// reachable from the data frame.
#[conjure_http::conjure_endpoints(
    name = "DataFrameMetadataService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncDataFrameMetadataService {
    /// Resolves metadata for the data frame.
    #[endpoint(
        method = POST,
        path = "/dataframe/metadata/v1/metadata",
        name = "getDataFrameMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_data_frame_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::super::objects::scout::dataframe::api::GetDataFrameMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::dataframe::api::DataFrameMetadata,
        conjure_http::private::Error,
    >;
    /// Batched form of `getDataFrameMetadata`.
    #[endpoint(
        method = POST,
        path = "/dataframe/metadata/v1/metadata/batch",
        name = "batchGetDataFrameMetadata",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_get_data_frame_metadata(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::super::objects::scout::dataframe::api::BatchGetDataFrameMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::dataframe::api::BatchDataFrameMetadata,
        conjure_http::private::Error,
    >;
}