nominal_api/conjure/clients/scout/jobs/api/
job_service.rs

1use conjure_http::endpoint;
2/// The Job Service is responsible for returning information about jobs for checklist executions.
3#[conjure_http::conjure_client(name = "JobService")]
4pub trait JobService<
5    #[response_body]
6    I: Iterator<
7            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
8        >,
9> {
10    /// Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
11    #[endpoint(
12        method = GET,
13        path = "/jobs/v1/{jobRid}/job-report",
14        name = "getJobReport",
15        accept = conjure_http::client::StdResponseDeserializer
16    )]
17    fn get_job_report(
18        &self,
19        #[auth]
20        auth_: &conjure_object::BearerToken,
21        #[path(name = "jobRid", encoder = conjure_http::client::conjure::PlainEncoder)]
22        job_rid: &super::super::super::super::super::objects::scout::checks::api::JobRid,
23    ) -> Result<
24        super::super::super::super::super::objects::scout::checks::api::JobReport,
25        conjure_http::private::Error,
26    >;
27    /// Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from
28    /// the response.
29    #[endpoint(
30        method = POST,
31        path = "/jobs/v1/batch-get-job-reports",
32        name = "batchGetJobReports",
33        accept = conjure_http::client::StdResponseDeserializer
34    )]
35    fn batch_get_job_reports(
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::checks::api::BatchGetJobReportsRequest,
41    ) -> Result<
42        super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsResponse,
43        conjure_http::private::Error,
44    >;
45}
46/// The Job Service is responsible for returning information about jobs for checklist executions.
47#[conjure_http::conjure_client(name = "JobService")]
48pub trait AsyncJobService<
49    #[response_body]
50    I: conjure_http::private::Stream<
51            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
52        >,
53> {
54    /// Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
55    #[endpoint(
56        method = GET,
57        path = "/jobs/v1/{jobRid}/job-report",
58        name = "getJobReport",
59        accept = conjure_http::client::StdResponseDeserializer
60    )]
61    async fn get_job_report(
62        &self,
63        #[auth]
64        auth_: &conjure_object::BearerToken,
65        #[path(name = "jobRid", encoder = conjure_http::client::conjure::PlainEncoder)]
66        job_rid: &super::super::super::super::super::objects::scout::checks::api::JobRid,
67    ) -> Result<
68        super::super::super::super::super::objects::scout::checks::api::JobReport,
69        conjure_http::private::Error,
70    >;
71    /// Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from
72    /// the response.
73    #[endpoint(
74        method = POST,
75        path = "/jobs/v1/batch-get-job-reports",
76        name = "batchGetJobReports",
77        accept = conjure_http::client::StdResponseDeserializer
78    )]
79    async fn batch_get_job_reports(
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::checks::api::BatchGetJobReportsRequest,
85    ) -> Result<
86        super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsResponse,
87        conjure_http::private::Error,
88    >;
89}
90/// The Job Service is responsible for returning information about jobs for checklist executions.
91#[conjure_http::conjure_client(name = "JobService", local)]
92pub trait LocalAsyncJobService<
93    #[response_body]
94    I: conjure_http::private::Stream<
95            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
96        >,
97> {
98    /// Fetches the job report for a job RID. Throws ResourcesNotFound if no job exists with this job RID.
99    #[endpoint(
100        method = GET,
101        path = "/jobs/v1/{jobRid}/job-report",
102        name = "getJobReport",
103        accept = conjure_http::client::StdResponseDeserializer
104    )]
105    async fn get_job_report(
106        &self,
107        #[auth]
108        auth_: &conjure_object::BearerToken,
109        #[path(name = "jobRid", encoder = conjure_http::client::conjure::PlainEncoder)]
110        job_rid: &super::super::super::super::super::objects::scout::checks::api::JobRid,
111    ) -> Result<
112        super::super::super::super::super::objects::scout::checks::api::JobReport,
113        conjure_http::private::Error,
114    >;
115    /// Fetches the job reports for a set of job RIDs. Omits any job reports the user is not permitted to see from
116    /// the response.
117    #[endpoint(
118        method = POST,
119        path = "/jobs/v1/batch-get-job-reports",
120        name = "batchGetJobReports",
121        accept = conjure_http::client::StdResponseDeserializer
122    )]
123    async fn batch_get_job_reports(
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::checks::api::BatchGetJobReportsRequest,
129    ) -> Result<
130        super::super::super::super::super::objects::scout::checks::api::BatchGetJobReportsResponse,
131        conjure_http::private::Error,
132    >;
133}
nominal_api/conjure/clients/scout/jobs/api/job_service.rs

nominal_api/conjure/clients/scout/jobs/api/
job_service.rs
