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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
#![allow(unused_imports)]
#![cfg_attr(rustfmt, rustfmt_skip)]
/* THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT */
use crate::{Client, ClientBuilder, Credentials, Retry};
use anyhow::Error;
use serde_json::Value;
use std::time::Duration;
use crate::util::urlencode;
/// Index Service
///
/// The index service is responsible for indexing tasks. The service ensures that
/// tasks can be located by user-defined names.
///
/// As described in the service documentation, tasks are typically indexed via Pulse
/// messages, so the most common use of API methods is to read from the index.
///
/// Slashes (`/`) aren't allowed in index paths.
pub struct Index (Client);
#[allow(non_snake_case)]
impl Index {
/// Create a new undefined instance, based on the given client.
pub fn new<CB: Into<ClientBuilder>>(client_builder: CB) -> Result<Self, Error> {
Ok(Self(client_builder
.into()
.path_prefix("api/index/v1/")
.build()?))
}
/// Ping Server
///
/// Respond without doing anything.
/// This endpoint is used to check that the service is up.
pub async fn ping(&self) -> Result<(), Error> {
let method = "GET";
let (path, query) = Self::ping_details();
let body = None;
let resp = self.0.request(method, path, query, body).await?;
resp.bytes().await?;
Ok(())
}
/// Generate an unsigned URL for the ping endpoint
pub fn ping_url(&self) -> Result<String, Error> {
let (path, query) = Self::ping_details();
self.0.make_url(path, query)
}
/// Generate a signed URL for the ping endpoint
pub fn ping_signed_url(&self, ttl: Duration) -> Result<String, Error> {
let (path, query) = Self::ping_details();
self.0.make_signed_url(path, query, ttl)
}
/// Determine the HTTP request details for ping
fn ping_details<'a>() -> (&'static str, Option<Vec<(&'static str, &'a str)>>) {
let path = "ping";
let query = None;
(path, query)
}
/// Find Indexed Task
///
/// Find a task by index path, returning the highest-rank task with that path. If no
/// task exists for the given path, this API end-point will respond with a 404 status.
pub async fn findTask(&self, indexPath: &str) -> Result<Value, Error> {
let method = "GET";
let (path, query) = Self::findTask_details(indexPath);
let body = None;
let resp = self.0.request(method, &path, query, body).await?;
Ok(resp.json().await?)
}
/// Generate an unsigned URL for the findTask endpoint
pub fn findTask_url(&self, indexPath: &str) -> Result<String, Error> {
let (path, query) = Self::findTask_details(indexPath);
self.0.make_url(&path, query)
}
/// Generate a signed URL for the findTask endpoint
pub fn findTask_signed_url(&self, indexPath: &str, ttl: Duration) -> Result<String, Error> {
let (path, query) = Self::findTask_details(indexPath);
self.0.make_signed_url(&path, query, ttl)
}
/// Determine the HTTP request details for findTask
fn findTask_details<'a>(indexPath: &'a str) -> (String, Option<Vec<(&'static str, &'a str)>>) {
let path = format!("task/{}", urlencode(indexPath));
let query = None;
(path, query)
}
/// List Namespaces
///
/// List the namespaces immediately under a given namespace.
///
/// This endpoint
/// lists up to 1000 namespaces. If more namespaces are present, a
/// `continuationToken` will be returned, which can be given in the next
/// request. For the initial request, the payload should be an empty JSON
/// object.
pub async fn listNamespaces(&self, namespace: &str, continuationToken: Option<&str>, limit: Option<&str>) -> Result<Value, Error> {
let method = "GET";
let (path, query) = Self::listNamespaces_details(namespace, continuationToken, limit);
let body = None;
let resp = self.0.request(method, &path, query, body).await?;
Ok(resp.json().await?)
}
/// Generate an unsigned URL for the listNamespaces endpoint
pub fn listNamespaces_url(&self, namespace: &str, continuationToken: Option<&str>, limit: Option<&str>) -> Result<String, Error> {
let (path, query) = Self::listNamespaces_details(namespace, continuationToken, limit);
self.0.make_url(&path, query)
}
/// Generate a signed URL for the listNamespaces endpoint
pub fn listNamespaces_signed_url(&self, namespace: &str, continuationToken: Option<&str>, limit: Option<&str>, ttl: Duration) -> Result<String, Error> {
let (path, query) = Self::listNamespaces_details(namespace, continuationToken, limit);
self.0.make_signed_url(&path, query, ttl)
}
/// Determine the HTTP request details for listNamespaces
fn listNamespaces_details<'a>(namespace: &'a str, continuationToken: Option<&'a str>, limit: Option<&'a str>) -> (String, Option<Vec<(&'static str, &'a str)>>) {
let path = format!("namespaces/{}", urlencode(namespace));
let mut query = None;
if let Some(q) = continuationToken {
query.get_or_insert_with(Vec::new).push(("continuationToken", q));
}
if let Some(q) = limit {
query.get_or_insert_with(Vec::new).push(("limit", q));
}
(path, query)
}
/// List Tasks
///
/// List the tasks immediately under a given namespace.
///
/// This endpoint
/// lists up to 1000 tasks. If more tasks are present, a
/// `continuationToken` will be returned, which can be given in the next
/// request. For the initial request, the payload should be an empty JSON
/// object.
///
/// **Remark**, this end-point is designed for humans browsing for tasks, not
/// services, as that makes little sense.
pub async fn listTasks(&self, namespace: &str, continuationToken: Option<&str>, limit: Option<&str>) -> Result<Value, Error> {
let method = "GET";
let (path, query) = Self::listTasks_details(namespace, continuationToken, limit);
let body = None;
let resp = self.0.request(method, &path, query, body).await?;
Ok(resp.json().await?)
}
/// Generate an unsigned URL for the listTasks endpoint
pub fn listTasks_url(&self, namespace: &str, continuationToken: Option<&str>, limit: Option<&str>) -> Result<String, Error> {
let (path, query) = Self::listTasks_details(namespace, continuationToken, limit);
self.0.make_url(&path, query)
}
/// Generate a signed URL for the listTasks endpoint
pub fn listTasks_signed_url(&self, namespace: &str, continuationToken: Option<&str>, limit: Option<&str>, ttl: Duration) -> Result<String, Error> {
let (path, query) = Self::listTasks_details(namespace, continuationToken, limit);
self.0.make_signed_url(&path, query, ttl)
}
/// Determine the HTTP request details for listTasks
fn listTasks_details<'a>(namespace: &'a str, continuationToken: Option<&'a str>, limit: Option<&'a str>) -> (String, Option<Vec<(&'static str, &'a str)>>) {
let path = format!("tasks/{}", urlencode(namespace));
let mut query = None;
if let Some(q) = continuationToken {
query.get_or_insert_with(Vec::new).push(("continuationToken", q));
}
if let Some(q) = limit {
query.get_or_insert_with(Vec::new).push(("limit", q));
}
(path, query)
}
/// Insert Task into Index
///
/// Insert a task into the index. If the new rank is less than the existing rank
/// at the given index path, the task is not indexed but the response is still 200 OK.
///
/// Please see the introduction above for information
/// about indexing successfully completed tasks automatically using custom routes.
pub async fn insertTask(&self, namespace: &str, payload: &Value) -> Result<Value, Error> {
let method = "PUT";
let (path, query) = Self::insertTask_details(namespace);
let body = Some(payload);
let resp = self.0.request(method, &path, query, body).await?;
Ok(resp.json().await?)
}
/// Determine the HTTP request details for insertTask
fn insertTask_details<'a>(namespace: &'a str) -> (String, Option<Vec<(&'static str, &'a str)>>) {
let path = format!("task/{}", urlencode(namespace));
let query = None;
(path, query)
}
/// Remove Task from Index
///
/// Remove a task from the index. This is intended for administrative use,
/// where an index entry is no longer appropriate. The parent namespace is
/// not automatically deleted. Index entries with lower rank that were
/// previously inserted will not re-appear, as they were never stored.
pub async fn deleteTask(&self, namespace: &str) -> Result<(), Error> {
let method = "DELETE";
let (path, query) = Self::deleteTask_details(namespace);
let body = None;
let resp = self.0.request(method, &path, query, body).await?;
resp.bytes().await?;
Ok(())
}
/// Determine the HTTP request details for deleteTask
fn deleteTask_details<'a>(namespace: &'a str) -> (String, Option<Vec<(&'static str, &'a str)>>) {
let path = format!("task/{}", urlencode(namespace));
let query = None;
(path, query)
}
/// Get Artifact From Indexed Task
///
/// Find a task by index path and redirect to the artifact on the most recent
/// run with the given `name`.
///
/// Note that multiple calls to this endpoint may return artifacts from differen tasks
/// if a new task is inserted into the index between calls. Avoid using this method as
/// a stable link to multiple, connected files if the index path does not contain a
/// unique identifier. For example, the following two links may return unrelated files:
/// * https://tc.example.com/api/index/v1/task/some-app.win64.latest.installer/artifacts/public/installer.exe`
/// * https://tc.example.com/api/index/v1/task/some-app.win64.latest.installer/artifacts/public/debug-symbols.zip`
///
/// This problem be remedied by including the revision in the index path or by bundling both
/// installer and debug symbols into a single artifact.
///
/// If no task exists for the given index path, this API end-point responds with 404.
pub async fn findArtifactFromTask(&self, indexPath: &str, name: &str) -> Result<(), Error> {
let method = "GET";
let (path, query) = Self::findArtifactFromTask_details(indexPath, name);
let body = None;
let resp = self.0.request(method, &path, query, body).await?;
resp.bytes().await?;
Ok(())
}
/// Generate an unsigned URL for the findArtifactFromTask endpoint
pub fn findArtifactFromTask_url(&self, indexPath: &str, name: &str) -> Result<String, Error> {
let (path, query) = Self::findArtifactFromTask_details(indexPath, name);
self.0.make_url(&path, query)
}
/// Generate a signed URL for the findArtifactFromTask endpoint
pub fn findArtifactFromTask_signed_url(&self, indexPath: &str, name: &str, ttl: Duration) -> Result<String, Error> {
let (path, query) = Self::findArtifactFromTask_details(indexPath, name);
self.0.make_signed_url(&path, query, ttl)
}
/// Determine the HTTP request details for findArtifactFromTask
fn findArtifactFromTask_details<'a>(indexPath: &'a str, name: &'a str) -> (String, Option<Vec<(&'static str, &'a str)>>) {
let path = format!("task/{}/artifacts/{}", urlencode(indexPath), urlencode(name));
let query = None;
(path, query)
}
}