Skip to main content

appwrite/models/
proxy_rule.rs

1//! ProxyRule model for Appwrite SDK
2
3use serde::{Deserialize, Serialize};
4
5/// Rule
6#[derive(Debug, Clone, Serialize, Deserialize)]
7#[cfg_attr(test, derive(Default))]
8pub struct ProxyRule {
9    /// Rule ID.
10    #[serde(rename = "$id")]
11    pub id: String,
12    /// Rule creation date in ISO 8601 format.
13    #[serde(rename = "$createdAt")]
14    pub created_at: String,
15    /// Rule update date in ISO 8601 format.
16    #[serde(rename = "$updatedAt")]
17    pub updated_at: String,
18    /// Domain name.
19    #[serde(rename = "domain")]
20    pub domain: String,
21    /// Action definition for the rule. Possible values are "api", "deployment", or
22    /// "redirect"
23    #[serde(rename = "type")]
24    pub r#type: String,
25    /// Defines how the rule was created. Possible values are "manual" or
26    /// "deployment"
27    #[serde(rename = "trigger")]
28    pub trigger: String,
29    /// URL to redirect to. Used if type is "redirect"
30    #[serde(rename = "redirectUrl")]
31    pub redirect_url: String,
32    /// Status code to apply during redirect. Used if type is "redirect"
33    #[serde(rename = "redirectStatusCode")]
34    pub redirect_status_code: i64,
35    /// ID of deployment. Used if type is "deployment"
36    #[serde(rename = "deploymentId")]
37    pub deployment_id: String,
38    /// Type of deployment. Possible values are "function", "site". Used if rule's
39    /// type is "deployment".
40    #[serde(rename = "deploymentResourceType")]
41    #[serde(skip_serializing_if = "Option::is_none")]
42    pub deployment_resource_type: Option<crate::enums::ProxyRuleDeploymentResourceType>,
43    /// ID of deployment's resource (site or function ID). Used if type is
44    /// "deployment"
45    #[serde(rename = "deploymentResourceId")]
46    pub deployment_resource_id: String,
47    /// Name of Git branch that updates rule. Used if type is "deployment"
48    #[serde(rename = "deploymentVcsProviderBranch")]
49    pub deployment_vcs_provider_branch: String,
50    /// Domain verification status. Possible values are "unverified", "verifying",
51    /// "verified"
52    #[serde(rename = "status")]
53    pub status: crate::enums::ProxyRuleStatus,
54    /// Logs from rule verification or certificate generation. Certificate
55    /// generation logs are prioritized if both are available.
56    #[serde(rename = "logs")]
57    pub logs: String,
58    /// Certificate auto-renewal date in ISO 8601 format.
59    #[serde(rename = "renewAt")]
60    pub renew_at: String,
61}
62
63impl ProxyRule {
64    /// Get id
65    pub fn id(&self) -> &String {
66        &self.id
67    }
68
69    /// Get created_at
70    pub fn created_at(&self) -> &String {
71        &self.created_at
72    }
73
74    /// Get updated_at
75    pub fn updated_at(&self) -> &String {
76        &self.updated_at
77    }
78
79    /// Get domain
80    pub fn domain(&self) -> &String {
81        &self.domain
82    }
83
84    /// Get r#type
85    pub fn r#type(&self) -> &String {
86        &self.r#type
87    }
88
89    /// Get trigger
90    pub fn trigger(&self) -> &String {
91        &self.trigger
92    }
93
94    /// Get redirect_url
95    pub fn redirect_url(&self) -> &String {
96        &self.redirect_url
97    }
98
99    /// Get redirect_status_code
100    pub fn redirect_status_code(&self) -> &i64 {
101        &self.redirect_status_code
102    }
103
104    /// Get deployment_id
105    pub fn deployment_id(&self) -> &String {
106        &self.deployment_id
107    }
108
109    /// Set deployment_resource_type
110    pub fn set_deployment_resource_type(mut self, deployment_resource_type: crate::enums::ProxyRuleDeploymentResourceType) -> Self {
111        self.deployment_resource_type = Some(deployment_resource_type);
112        self
113    }
114
115    /// Get deployment_resource_type
116    pub fn deployment_resource_type(&self) -> Option<&crate::enums::ProxyRuleDeploymentResourceType> {
117        self.deployment_resource_type.as_ref()
118    }
119
120    /// Get deployment_resource_id
121    pub fn deployment_resource_id(&self) -> &String {
122        &self.deployment_resource_id
123    }
124
125    /// Get deployment_vcs_provider_branch
126    pub fn deployment_vcs_provider_branch(&self) -> &String {
127        &self.deployment_vcs_provider_branch
128    }
129
130    /// Get status
131    pub fn status(&self) -> &crate::enums::ProxyRuleStatus {
132        &self.status
133    }
134
135    /// Get logs
136    pub fn logs(&self) -> &String {
137        &self.logs
138    }
139
140    /// Get renew_at
141    pub fn renew_at(&self) -> &String {
142        &self.renew_at
143    }
144
145}
146
147#[cfg(test)]
148mod tests {
149    use super::*;
150
151    #[test]
152    fn test_proxy_rule_creation() {
153        let _model = <ProxyRule as Default>::default();
154        let _ = _model.id();
155        let _ = _model.created_at();
156        let _ = _model.updated_at();
157        let _ = _model.domain();
158        let _ = _model.r#type();
159        let _ = _model.trigger();
160        let _ = _model.redirect_url();
161        let _ = _model.redirect_status_code();
162        let _ = _model.deployment_id();
163        let _ = _model.deployment_resource_id();
164        let _ = _model.deployment_vcs_provider_branch();
165        let _ = _model.status();
166        let _ = _model.logs();
167        let _ = _model.renew_at();
168    }
169
170    #[test]
171    fn test_proxy_rule_serialization() {
172        let model = <ProxyRule as Default>::default();
173        let json = serde_json::to_string(&model);
174        assert!(json.is_ok());
175
176        let deserialized: Result<ProxyRule, _> = serde_json::from_str(&json.unwrap());
177        assert!(deserialized.is_ok());
178    }
179}