Skip to main content

nominal_api/conjure/clients/ingest/api/
ingest_job_service.rs

1use conjure_http::endpoint;
2/// Public API for querying ingest jobs.
3#[conjure_http::conjure_client(name = "IngestJobService")]
4pub trait IngestJobService<
5    #[response_body]
6    I: Iterator<
7            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
8        >,
9> {
10    /// Returns a single ingest job by RID. Does not include the full ingest request details.
11    #[endpoint(
12        method = GET,
13        path = "/ingest/v1/ingest-job/{ingestJobRid}",
14        name = "getIngestJob",
15        accept = conjure_http::client::StdResponseDeserializer
16    )]
17    fn get_ingest_job(
18        &self,
19        #[auth]
20        auth_: &conjure_object::BearerToken,
21        #[path(
22            name = "ingestJobRid",
23            encoder = conjure_http::client::conjure::PlainEncoder
24        )]
25        ingest_job_rid: &super::super::super::super::objects::ingest::api::IngestJobRid,
26    ) -> Result<
27        super::super::super::super::objects::ingest::api::IngestJob,
28        conjure_http::private::Error,
29    >;
30    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
31    #[endpoint(
32        method = POST,
33        path = "/ingest/v1/ingest-jobs/search",
34        name = "searchIngestJobs",
35        accept = conjure_http::client::StdResponseDeserializer
36    )]
37    fn search_ingest_jobs(
38        &self,
39        #[auth]
40        auth_: &conjure_object::BearerToken,
41        #[body(serializer = conjure_http::client::StdRequestSerializer)]
42        request: &super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
43    ) -> Result<
44        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
45        conjure_http::private::Error,
46    >;
47}
48/// Public API for querying ingest jobs.
49#[conjure_http::conjure_client(name = "IngestJobService")]
50pub trait AsyncIngestJobService<
51    #[response_body]
52    I: conjure_http::private::Stream<
53            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
54        >,
55> {
56    /// Returns a single ingest job by RID. Does not include the full ingest request details.
57    #[endpoint(
58        method = GET,
59        path = "/ingest/v1/ingest-job/{ingestJobRid}",
60        name = "getIngestJob",
61        accept = conjure_http::client::StdResponseDeserializer
62    )]
63    async fn get_ingest_job(
64        &self,
65        #[auth]
66        auth_: &conjure_object::BearerToken,
67        #[path(
68            name = "ingestJobRid",
69            encoder = conjure_http::client::conjure::PlainEncoder
70        )]
71        ingest_job_rid: &super::super::super::super::objects::ingest::api::IngestJobRid,
72    ) -> Result<
73        super::super::super::super::objects::ingest::api::IngestJob,
74        conjure_http::private::Error,
75    >;
76    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
77    #[endpoint(
78        method = POST,
79        path = "/ingest/v1/ingest-jobs/search",
80        name = "searchIngestJobs",
81        accept = conjure_http::client::StdResponseDeserializer
82    )]
83    async fn search_ingest_jobs(
84        &self,
85        #[auth]
86        auth_: &conjure_object::BearerToken,
87        #[body(serializer = conjure_http::client::StdRequestSerializer)]
88        request: &super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
89    ) -> Result<
90        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
91        conjure_http::private::Error,
92    >;
93}
94/// Public API for querying ingest jobs.
95#[conjure_http::conjure_client(name = "IngestJobService", local)]
96pub trait LocalAsyncIngestJobService<
97    #[response_body]
98    I: conjure_http::private::Stream<
99            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
100        >,
101> {
102    /// Returns a single ingest job by RID. Does not include the full ingest request details.
103    #[endpoint(
104        method = GET,
105        path = "/ingest/v1/ingest-job/{ingestJobRid}",
106        name = "getIngestJob",
107        accept = conjure_http::client::StdResponseDeserializer
108    )]
109    async fn get_ingest_job(
110        &self,
111        #[auth]
112        auth_: &conjure_object::BearerToken,
113        #[path(
114            name = "ingestJobRid",
115            encoder = conjure_http::client::conjure::PlainEncoder
116        )]
117        ingest_job_rid: &super::super::super::super::objects::ingest::api::IngestJobRid,
118    ) -> Result<
119        super::super::super::super::objects::ingest::api::IngestJob,
120        conjure_http::private::Error,
121    >;
122    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
123    #[endpoint(
124        method = POST,
125        path = "/ingest/v1/ingest-jobs/search",
126        name = "searchIngestJobs",
127        accept = conjure_http::client::StdResponseDeserializer
128    )]
129    async fn search_ingest_jobs(
130        &self,
131        #[auth]
132        auth_: &conjure_object::BearerToken,
133        #[body(serializer = conjure_http::client::StdRequestSerializer)]
134        request: &super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
135    ) -> Result<
136        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
137        conjure_http::private::Error,
138    >;
139}