aws-sdk-opensearch 1.111.0

AWS SDK for Amazon OpenSearch Service
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Container for request parameters to the <code>CreatePackage</code> operation.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreatePackageInput {
    /// <p>Unique name for the package.</p>
    pub package_name: ::std::option::Option<::std::string::String>,
    /// <p>The type of package.</p>
    pub package_type: ::std::option::Option<crate::types::PackageType>,
    /// <p>Description of the package.</p>
    pub package_description: ::std::option::Option<::std::string::String>,
    /// <p>The Amazon S3 location from which to import the package.</p>
    pub package_source: ::std::option::Option<crate::types::PackageSource>,
    /// <p>The configuration parameters for the package being created.</p>
    pub package_configuration: ::std::option::Option<crate::types::PackageConfiguration>,
    /// <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code></p>
    pub engine_version: ::std::option::Option<::std::string::String>,
    /// <p>The vending options for the package being created. They determine if the package can be vended to other users.</p>
    pub package_vending_options: ::std::option::Option<crate::types::PackageVendingOptions>,
    /// <p>The encryption parameters for the package being created.</p>
    pub package_encryption_options: ::std::option::Option<crate::types::PackageEncryptionOptions>,
}
impl CreatePackageInput {
    /// <p>Unique name for the package.</p>
    pub fn package_name(&self) -> ::std::option::Option<&str> {
        self.package_name.as_deref()
    }
    /// <p>The type of package.</p>
    pub fn package_type(&self) -> ::std::option::Option<&crate::types::PackageType> {
        self.package_type.as_ref()
    }
    /// <p>Description of the package.</p>
    pub fn package_description(&self) -> ::std::option::Option<&str> {
        self.package_description.as_deref()
    }
    /// <p>The Amazon S3 location from which to import the package.</p>
    pub fn package_source(&self) -> ::std::option::Option<&crate::types::PackageSource> {
        self.package_source.as_ref()
    }
    /// <p>The configuration parameters for the package being created.</p>
    pub fn package_configuration(&self) -> ::std::option::Option<&crate::types::PackageConfiguration> {
        self.package_configuration.as_ref()
    }
    /// <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code></p>
    pub fn engine_version(&self) -> ::std::option::Option<&str> {
        self.engine_version.as_deref()
    }
    /// <p>The vending options for the package being created. They determine if the package can be vended to other users.</p>
    pub fn package_vending_options(&self) -> ::std::option::Option<&crate::types::PackageVendingOptions> {
        self.package_vending_options.as_ref()
    }
    /// <p>The encryption parameters for the package being created.</p>
    pub fn package_encryption_options(&self) -> ::std::option::Option<&crate::types::PackageEncryptionOptions> {
        self.package_encryption_options.as_ref()
    }
}
impl CreatePackageInput {
    /// Creates a new builder-style object to manufacture [`CreatePackageInput`](crate::operation::create_package::CreatePackageInput).
    pub fn builder() -> crate::operation::create_package::builders::CreatePackageInputBuilder {
        crate::operation::create_package::builders::CreatePackageInputBuilder::default()
    }
}

