Skip to main content

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