C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
TaskStatus.cs
Go to the documentation of this file.
1using System.Runtime.Serialization;
3
4namespace AnalyzeRe
5{
7 [DataContract]
8 public enum TaskStatus
9 {
11 [EnumMember(Value = "unknown")]
12 Unknown = 0,
14 [EnumMember(Value = "ready")]
17 [EnumMember(Value = "awaiting_chunks")]
20 [EnumMember(Value = "queued")]
21 Queued,
23 [EnumMember(Value = "processing")]
26 [EnumMember(Value = "processing_succeeded")]
27 Success,
29 [EnumMember(Value = "processing_failed")]
30 Failed,
33 [EnumMember(Value = "bad_request")]
35 }
36
38 public static class TaskStatusExtensions
39 {
47 public static bool IsBusy(this TaskStatus taskStatus)
48 {
49 return taskStatus == TaskStatus.Queued ||
50 taskStatus == TaskStatus.Processing;
51 }
52
58 public static bool IsProcessingComplete(this TaskStatus taskStatus)
59 {
60 return taskStatus == TaskStatus.Success ||
61 taskStatus == TaskStatus.Failed || taskStatus == TaskStatus.BadRequest;
62 }
63
68 public static bool IsError(this TaskStatus taskStatus)
69 {
70 return taskStatus == TaskStatus.Failed || taskStatus == TaskStatus.BadRequest;
71 }
72
77 public static string ToAPIString(this TaskStatus taskStatus)
78 {
79 return typeof(TaskStatus).GetMember(taskStatus.ToString())[0]
80 .GetCustomAttributeFast<EnumMemberAttribute>().Value;
81 }
82 }
83}
Extension methods for TaskStatus enum values.
Definition TaskStatus.cs:39
static bool IsProcessingComplete(this TaskStatus taskStatus)
Indicates whether the current status has completed processing. (TaskStatus.Success,...
Definition TaskStatus.cs:58
static bool IsBusy(this TaskStatus taskStatus)
Indicates whether the current status is busy at the server side, (TaskStatus.Queued or TaskStatus....
Definition TaskStatus.cs:47
static string ToAPIString(this TaskStatus taskStatus)
Returns the API string for this task status, which is what this status looks like when it appears in ...
Definition TaskStatus.cs:77
static bool IsError(this TaskStatus taskStatus)
Indicates whether the current status is an error. (TaskStatus.Failed or TaskStatus....
Definition TaskStatus.cs:68
TaskStatus
The status of a data upload which may be in progress.
Definition TaskStatus.cs:9
@ Awaiting_Upload
No data upload has been initiated. Ready for upload.
@ Uploading
Data upload has been initiated, but not yet committed.
@ Success
Data has already been uploaded and successfully processed.
@ Processing
Data has already been uploaded and is being processed.
@ Queued
Data has already been uploaded and is queued for processing.
@ Unknown
Cannot determine the status of this data endpoint.
@ BadRequest
Indicates that an invalid request was sent, and so the resource cannot be processed.
@ Failed
Data has already been uploaded but failed processing.