nominal_api/conjure/endpoints/scout/dataframe/api/
data_frame_metadata_service.rs

1use conjure_http::endpoint;
2/// Data frame metadata lookup. This includes metadata about the data sources
3/// reachable from the data frame.
4#[conjure_http::conjure_endpoints(
5    name = "DataFrameMetadataService",
6    use_legacy_error_serialization
7)]
8pub trait DataFrameMetadataService {
9    /// Resolves metadata for the data frame.
10    #[endpoint(
11        method = POST,
12        path = "/dataframe/metadata/v1/metadata",
13        name = "getDataFrameMetadata",
14        produces = conjure_http::server::StdResponseSerializer
15    )]
16    fn get_data_frame_metadata(
17        &self,
18        #[auth]
19        auth_: conjure_object::BearerToken,
20        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
21        request: super::super::super::super::super::objects::scout::dataframe::api::GetDataFrameMetadataRequest,
22    ) -> Result<
23        super::super::super::super::super::objects::scout::dataframe::api::DataFrameMetadata,
24        conjure_http::private::Error,
25    >;
26    /// Batched form of `getDataFrameMetadata`.
27    #[endpoint(
28        method = POST,
29        path = "/dataframe/metadata/v1/metadata/batch",
30        name = "batchGetDataFrameMetadata",
31        produces = conjure_http::server::StdResponseSerializer
32    )]
33    fn batch_get_data_frame_metadata(
34        &self,
35        #[auth]
36        auth_: conjure_object::BearerToken,
37        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
38        request: super::super::super::super::super::objects::scout::dataframe::api::BatchGetDataFrameMetadataRequest,
39    ) -> Result<
40        super::super::super::super::super::objects::scout::dataframe::api::BatchDataFrameMetadata,
41        conjure_http::private::Error,
42    >;
43}
44/// Data frame metadata lookup. This includes metadata about the data sources
45/// reachable from the data frame.
46#[conjure_http::conjure_endpoints(
47    name = "DataFrameMetadataService",
48    use_legacy_error_serialization
49)]
50pub trait AsyncDataFrameMetadataService {
51    /// Resolves metadata for the data frame.
52    #[endpoint(
53        method = POST,
54        path = "/dataframe/metadata/v1/metadata",
55        name = "getDataFrameMetadata",
56        produces = conjure_http::server::StdResponseSerializer
57    )]
58    async fn get_data_frame_metadata(
59        &self,
60        #[auth]
61        auth_: conjure_object::BearerToken,
62        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
63        request: super::super::super::super::super::objects::scout::dataframe::api::GetDataFrameMetadataRequest,
64    ) -> Result<
65        super::super::super::super::super::objects::scout::dataframe::api::DataFrameMetadata,
66        conjure_http::private::Error,
67    >;
68    /// Batched form of `getDataFrameMetadata`.
69    #[endpoint(
70        method = POST,
71        path = "/dataframe/metadata/v1/metadata/batch",
72        name = "batchGetDataFrameMetadata",
73        produces = conjure_http::server::StdResponseSerializer
74    )]
75    async fn batch_get_data_frame_metadata(
76        &self,
77        #[auth]
78        auth_: conjure_object::BearerToken,
79        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
80        request: super::super::super::super::super::objects::scout::dataframe::api::BatchGetDataFrameMetadataRequest,
81    ) -> Result<
82        super::super::super::super::super::objects::scout::dataframe::api::BatchDataFrameMetadata,
83        conjure_http::private::Error,
84    >;
85}
86/// Data frame metadata lookup. This includes metadata about the data sources
87/// reachable from the data frame.
88#[conjure_http::conjure_endpoints(
89    name = "DataFrameMetadataService",
90    use_legacy_error_serialization,
91    local
92)]
93pub trait LocalAsyncDataFrameMetadataService {
94    /// Resolves metadata for the data frame.
95    #[endpoint(
96        method = POST,
97        path = "/dataframe/metadata/v1/metadata",
98        name = "getDataFrameMetadata",
99        produces = conjure_http::server::StdResponseSerializer
100    )]
101    async fn get_data_frame_metadata(
102        &self,
103        #[auth]
104        auth_: conjure_object::BearerToken,
105        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
106        request: super::super::super::super::super::objects::scout::dataframe::api::GetDataFrameMetadataRequest,
107    ) -> Result<
108        super::super::super::super::super::objects::scout::dataframe::api::DataFrameMetadata,
109        conjure_http::private::Error,
110    >;
111    /// Batched form of `getDataFrameMetadata`.
112    #[endpoint(
113        method = POST,
114        path = "/dataframe/metadata/v1/metadata/batch",
115        name = "batchGetDataFrameMetadata",
116        produces = conjure_http::server::StdResponseSerializer
117    )]
118    async fn batch_get_data_frame_metadata(
119        &self,
120        #[auth]
121        auth_: conjure_object::BearerToken,
122        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
123        request: super::super::super::super::super::objects::scout::dataframe::api::BatchGetDataFrameMetadataRequest,
124    ) -> Result<
125        super::super::super::super::super::objects::scout::dataframe::api::BatchDataFrameMetadata,
126        conjure_http::private::Error,
127    >;
128}
nominal_api/conjure/endpoints/scout/dataframe/api/data_frame_metadata_service.rs

nominal_api/conjure/endpoints/scout/dataframe/api/
data_frame_metadata_service.rs
