Skip to main content

opensearch_client/indices/simulate_template/
simulate_template.rs

1/*
2 * opensearch-client
3 *
4 * Rust Client for OpenSearch
5 *
6 * The version of the OpenAPI document: 3.1.0
7 * Contact: alberto.paro@gmail.com
8 * Generated by Paro OpenAPI Generator
9 */
10
11use crate::common;
12use crate::indices;
13use serde::{Deserialize, Serialize};
14
15/// SimulateTemplate
16/// New index template definition to be simulated, if no index template name is specified.
17
18#[derive(Clone, Default, Debug, Serialize, Deserialize)]
19pub struct SimulateTemplate {
20    /// An ordered list of component template names.
21    /// Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
22    #[serde(
23        rename = "composed_of",
24        default,
25        skip_serializing_if = "Option::is_none"
26    )]
27    pub composed_of: Option<Vec<String>>,
28    #[serde(rename = "_meta", default, skip_serializing_if = "Option::is_none")]
29    pub meta: Option<common::Metadata>,
30    /// Priority to determine index template precedence when a new data stream or index is created.
31    /// The index template with the highest priority is chosen.
32    /// If no priority is specified the template is treated as though it is of priority 0 (lowest priority).
33    /// This number is not automatically generated by OpenSearch.
34    #[serde(rename = "priority", default, skip_serializing_if = "Option::is_none")]
35    pub priority: Option<u32>,
36    #[serde(rename = "version", default, skip_serializing_if = "Option::is_none")]
37    pub version: Option<u32>,
38    #[serde(
39        rename = "allow_auto_create",
40        default,
41        skip_serializing_if = "Option::is_none"
42    )]
43    pub allow_auto_create: Option<bool>,
44    /// A comma-separated list of aliases to retrieve. Supports wildcards (`*`).  To retrieve all aliases, omit this parameter or use `*` or `_all`.
45    #[serde(rename = "index_patterns")]
46    pub index_patterns: common::Names,
47    #[serde(rename = "template", default, skip_serializing_if = "Option::is_none")]
48    pub template: Option<indices::IndexTemplateSummary>,
49    #[serde(
50        rename = "data_stream",
51        default,
52        skip_serializing_if = "Option::is_none"
53    )]
54    pub data_stream: Option<indices::IndexTemplateDataStreamConfiguration>,
55}
56
57impl SimulateTemplate {
58    /// New index template definition to be simulated, if no index template name is specified.
59    pub fn new(index_patterns: common::Names) -> SimulateTemplate {
60        SimulateTemplate {
61            composed_of: None,
62            meta: None,
63            priority: None,
64            version: None,
65            allow_auto_create: None,
66            index_patterns,
67            template: None,
68            data_stream: None,
69        }
70    }
71}