fastly_api/models/
logging_https_response.rs

1/*
2 * Fastly API
3 *
4 * Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
5 *
6 */
7
8
9
10
11#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
12pub struct LoggingHttpsResponse {
13    /// The name for the real-time logging configuration.
14    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
15    pub name: Option<String>,
16    /// Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. 
17    #[serde(rename = "placement", skip_serializing_if = "Option::is_none")]
18    pub placement: Option<Placement>,
19    /// The name of an existing condition in the configured endpoint, or leave blank to always execute.
20    #[serde(rename = "response_condition", skip_serializing_if = "Option::is_none")]
21    pub response_condition: Option<String>,
22    /// A Fastly [log format string](https://www.fastly.com/documentation/guides/integrations/streaming-logs/custom-log-formats/).
23    #[serde(rename = "format", skip_serializing_if = "Option::is_none")]
24    pub format: Option<String>,
25    /// The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
26    #[serde(rename = "log_processing_region", skip_serializing_if = "Option::is_none")]
27    pub log_processing_region: Option<LogProcessingRegion>,
28    /// The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. 
29    #[serde(rename = "format_version", skip_serializing_if = "Option::is_none")]
30    pub format_version: Option<FormatVersion>,
31    /// A secure certificate to authenticate a server with. Must be in PEM format.
32    #[serde(rename = "tls_ca_cert", skip_serializing_if = "Option::is_none")]
33    pub tls_ca_cert: Option<String>,
34    /// The client certificate used to make authenticated requests. Must be in PEM format.
35    #[serde(rename = "tls_client_cert", skip_serializing_if = "Option::is_none")]
36    pub tls_client_cert: Option<String>,
37    /// The client private key used to make authenticated requests. Must be in PEM format.
38    #[serde(rename = "tls_client_key", skip_serializing_if = "Option::is_none")]
39    pub tls_client_key: Option<String>,
40    /// The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported.
41    #[serde(rename = "tls_hostname", skip_serializing_if = "Option::is_none")]
42    pub tls_hostname: Option<String>,
43    /// The maximum number of logs sent in one request. Defaults `0` (10k).
44    #[serde(rename = "request_max_entries", skip_serializing_if = "Option::is_none")]
45    pub request_max_entries: Option<i32>,
46    /// The maximum number of bytes sent in one request. Defaults `0` (100MB).
47    #[serde(rename = "request_max_bytes", skip_serializing_if = "Option::is_none")]
48    pub request_max_bytes: Option<i32>,
49    /// The URL to send logs to. Must use HTTPS. Required.
50    #[serde(rename = "url", skip_serializing_if = "Option::is_none")]
51    pub url: Option<String>,
52    /// Content type of the header sent with the request.
53    #[serde(rename = "content_type", skip_serializing_if = "Option::is_none")]
54    pub content_type: Option<String>,
55    /// Name of the custom header sent with the request.
56    #[serde(rename = "header_name", skip_serializing_if = "Option::is_none")]
57    pub header_name: Option<String>,
58    #[serde(rename = "message_type", skip_serializing_if = "Option::is_none")]
59    pub message_type: Option<crate::models::LoggingMessageType>,
60    /// Value of the custom header sent with the request.
61    #[serde(rename = "header_value", skip_serializing_if = "Option::is_none")]
62    pub header_value: Option<String>,
63    /// HTTP method used for request.
64    #[serde(rename = "method", skip_serializing_if = "Option::is_none")]
65    pub method: Option<Method>,
66    /// Enforces valid JSON formatting for log entries.
67    #[serde(rename = "json_format", skip_serializing_if = "Option::is_none")]
68    pub json_format: Option<JsonFormat>,
69    /// How frequently, in seconds, batches of log data are sent to the HTTPS endpoint. A value of `0` sends logs at the same interval as the default, which is `5` seconds.
70    #[serde(rename = "period", skip_serializing_if = "Option::is_none")]
71    pub period: Option<i32>,
72    /// Date and time in ISO 8601 format.
73    #[serde(rename = "created_at", skip_serializing_if = "Option::is_none")]
74    pub created_at: Option<String>,
75    /// Date and time in ISO 8601 format.
76    #[serde(rename = "deleted_at", skip_serializing_if = "Option::is_none")]
77    pub deleted_at: Option<String>,
78    /// Date and time in ISO 8601 format.
79    #[serde(rename = "updated_at", skip_serializing_if = "Option::is_none")]
80    pub updated_at: Option<String>,
81    #[serde(rename = "service_id", skip_serializing_if = "Option::is_none")]
82    pub service_id: Option<Box<String>>,
83    #[serde(rename = "version", skip_serializing_if = "Option::is_none")]
84    pub version: Option<Box<String>>,
85}
86
87impl LoggingHttpsResponse {
88    pub fn new() -> LoggingHttpsResponse {
89        LoggingHttpsResponse {
90            name: None,
91            placement: None,
92            response_condition: None,
93            format: None,
94            log_processing_region: None,
95            format_version: None,
96            tls_ca_cert: None,
97            tls_client_cert: None,
98            tls_client_key: None,
99            tls_hostname: None,
100            request_max_entries: None,
101            request_max_bytes: None,
102            url: None,
103            content_type: None,
104            header_name: None,
105            message_type: None,
106            header_value: None,
107            method: None,
108            json_format: None,
109            period: None,
110            created_at: None,
111            deleted_at: None,
112            updated_at: None,
113            service_id: None,
114            version: None,
115        }
116    }
117}
118
119/// Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. 
120#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
121pub enum Placement {
122    #[serde(rename = "none")]
123    None,
124    #[serde(rename = "null")]
125    Null,
126}
127
128impl Default for Placement {
129    fn default() -> Placement {
130        Self::None
131    }
132}
133/// The geographic region where the logs will be processed before streaming. Valid values are `us`, `eu`, and `none` for global.
134#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
135pub enum LogProcessingRegion {
136    #[serde(rename = "none")]
137    None,
138    #[serde(rename = "eu")]
139    Eu,
140    #[serde(rename = "us")]
141    Us,
142}
143
144impl Default for LogProcessingRegion {
145    fn default() -> LogProcessingRegion {
146        Self::None
147    }
148}
149/// The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. 
150#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
151pub enum FormatVersion {
152    #[serde(rename = "1")]
153    V1,
154    #[serde(rename = "2")]
155    V2,
156}
157
158impl Default for FormatVersion {
159    fn default() -> FormatVersion {
160        Self::V1
161    }
162}
163/// HTTP method used for request.
164#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
165pub enum Method {
166    #[serde(rename = "POST")]
167    POST,
168    #[serde(rename = "PUT")]
169    PUT,
170}
171
172impl Default for Method {
173    fn default() -> Method {
174        Self::POST
175    }
176}
177/// Enforces valid JSON formatting for log entries.
178#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
179pub enum JsonFormat {
180    #[serde(rename = "0")]
181    Disabled,
182    #[serde(rename = "1")]
183    JsonArray,
184    #[serde(rename = "2")]
185    NewlineDelimitedJson,
186}
187
188impl Default for JsonFormat {
189    fn default() -> JsonFormat {
190        Self::Disabled
191    }
192}
193