aws_sdk_sagemakergeospatial/operation/get_tile/
_get_tile_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct GetTileInput {
6    /// <p>The x coordinate of the tile input.</p>
7    pub x: ::std::option::Option<i32>,
8    /// <p>The y coordinate of the tile input.</p>
9    pub y: ::std::option::Option<i32>,
10    /// <p>The z coordinate of the tile input.</p>
11    pub z: ::std::option::Option<i32>,
12    /// <p>The particular assets or bands to tile.</p>
13    pub image_assets: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
14    /// <p>Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.</p>
15    pub target: ::std::option::Option<crate::types::TargetOptions>,
16    /// <p>The Amazon Resource Name (ARN) of the tile operation.</p>
17    pub arn: ::std::option::Option<::std::string::String>,
18    /// <p>Determines whether or not to return a valid data mask.</p>
19    pub image_mask: ::std::option::Option<bool>,
20    /// <p>The data format of the output tile. The formats include .npy, .png and .jpg.</p>
21    pub output_format: ::std::option::Option<::std::string::String>,
22    /// <p>Time range filter applied to imagery to find the images to tile.</p>
23    pub time_range_filter: ::std::option::Option<::std::string::String>,
24    /// <p>Property filters for the imagery to tile.</p>
25    pub property_filters: ::std::option::Option<::std::string::String>,
26    /// <p>The output data type of the tile operation.</p>
27    pub output_data_type: ::std::option::Option<crate::types::OutputType>,
28    /// <p>The Amazon Resource Name (ARN) of the IAM role that you specify.</p>
29    pub execution_role_arn: ::std::option::Option<::std::string::String>,
30}
31impl GetTileInput {
32    /// <p>The x coordinate of the tile input.</p>
33    pub fn x(&self) -> ::std::option::Option<i32> {
34        self.x
35    }
36    /// <p>The y coordinate of the tile input.</p>
37    pub fn y(&self) -> ::std::option::Option<i32> {
38        self.y
39    }
40    /// <p>The z coordinate of the tile input.</p>
41    pub fn z(&self) -> ::std::option::Option<i32> {
42        self.z
43    }
44    /// <p>The particular assets or bands to tile.</p>
45    ///
46    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.image_assets.is_none()`.
47    pub fn image_assets(&self) -> &[::std::string::String] {
48        self.image_assets.as_deref().unwrap_or_default()
49    }
50    /// <p>Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.</p>
51    pub fn target(&self) -> ::std::option::Option<&crate::types::TargetOptions> {
52        self.target.as_ref()
53    }
54    /// <p>The Amazon Resource Name (ARN) of the tile operation.</p>
55    pub fn arn(&self) -> ::std::option::Option<&str> {
56        self.arn.as_deref()
57    }
58    /// <p>Determines whether or not to return a valid data mask.</p>
59    pub fn image_mask(&self) -> ::std::option::Option<bool> {
60        self.image_mask
61    }
62    /// <p>The data format of the output tile. The formats include .npy, .png and .jpg.</p>
63    pub fn output_format(&self) -> ::std::option::Option<&str> {
64        self.output_format.as_deref()
65    }
66    /// <p>Time range filter applied to imagery to find the images to tile.</p>
67    pub fn time_range_filter(&self) -> ::std::option::Option<&str> {
68        self.time_range_filter.as_deref()
69    }
70    /// <p>Property filters for the imagery to tile.</p>
71    pub fn property_filters(&self) -> ::std::option::Option<&str> {
72        self.property_filters.as_deref()
73    }
74    /// <p>The output data type of the tile operation.</p>
75    pub fn output_data_type(&self) -> ::std::option::Option<&crate::types::OutputType> {
76        self.output_data_type.as_ref()
77    }
78    /// <p>The Amazon Resource Name (ARN) of the IAM role that you specify.</p>
79    pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
80        self.execution_role_arn.as_deref()
81    }
82}
83impl GetTileInput {
84    /// Creates a new builder-style object to manufacture [`GetTileInput`](crate::operation::get_tile::GetTileInput).
85    pub fn builder() -> crate::operation::get_tile::builders::GetTileInputBuilder {
86        crate::operation::get_tile::builders::GetTileInputBuilder::default()
87    }
88}
89
90/// A builder for [`GetTileInput`](crate::operation::get_tile::GetTileInput).
91#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
92#[non_exhaustive]
93pub struct GetTileInputBuilder {
94    pub(crate) x: ::std::option::Option<i32>,
95    pub(crate) y: ::std::option::Option<i32>,
96    pub(crate) z: ::std::option::Option<i32>,
97    pub(crate) image_assets: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
98    pub(crate) target: ::std::option::Option<crate::types::TargetOptions>,
99    pub(crate) arn: ::std::option::Option<::std::string::String>,
100    pub(crate) image_mask: ::std::option::Option<bool>,
101    pub(crate) output_format: ::std::option::Option<::std::string::String>,
102    pub(crate) time_range_filter: ::std::option::Option<::std::string::String>,
103    pub(crate) property_filters: ::std::option::Option<::std::string::String>,
104    pub(crate) output_data_type: ::std::option::Option<crate::types::OutputType>,
105    pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
106}
107impl GetTileInputBuilder {
108    /// <p>The x coordinate of the tile input.</p>
109    /// This field is required.
110    pub fn x(mut self, input: i32) -> Self {
111        self.x = ::std::option::Option::Some(input);
112        self
113    }
114    /// <p>The x coordinate of the tile input.</p>
115    pub fn set_x(mut self, input: ::std::option::Option<i32>) -> Self {
116        self.x = input;
117        self
118    }
119    /// <p>The x coordinate of the tile input.</p>
120    pub fn get_x(&self) -> &::std::option::Option<i32> {
121        &self.x
122    }
123    /// <p>The y coordinate of the tile input.</p>
124    /// This field is required.
125    pub fn y(mut self, input: i32) -> Self {
126        self.y = ::std::option::Option::Some(input);
127        self
128    }
129    /// <p>The y coordinate of the tile input.</p>
130    pub fn set_y(mut self, input: ::std::option::Option<i32>) -> Self {
131        self.y = input;
132        self
133    }
134    /// <p>The y coordinate of the tile input.</p>
135    pub fn get_y(&self) -> &::std::option::Option<i32> {
136        &self.y
137    }
138    /// <p>The z coordinate of the tile input.</p>
139    /// This field is required.
140    pub fn z(mut self, input: i32) -> Self {
141        self.z = ::std::option::Option::Some(input);
142        self
143    }
144    /// <p>The z coordinate of the tile input.</p>
145    pub fn set_z(mut self, input: ::std::option::Option<i32>) -> Self {
146        self.z = input;
147        self
148    }
149    /// <p>The z coordinate of the tile input.</p>
150    pub fn get_z(&self) -> &::std::option::Option<i32> {
151        &self.z
152    }
153    /// Appends an item to `image_assets`.
154    ///
155    /// To override the contents of this collection use [`set_image_assets`](Self::set_image_assets).
156    ///
157    /// <p>The particular assets or bands to tile.</p>
158    pub fn image_assets(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
159        let mut v = self.image_assets.unwrap_or_default();
160        v.push(input.into());
161        self.image_assets = ::std::option::Option::Some(v);
162        self
163    }
164    /// <p>The particular assets or bands to tile.</p>
165    pub fn set_image_assets(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
166        self.image_assets = input;
167        self
168    }
169    /// <p>The particular assets or bands to tile.</p>
170    pub fn get_image_assets(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
171        &self.image_assets
172    }
173    /// <p>Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.</p>
174    /// This field is required.
175    pub fn target(mut self, input: crate::types::TargetOptions) -> Self {
176        self.target = ::std::option::Option::Some(input);
177        self
178    }
179    /// <p>Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.</p>
180    pub fn set_target(mut self, input: ::std::option::Option<crate::types::TargetOptions>) -> Self {
181        self.target = input;
182        self
183    }
184    /// <p>Determines what part of the Earth Observation job to tile. 'INPUT' or 'OUTPUT' are the valid options.</p>
185    pub fn get_target(&self) -> &::std::option::Option<crate::types::TargetOptions> {
186        &self.target
187    }
188    /// <p>The Amazon Resource Name (ARN) of the tile operation.</p>
189    /// This field is required.
190    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
191        self.arn = ::std::option::Option::Some(input.into());
192        self
193    }
194    /// <p>The Amazon Resource Name (ARN) of the tile operation.</p>
195    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
196        self.arn = input;
197        self
198    }
199    /// <p>The Amazon Resource Name (ARN) of the tile operation.</p>
200    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
201        &self.arn
202    }
203    /// <p>Determines whether or not to return a valid data mask.</p>
204    pub fn image_mask(mut self, input: bool) -> Self {
205        self.image_mask = ::std::option::Option::Some(input);
206        self
207    }
208    /// <p>Determines whether or not to return a valid data mask.</p>
209    pub fn set_image_mask(mut self, input: ::std::option::Option<bool>) -> Self {
210        self.image_mask = input;
211        self
212    }
213    /// <p>Determines whether or not to return a valid data mask.</p>
214    pub fn get_image_mask(&self) -> &::std::option::Option<bool> {
215        &self.image_mask
216    }
217    /// <p>The data format of the output tile. The formats include .npy, .png and .jpg.</p>
218    pub fn output_format(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
219        self.output_format = ::std::option::Option::Some(input.into());
220        self
221    }
222    /// <p>The data format of the output tile. The formats include .npy, .png and .jpg.</p>
223    pub fn set_output_format(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
224        self.output_format = input;
225        self
226    }
227    /// <p>The data format of the output tile. The formats include .npy, .png and .jpg.</p>
228    pub fn get_output_format(&self) -> &::std::option::Option<::std::string::String> {
229        &self.output_format
230    }
231    /// <p>Time range filter applied to imagery to find the images to tile.</p>
232    pub fn time_range_filter(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
233        self.time_range_filter = ::std::option::Option::Some(input.into());
234        self
235    }
236    /// <p>Time range filter applied to imagery to find the images to tile.</p>
237    pub fn set_time_range_filter(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
238        self.time_range_filter = input;
239        self
240    }
241    /// <p>Time range filter applied to imagery to find the images to tile.</p>
242    pub fn get_time_range_filter(&self) -> &::std::option::Option<::std::string::String> {
243        &self.time_range_filter
244    }
245    /// <p>Property filters for the imagery to tile.</p>
246    pub fn property_filters(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
247        self.property_filters = ::std::option::Option::Some(input.into());
248        self
249    }
250    /// <p>Property filters for the imagery to tile.</p>
251    pub fn set_property_filters(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
252        self.property_filters = input;
253        self
254    }
255    /// <p>Property filters for the imagery to tile.</p>
256    pub fn get_property_filters(&self) -> &::std::option::Option<::std::string::String> {
257        &self.property_filters
258    }
259    /// <p>The output data type of the tile operation.</p>
260    pub fn output_data_type(mut self, input: crate::types::OutputType) -> Self {
261        self.output_data_type = ::std::option::Option::Some(input);
262        self
263    }
264    /// <p>The output data type of the tile operation.</p>
265    pub fn set_output_data_type(mut self, input: ::std::option::Option<crate::types::OutputType>) -> Self {
266        self.output_data_type = input;
267        self
268    }
269    /// <p>The output data type of the tile operation.</p>
270    pub fn get_output_data_type(&self) -> &::std::option::Option<crate::types::OutputType> {
271        &self.output_data_type
272    }
273    /// <p>The Amazon Resource Name (ARN) of the IAM role that you specify.</p>
274    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
275        self.execution_role_arn = ::std::option::Option::Some(input.into());
276        self
277    }
278    /// <p>The Amazon Resource Name (ARN) of the IAM role that you specify.</p>
279    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
280        self.execution_role_arn = input;
281        self
282    }
283    /// <p>The Amazon Resource Name (ARN) of the IAM role that you specify.</p>
284    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
285        &self.execution_role_arn
286    }
287    /// Consumes the builder and constructs a [`GetTileInput`](crate::operation::get_tile::GetTileInput).
288    pub fn build(self) -> ::std::result::Result<crate::operation::get_tile::GetTileInput, ::aws_smithy_types::error::operation::BuildError> {
289        ::std::result::Result::Ok(crate::operation::get_tile::GetTileInput {
290            x: self.x,
291            y: self.y,
292            z: self.z,
293            image_assets: self.image_assets,
294            target: self.target,
295            arn: self.arn,
296            image_mask: self.image_mask,
297            output_format: self.output_format,
298            time_range_filter: self.time_range_filter,
299            property_filters: self.property_filters,
300            output_data_type: self.output_data_type,
301            execution_role_arn: self.execution_role_arn,
302        })
303    }
304}
aws_sdk_sagemakergeospatial/operation/get_tile/_get_tile_input.rs

aws_sdk_sagemakergeospatial/operation/get_tile/
_get_tile_input.rs
