rusty_falcon 0.7.1

Rust bindings for CrowdStrike Falcon API
Documentation 
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

/*
 * CrowdStrike API Specification
 *
 * Use this API specification as a reference for the API endpoints you can use to interact with your Falcon environment. These endpoints support authentication via OAuth2 and interact with detections and network containment. For detailed usage guides and examples, see our [documentation inside the Falcon console](https://falcon.crowdstrike.com/support/documentation).     To use the APIs described below, combine the base URL with the path shown for each API endpoint. For commercial cloud customers, your base URL is `https://api.crowdstrike.com`.    Each API endpoint requires authorization via an OAuth2 token. Your first API request should retrieve an OAuth2 token using the `oauth2/token` endpoint, such as `https://api.crowdstrike.com/oauth2/token`. For subsequent requests, include the OAuth2 token in an HTTP authorization header. Tokens expire after 30 minutes, after which you should make a new token request to continue making API requests.
 *
 * The version of the OpenAPI document: rolling
 *
 * Generated by: https://openapi-generator.tech
 */

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct ExecutionsTriggerResult {
    /// Timestamp of when the execution completed. Only present when status is an end state.
    #[serde(rename = "end_timestamp", skip_serializing_if = "Option::is_none")]
    pub end_timestamp: Option<String>,
    /// When a node execution is in an error status this field is present and provides an error code that can be used to determine details why the failure occurred.
    #[serde(rename = "error_code", skip_serializing_if = "Option::is_none")]
    pub error_code: Option<i32>,
    /// When a node execution is in an error status this field is present and provides a user friendly error message.
    #[serde(rename = "error_message", skip_serializing_if = "Option::is_none")]
    pub error_message: Option<String>,
    /// Unique identifier for the selected trigger as provided by the triggers API
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Whether this node's result is mocked
    #[serde(rename = "mocked", skip_serializing_if = "Option::is_none")]
    pub mocked: Option<bool>,
    /// Display name of the trigger
    #[serde(rename = "name")]
    pub name: String,
    /// Unique id of the node as specified in the definition.
    #[serde(rename = "node_id")]
    pub node_id: String,
    /// Opaque blob for result of trigger. Structured according to the trigger's JSON schema'.
    #[serde(rename = "result", skip_serializing_if = "Option::is_none")]
    pub result: Option<serde_json::Value>,
    /// Timestamp of when the execution first started.
    #[serde(rename = "start_timestamp")]
    pub start_timestamp: String,
    /// Current status of execution for the activity.
    #[serde(rename = "status")]
    pub status: Status,
    /// Type of the trigger
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub r#type: Option<String>,
    /// Current status of execution for the activity rendered in the UI.
    #[serde(rename = "ui_status")]
    pub ui_status: UiStatus,
}

impl ExecutionsTriggerResult {
    pub fn new(
        name: String,
        node_id: String,
        start_timestamp: String,
        status: Status,
        ui_status: UiStatus,
    ) -> ExecutionsTriggerResult {
        ExecutionsTriggerResult {
            end_timestamp: None,
            error_code: None,
            error_message: None,
            id: None,
            mocked: None,
            name,
            node_id,
            result: None,
            start_timestamp,
            status,
            r#type: None,
            ui_status,
        }
    }
}
/// Current status of execution for the activity.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Status {
    #[serde(rename = "Pending")]
    Pending,
    #[serde(rename = "Succeeded")]
    Succeeded,
    #[serde(rename = "Failed")]
    Failed,
    #[serde(rename = "Skipped")]
    Skipped,
}

impl Default for Status {
    fn default() -> Status {
        Self::Pending
    }
}
/// Current status of execution for the activity rendered in the UI.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum UiStatus {
    #[serde(rename = "Pending")]
    Pending,
    #[serde(rename = "Action Performed")]
    ActionPerformed,
    #[serde(rename = "Executing")]
    Executing,
    #[serde(rename = "Error")]
    Error,
    #[serde(rename = "Skipped")]
    Skipped,
    #[serde(rename = "Retrying")]
    Retrying,
}

impl Default for UiStatus {
    fn default() -> UiStatus {
        Self::Pending
    }
}