-
Notifications
You must be signed in to change notification settings - Fork 14
/
WorkItemsApi.gen.cs
349 lines (304 loc) · 18.2 KB
/
WorkItemsApi.gen.cs
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
/*
* Forge SDK
*
* The Forge Platform contains an expanding collection of web service components that can be used with Autodesk cloud-based products or your own technologies. Take advantage of Autodesk’s expertise in design and engineering.
*
* Design Automation
*
* Generated by [Forge Swagger Codegen](https://git.autodesk.com/forge-ozone/forge-rsdk-codegen)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using Autodesk.Forge.Core;
using Autodesk.Forge.DesignAutomation.Model;
using Microsoft.Extensions.Options;
namespace Autodesk.Forge.DesignAutomation.Http
{
/// <summary>
/// Represents a collection of functions to interact with the API endpoints
/// </summary>
public interface IWorkItemsApi
{
/// <summary>
/// Creates a new WorkItem and queues it for processing.
/// </summary>
/// <remarks>
/// The new WorkItem is always placed on a queue and later picked up by an engine. The following limits apply: Per-engine. These limits are enforced when the engine processes the workitem. 1. Number of downloads (LimitDownloads) 2. Number of uploads (LimitUploads) 3. Total download size (LimitDownloadSize) 4. Total upload size (LimitUploadSize) 5. Processing time (LimitProcessingTime) 6. Total size of uncompressed bits for all referenced appbundles (LimitTotalUncompressedAppsSizePerActivity). Service wide. These limits are enforced during workitem submission. 7. Total processing time per month (LimitMonthlyProcessingTimeInHours).
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="workItem"></param>
/// <returns>Task of ApiResponse<WorkItemStatus></returns>
System.Threading.Tasks.Task<ApiResponse<WorkItemStatus>> CreateWorkItemAsync (WorkItem workItem, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true);
/// <summary>
/// Creates new WorkItems and queues them for processing.
/// </summary>
/// <remarks>
/// The new WorkItems are always placed on the queue and later picked up by an engine. The following limits apply: Per-engine. These limits are enforced when the engine processes the workitem. 1. Number of downloads (LimitDownloads) 2. Number of uploads (LimitUploads) 3. Total download size (LimitDownloadSize) 4. Total upload size (LimitUploadSize) 5. Processing time (LimitProcessingTime) 6. Total size of uncompressed bits for all referenced appbundles (LimitTotalUncompressedAppsSizePerActivity). Service wide. These limits are enforced during workitem submission. 7. Total processing time per month (LimitMonthlyProcessingTimeInHours).
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="workItems"></param>
/// <returns>Task of ApiResponse<List<WorkItemStatus>></returns>
System.Threading.Tasks.Task<ApiResponse<List<WorkItemStatus>>> CreateWorkItemsBatchAsync (List<WorkItem> workItems, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true);
/// <summary>
/// Cancels a specific WorkItem.
/// </summary>
/// <remarks>
/// Cancels a specific WorkItem. If the WorkItem is on the queue, it is removed from the queue and not processed. If the WorkItem is already being processed, then it may or may not be interrupted and cancelled. If the WorkItem has already finished processing, then it has no effect on the processing or results.
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="id"></param>
/// <returns>Task of HttpResponseMessage</returns>
System.Threading.Tasks.Task<HttpResponseMessage> DeleteWorkItemAsync (string id, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true);
/// <summary>
/// Gets the status of a specific WorkItem.
/// </summary>
/// <remarks>
/// Gets the status of a specific WorkItem. Typically used to 'poll' for the completion of a WorkItem, but see the use of the 'onComplete' argument for an alternative that does not require 'polling'. WorkItem status is retained for a limited period of time after the WorkItem completes. Limits: 1. Retention period (LimitWorkItemRetentionPeriod).
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="id"></param>
/// <returns>Task of ApiResponse<WorkItemStatus></returns>
System.Threading.Tasks.Task<ApiResponse<WorkItemStatus>> GetWorkitemStatusAsync (string id, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true);
}
/// <summary>
/// Represents a collection of functions to interact with the API endpoints
/// </summary>
public partial class WorkItemsApi : IWorkItemsApi
{
/// <summary>
/// Initializes a new instance of the <see cref="WorkItemsApi"/> class
/// using ForgeService object
/// </summary>
/// <param name="service">An instance of ForgeService</param>
/// <returns></returns>
public WorkItemsApi(ForgeService service = null, IOptions<Configuration> configuration = null)
{
this.Service = service ?? ForgeService.CreateDefault();
// set BaseAddress from configuration or default
this.Service.Client.BaseAddress = configuration?.Value.BaseAddress ?? new Configuration().BaseAddress;
}
/// <summary>
/// Gets or sets the configuration object
/// </summary>
/// <value>An instance of the ForgeService</value>
public ForgeService Service {get; set;}
/// <summary>
/// Creates a new WorkItem and queues it for processing.
/// </summary>
/// <remarks>
/// The new WorkItem is always placed on a queue and later picked up by an engine. The following limits apply: Per-engine. These limits are enforced when the engine processes the workitem. 1. Number of downloads (LimitDownloads) 2. Number of uploads (LimitUploads) 3. Total download size (LimitDownloadSize) 4. Total upload size (LimitUploadSize) 5. Processing time (LimitProcessingTime) 6. Total size of uncompressed bits for all referenced appbundles (LimitTotalUncompressedAppsSizePerActivity). Service wide. These limits are enforced during workitem submission. 7. Total processing time per month (LimitMonthlyProcessingTimeInHours).
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="workItem"></param>
/// <returns>Task of ApiResponse<WorkItemStatus></returns>
public async System.Threading.Tasks.Task<ApiResponse<WorkItemStatus>> CreateWorkItemAsync (WorkItem workItem, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true)
{
using (var request = new HttpRequestMessage())
{
request.RequestUri =
Marshalling.BuildRequestUri("/v3/workitems",
routeParameters: new Dictionary<string, object> {
},
queryParameters: new Dictionary<string, object> {
}
);
request.Headers.TryAddWithoutValidation("Accept", "application/json");
if (headers!=null)
{
foreach (var header in headers)
{
request.Headers.TryAddWithoutValidation(header.Key, header.Value);
}
}
request.Content = Marshalling.Serialize(workItem); // http body (model) parameter
// tell the underlying pipeline what scope we'd like to use
if (scopes == null)
{
request.Options.Set(ForgeConfiguration.ScopeKey, "code:all");
}
else
{
request.Options.Set(ForgeConfiguration.ScopeKey, scopes);
}
request.Method = new HttpMethod("POST");
// make the HTTP request
var response = await this.Service.Client.SendAsync(request);
if (throwOnError)
{
await response.EnsureSuccessStatusCodeAsync();
}
else if (!response.IsSuccessStatusCode)
{
return new ApiResponse<WorkItemStatus>(response, default(WorkItemStatus));
}
return new ApiResponse<WorkItemStatus>(response, await Marshalling.DeserializeAsync<WorkItemStatus>(response.Content));
} // using
}
/// <summary>
/// Creates new WorkItems and queues them for processing.
/// </summary>
/// <remarks>
/// The new WorkItems are always placed on the queue and later picked up by an engine. The following limits apply: Per-engine. These limits are enforced when the engine processes the workitem. 1. Number of downloads (LimitDownloads) 2. Number of uploads (LimitUploads) 3. Total download size (LimitDownloadSize) 4. Total upload size (LimitUploadSize) 5. Processing time (LimitProcessingTime) 6. Total size of uncompressed bits for all referenced appbundles (LimitTotalUncompressedAppsSizePerActivity). Service wide. These limits are enforced during workitem submission. 7. Total processing time per month (LimitMonthlyProcessingTimeInHours).
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="workItems"></param>
/// <returns>Task of ApiResponse<List<WorkItemStatus>></returns>
public async System.Threading.Tasks.Task<ApiResponse<List<WorkItemStatus>>> CreateWorkItemsBatchAsync (List<WorkItem> workItems, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true)
{
using (var request = new HttpRequestMessage())
{
request.RequestUri =
Marshalling.BuildRequestUri("/v3/workitems/batch",
routeParameters: new Dictionary<string, object> {
},
queryParameters: new Dictionary<string, object> {
}
);
request.Headers.TryAddWithoutValidation("Accept", "application/json");
if (headers!=null)
{
foreach (var header in headers)
{
request.Headers.TryAddWithoutValidation(header.Key, header.Value);
}
}
request.Content = Marshalling.Serialize(workItems); // http body (model) parameter
// tell the underlying pipeline what scope we'd like to use
if (scopes == null)
{
request.Options.Set(ForgeConfiguration.ScopeKey, "code:all");
}
else
{
request.Options.Set(ForgeConfiguration.ScopeKey, scopes);
}
request.Method = new HttpMethod("POST");
// make the HTTP request
var response = await this.Service.Client.SendAsync(request);
if (throwOnError)
{
await response.EnsureSuccessStatusCodeAsync();
}
else if (!response.IsSuccessStatusCode)
{
return new ApiResponse<List<WorkItemStatus>>(response, default(List<WorkItemStatus>));
}
return new ApiResponse<List<WorkItemStatus>>(response, await Marshalling.DeserializeAsync<List<WorkItemStatus>>(response.Content));
} // using
}
/// <summary>
/// Cancels a specific WorkItem.
/// </summary>
/// <remarks>
/// Cancels a specific WorkItem. If the WorkItem is on the queue, it is removed from the queue and not processed. If the WorkItem is already being processed, then it may or may not be interrupted and cancelled. If the WorkItem has already finished processing, then it has no effect on the processing or results.
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="id"></param>
/// <returns>Task of HttpResponseMessage</returns>
public async System.Threading.Tasks.Task<HttpResponseMessage> DeleteWorkItemAsync (string id, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true)
{
using (var request = new HttpRequestMessage())
{
request.RequestUri =
Marshalling.BuildRequestUri("/v3/workitems/{id}",
routeParameters: new Dictionary<string, object> {
{ "id", id},
},
queryParameters: new Dictionary<string, object> {
}
);
request.Headers.TryAddWithoutValidation("Accept", "application/json");
if (headers!=null)
{
foreach (var header in headers)
{
request.Headers.TryAddWithoutValidation(header.Key, header.Value);
}
}
// tell the underlying pipeline what scope we'd like to use
if (scopes == null)
{
request.Options.Set(ForgeConfiguration.ScopeKey, "code:all");
}
else
{
request.Options.Set(ForgeConfiguration.ScopeKey, scopes);
}
request.Method = new HttpMethod("DELETE");
// make the HTTP request
var response = await this.Service.Client.SendAsync(request);
if (throwOnError)
{
await response.EnsureSuccessStatusCodeAsync();
}
else if (!response.IsSuccessStatusCode)
{
return response;
}
return response;
} // using
}
/// <summary>
/// Gets the status of a specific WorkItem.
/// </summary>
/// <remarks>
/// Gets the status of a specific WorkItem. Typically used to 'poll' for the completion of a WorkItem, but see the use of the 'onComplete' argument for an alternative that does not require 'polling'. WorkItem status is retained for a limited period of time after the WorkItem completes. Limits: 1. Retention period (LimitWorkItemRetentionPeriod).
/// </remarks>
/// <exception cref="HttpRequestException">Thrown when fails to make API call</exception>
/// <param name="id"></param>
/// <returns>Task of ApiResponse<WorkItemStatus></returns>
public async System.Threading.Tasks.Task<ApiResponse<WorkItemStatus>> GetWorkitemStatusAsync (string id, string scopes = null, IDictionary<string, string> headers = null, bool throwOnError = true)
{
using (var request = new HttpRequestMessage())
{
request.RequestUri =
Marshalling.BuildRequestUri("/v3/workitems/{id}",
routeParameters: new Dictionary<string, object> {
{ "id", id},
},
queryParameters: new Dictionary<string, object> {
}
);
request.Headers.TryAddWithoutValidation("Accept", "application/json");
if (headers!=null)
{
foreach (var header in headers)
{
request.Headers.TryAddWithoutValidation(header.Key, header.Value);
}
}
// tell the underlying pipeline what scope we'd like to use
if (scopes == null)
{
request.Options.Set(ForgeConfiguration.ScopeKey, "code:all");
}
else
{
request.Options.Set(ForgeConfiguration.ScopeKey, scopes);
}
request.Method = new HttpMethod("GET");
// make the HTTP request
var response = await this.Service.Client.SendAsync(request);
if (throwOnError)
{
await response.EnsureSuccessStatusCodeAsync();
}
else if (!response.IsSuccessStatusCode)
{
return new ApiResponse<WorkItemStatus>(response, default(WorkItemStatus));
}
return new ApiResponse<WorkItemStatus>(response, await Marshalling.DeserializeAsync<WorkItemStatus>(response.Content));
} // using
}
}
}