aws-sdk-geomaps 1.49.0

AWS SDK for Amazon Location Service Maps V2
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

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct GetTileInput {
    /// <p>A list of optional additional parameters such as map styles that can be requested for each result.</p>
    pub additional_features: ::std::option::Option<::std::vec::Vec<crate::types::TileAdditionalFeature>>,
    /// <p>Specifies the desired tile set.</p>
    /// <p>Valid Values: <code>raster.satellite | vector.basemap | vector.traffic | raster.dem</code></p>
    pub tileset: ::std::option::Option<::std::string::String>,
    /// <p>The zoom value for the map tile.</p>
    pub z: ::std::option::Option<::std::string::String>,
    /// <p>The X axis value for the map tile. Must be between 0 and 19.</p>
    pub x: ::std::option::Option<::std::string::String>,
    /// <p>The Y axis value for the map tile.</p>
    pub y: ::std::option::Option<::std::string::String>,
    /// <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
    pub key: ::std::option::Option<::std::string::String>,
}
impl GetTileInput {
    /// <p>A list of optional additional parameters such as map styles that can be requested for each result.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.additional_features.is_none()`.
    pub fn additional_features(&self) -> &[crate::types::TileAdditionalFeature] {
        self.additional_features.as_deref().unwrap_or_default()
    }
    /// <p>Specifies the desired tile set.</p>
    /// <p>Valid Values: <code>raster.satellite | vector.basemap | vector.traffic | raster.dem</code></p>
    pub fn tileset(&self) -> ::std::option::Option<&str> {
        self.tileset.as_deref()
    }
    /// <p>The zoom value for the map tile.</p>
    pub fn z(&self) -> ::std::option::Option<&str> {
        self.z.as_deref()
    }
    /// <p>The X axis value for the map tile. Must be between 0 and 19.</p>
    pub fn x(&self) -> ::std::option::Option<&str> {
        self.x.as_deref()
    }
    /// <p>The Y axis value for the map tile.</p>
    pub fn y(&self) -> ::std::option::Option<&str> {
        self.y.as_deref()
    }
    /// <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
    pub fn key(&self) -> ::std::option::Option<&str> {
        self.key.as_deref()
    }
}
impl ::std::fmt::Debug for GetTileInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetTileInput");
        formatter.field("additional_features", &self.additional_features);
        formatter.field("tileset", &self.tileset);
        formatter.field("z", &"*** Sensitive Data Redacted ***");
        formatter.field("x", &"*** Sensitive Data Redacted ***");
        formatter.field("y", &"*** Sensitive Data Redacted ***");
        formatter.field("key", &"*** Sensitive Data Redacted ***");
        formatter.finish()
    }
}
impl GetTileInput {
    /// Creates a new builder-style object to manufacture [`GetTileInput`](crate::operation::get_tile::GetTileInput).
    pub fn builder() -> crate::operation::get_tile::builders::GetTileInputBuilder {
        crate::operation::get_tile::builders::GetTileInputBuilder::default()
    }
}

/// A builder for [`GetTileInput`](crate::operation::get_tile::GetTileInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct GetTileInputBuilder {
    pub(crate) additional_features: ::std::option::Option<::std::vec::Vec<crate::types::TileAdditionalFeature>>,
    pub(crate) tileset: ::std::option::Option<::std::string::String>,
    pub(crate) z: ::std::option::Option<::std::string::String>,
    pub(crate) x: ::std::option::Option<::std::string::String>,
    pub(crate) y: ::std::option::Option<::std::string::String>,
    pub(crate) key: ::std::option::Option<::std::string::String>,
}
impl GetTileInputBuilder {
    /// Appends an item to `additional_features`.
    ///
    /// To override the contents of this collection use [`set_additional_features`](Self::set_additional_features).
    ///
    /// <p>A list of optional additional parameters such as map styles that can be requested for each result.</p>
    pub fn additional_features(mut self, input: crate::types::TileAdditionalFeature) -> Self {
        let mut v = self.additional_features.unwrap_or_default();
        v.push(input);
        self.additional_features = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of optional additional parameters such as map styles that can be requested for each result.</p>
    pub fn set_additional_features(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TileAdditionalFeature>>) -> Self {
        self.additional_features = input;
        self
    }
    /// <p>A list of optional additional parameters such as map styles that can be requested for each result.</p>
    pub fn get_additional_features(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TileAdditionalFeature>> {
        &self.additional_features
    }
    /// <p>Specifies the desired tile set.</p>
    /// <p>Valid Values: <code>raster.satellite | vector.basemap | vector.traffic | raster.dem</code></p>
    /// This field is required.
    pub fn tileset(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.tileset = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Specifies the desired tile set.</p>
    /// <p>Valid Values: <code>raster.satellite | vector.basemap | vector.traffic | raster.dem</code></p>
    pub fn set_tileset(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.tileset = input;
        self
    }
    /// <p>Specifies the desired tile set.</p>
    /// <p>Valid Values: <code>raster.satellite | vector.basemap | vector.traffic | raster.dem</code></p>
    pub fn get_tileset(&self) -> &::std::option::Option<::std::string::String> {
        &self.tileset
    }
    /// <p>The zoom value for the map tile.</p>
    /// This field is required.
    pub fn z(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.z = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The zoom value for the map tile.</p>
    pub fn set_z(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.z = input;
        self
    }
    /// <p>The zoom value for the map tile.</p>
    pub fn get_z(&self) -> &::std::option::Option<::std::string::String> {
        &self.z
    }
    /// <p>The X axis value for the map tile. Must be between 0 and 19.</p>
    /// This field is required.
    pub fn x(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.x = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The X axis value for the map tile. Must be between 0 and 19.</p>
    pub fn set_x(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.x = input;
        self
    }
    /// <p>The X axis value for the map tile. Must be between 0 and 19.</p>
    pub fn get_x(&self) -> &::std::option::Option<::std::string::String> {
        &self.x
    }
    /// <p>The Y axis value for the map tile.</p>
    /// This field is required.
    pub fn y(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.y = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Y axis value for the map tile.</p>
    pub fn set_y(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.y = input;
        self
    }
    /// <p>The Y axis value for the map tile.</p>
    pub fn get_y(&self) -> &::std::option::Option<::std::string::String> {
        &self.y
    }
    /// <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
    pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.key = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
    pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key = input;
        self
    }
    /// <p>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.</p>
    pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
        &self.key
    }
    /// Consumes the builder and constructs a [`GetTileInput`](crate::operation::get_tile::GetTileInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::get_tile::GetTileInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_tile::GetTileInput {
            additional_features: self.additional_features,
            tileset: self.tileset,
            z: self.z,
            x: self.x,
            y: self.y,
            key: self.key,
        })
    }
}
impl ::std::fmt::Debug for GetTileInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetTileInputBuilder");
        formatter.field("additional_features", &self.additional_features);
        formatter.field("tileset", &self.tileset);
        formatter.field("z", &"*** Sensitive Data Redacted ***");
        formatter.field("x", &"*** Sensitive Data Redacted ***");
        formatter.field("y", &"*** Sensitive Data Redacted ***");
        formatter.field("key", &"*** Sensitive Data Redacted ***");
        formatter.finish()
    }
}