/// A builder for [`CreatePackageInput`](crate::operation::create_package::CreatePackageInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreatePackageInputBuilder {
    pub(crate) package_name: ::std::option::Option<::std::string::String>,
    pub(crate) package_type: ::std::option::Option<crate::types::PackageType>,
    pub(crate) package_description: ::std::option::Option<::std::string::String>,
    pub(crate) package_source: ::std::option::Option<crate::types::PackageSource>,
    pub(crate) package_configuration: ::std::option::Option<crate::types::PackageConfiguration>,
    pub(crate) engine_version: ::std::option::Option<::std::string::String>,
    pub(crate) package_vending_options: ::std::option::Option<crate::types::PackageVendingOptions>,
    pub(crate) package_encryption_options: ::std::option::Option<crate::types::PackageEncryptionOptions>,
}
impl CreatePackageInputBuilder {
    /// <p>Unique name for the package.</p>
    /// This field is required.
    pub fn package_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.package_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Unique name for the package.</p>
    pub fn set_package_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.package_name = input;
        self
    }
    /// <p>Unique name for the package.</p>
    pub fn get_package_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.package_name
    }
    /// <p>The type of package.</p>
    /// This field is required.
    pub fn package_type(mut self, input: crate::types::PackageType) -> Self {
        self.package_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of package.</p>
    pub fn set_package_type(mut self, input: ::std::option::Option<crate::types::PackageType>) -> Self {
        self.package_type = input;
        self
    }
    /// <p>The type of package.</p>
    pub fn get_package_type(&self) -> &::std::option::Option<crate::types::PackageType> {
        &self.package_type
    }
    /// <p>Description of the package.</p>
    pub fn package_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.package_description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Description of the package.</p>
    pub fn set_package_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.package_description = input;
        self
    }
    /// <p>Description of the package.</p>
    pub fn get_package_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.package_description
    }
    /// <p>The Amazon S3 location from which to import the package.</p>
    /// This field is required.
    pub fn package_source(mut self, input: crate::types::PackageSource) -> Self {
        self.package_source = ::std::option::Option::Some(input);
        self
    }
    /// <p>The Amazon S3 location from which to import the package.</p>
    pub fn set_package_source(mut self, input: ::std::option::Option<crate::types::PackageSource>) -> Self {
        self.package_source = input;
        self
    }
    /// <p>The Amazon S3 location from which to import the package.</p>
    pub fn get_package_source(&self) -> &::std::option::Option<crate::types::PackageSource> {
        &self.package_source
    }
    /// <p>The configuration parameters for the package being created.</p>
    pub fn package_configuration(mut self, input: crate::types::PackageConfiguration) -> Self {
        self.package_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The configuration parameters for the package being created.</p>
    pub fn set_package_configuration(mut self, input: ::std::option::Option<crate::types::PackageConfiguration>) -> Self {
        self.package_configuration = input;
        self
    }
    /// <p>The configuration parameters for the package being created.</p>
    pub fn get_package_configuration(&self) -> &::std::option::Option<crate::types::PackageConfiguration> {
        &self.package_configuration
    }
    /// <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code></p>
    pub fn engine_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.engine_version = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code></p>
    pub fn set_engine_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.engine_version = input;
        self
    }
    /// <p>The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type <code>ZIP-PLUGIN</code></p>
    pub fn get_engine_version(&self) -> &::std::option::Option<::std::string::String> {
        &self.engine_version
    }
    /// <p>The vending options for the package being created. They determine if the package can be vended to other users.</p>
    pub fn package_vending_options(mut self, input: crate::types::PackageVendingOptions) -> Self {
        self.package_vending_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>The vending options for the package being created. They determine if the package can be vended to other users.</p>
    pub fn set_package_vending_options(mut self, input: ::std::option::Option<crate::types::PackageVendingOptions>) -> Self {
        self.package_vending_options = input;
        self
    }
    /// <p>The vending options for the package being created. They determine if the package can be vended to other users.</p>
    pub fn get_package_vending_options(&self) -> &::std::option::Option<crate::types::PackageVendingOptions> {
        &self.package_vending_options
    }
    /// <p>The encryption parameters for the package being created.</p>
    pub fn package_encryption_options(mut self, input: crate::types::PackageEncryptionOptions) -> Self {
        self.package_encryption_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>The encryption parameters for the package being created.</p>
    pub fn set_package_encryption_options(mut self, input: ::std::option::Option<crate::types::PackageEncryptionOptions>) -> Self {
        self.package_encryption_options = input;
        self
    }
    /// <p>The encryption parameters for the package being created.</p>
    pub fn get_package_encryption_options(&self) -> &::std::option::Option<crate::types::PackageEncryptionOptions> {
        &self.package_encryption_options
    }
    /// Consumes the builder and constructs a [`CreatePackageInput`](crate::operation::create_package::CreatePackageInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_package::CreatePackageInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_package::CreatePackageInput {
            package_name: self.package_name,
            package_type: self.package_type,
            package_description: self.package_description,
            package_source: self.package_source,
            package_configuration: self.package_configuration,
            engine_version: self.engine_version,
            package_vending_options: self.package_vending_options,
            package_encryption_options: self.package_encryption_options,
        })
    }
}