aws_sdk_devicefarm/operation/list_devices/
builders.rs

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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::list_devices::_list_devices_output::ListDevicesOutputBuilder;

pub use crate::operation::list_devices::_list_devices_input::ListDevicesInputBuilder;

impl crate::operation::list_devices::builders::ListDevicesInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::list_devices::ListDevicesOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_devices::ListDevicesError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.list_devices();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ListDevices`.
///
/// <p>Gets information about unique device types.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ListDevicesFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::list_devices::builders::ListDevicesInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::list_devices::ListDevicesOutput,
        crate::operation::list_devices::ListDevicesError,
    > for ListDevicesFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::list_devices::ListDevicesOutput,
            crate::operation::list_devices::ListDevicesError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ListDevicesFluentBuilder {
    /// Creates a new `ListDevicesFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the ListDevices as a reference.
    pub fn as_input(&self) -> &crate::operation::list_devices::builders::ListDevicesInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::list_devices::ListDevicesOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::list_devices::ListDevicesError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::list_devices::ListDevices::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::list_devices::ListDevices::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::list_devices::ListDevicesOutput,
        crate::operation::list_devices::ListDevicesError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::list_devices::paginator::ListDevicesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::list_devices::paginator::ListDevicesPaginator {
        crate::operation::list_devices::paginator::ListDevicesPaginator::new(self.handle, self.inner)
    }
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.arn(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_arn(input);
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_arn()
    }
    /// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.next_token(input.into());
        self
    }
    /// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_next_token(input);
        self
    }
    /// <p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    ///
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p>
    /// <ul>
    /// <li>
    /// <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p>
    /// <p>Allowed values include:</p>
    /// <ul>
    /// <li>
    /// <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p></li>
    /// <li>
    /// <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p></li>
    /// <li>
    /// <p>OS_VERSION: The operating system version (for example, 10.3.2).</p></li>
    /// <li>
    /// <p>MODEL: The device model (for example, iPad 5th Gen).</p></li>
    /// <li>
    /// <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>
    /// <li>
    /// <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p></li>
    /// <li>
    /// <p>MANUFACTURER: The device manufacturer (for example, Apple).</p></li>
    /// <li>
    /// <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p></li>
    /// <li>
    /// <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>, this attribute is ignored.</p></li>
    /// <li>
    /// <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p></li>
    /// <li>
    /// <p>INSTANCE_LABELS: The label of the device instance.</p></li>
    /// <li>
    /// <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p></li>
    /// </ul></li>
    /// <li>
    /// <p>Operator: The filter operator.</p>
    /// <ul>
    /// <li>
    /// <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p></li>
    /// <li>
    /// <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p></li>
    /// <li>
    /// <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p></li>
    /// <li>
    /// <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p></li>
    /// </ul></li>
    /// <li>
    /// <p>Values: An array of one or more filter values.</p>
    /// <ul>
    /// <li>
    /// <p>The IN and NOT_IN operators take a values array that has one or more elements.</p></li>
    /// <li>
    /// <p>The other operators require an array with a single element.</p></li>
    /// <li>
    /// <p>In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>
    /// </ul></li>
    /// </ul>
    pub fn filters(mut self, input: crate::types::DeviceFilter) -> Self {
        self.inner = self.inner.filters(input);
        self
    }
    /// <p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p>
    /// <ul>
    /// <li>
    /// <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p>
    /// <p>Allowed values include:</p>
    /// <ul>
    /// <li>
    /// <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p></li>
    /// <li>
    /// <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p></li>
    /// <li>
    /// <p>OS_VERSION: The operating system version (for example, 10.3.2).</p></li>
    /// <li>
    /// <p>MODEL: The device model (for example, iPad 5th Gen).</p></li>
    /// <li>
    /// <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>
    /// <li>
    /// <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p></li>
    /// <li>
    /// <p>MANUFACTURER: The device manufacturer (for example, Apple).</p></li>
    /// <li>
    /// <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p></li>
    /// <li>
    /// <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>, this attribute is ignored.</p></li>
    /// <li>
    /// <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p></li>
    /// <li>
    /// <p>INSTANCE_LABELS: The label of the device instance.</p></li>
    /// <li>
    /// <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p></li>
    /// </ul></li>
    /// <li>
    /// <p>Operator: The filter operator.</p>
    /// <ul>
    /// <li>
    /// <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p></li>
    /// <li>
    /// <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p></li>
    /// <li>
    /// <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p></li>
    /// <li>
    /// <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p></li>
    /// </ul></li>
    /// <li>
    /// <p>Values: An array of one or more filter values.</p>
    /// <ul>
    /// <li>
    /// <p>The IN and NOT_IN operators take a values array that has one or more elements.</p></li>
    /// <li>
    /// <p>The other operators require an array with a single element.</p></li>
    /// <li>
    /// <p>In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>
    /// </ul></li>
    /// </ul>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DeviceFilter>>) -> Self {
        self.inner = self.inner.set_filters(input);
        self
    }
    /// <p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p>
    /// <ul>
    /// <li>
    /// <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p>
    /// <p>Allowed values include:</p>
    /// <ul>
    /// <li>
    /// <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p></li>
    /// <li>
    /// <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p></li>
    /// <li>
    /// <p>OS_VERSION: The operating system version (for example, 10.3.2).</p></li>
    /// <li>
    /// <p>MODEL: The device model (for example, iPad 5th Gen).</p></li>
    /// <li>
    /// <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>
    /// <li>
    /// <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p></li>
    /// <li>
    /// <p>MANUFACTURER: The device manufacturer (for example, Apple).</p></li>
    /// <li>
    /// <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p></li>
    /// <li>
    /// <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>, this attribute is ignored.</p></li>
    /// <li>
    /// <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p></li>
    /// <li>
    /// <p>INSTANCE_LABELS: The label of the device instance.</p></li>
    /// <li>
    /// <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p></li>
    /// </ul></li>
    /// <li>
    /// <p>Operator: The filter operator.</p>
    /// <ul>
    /// <li>
    /// <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p></li>
    /// <li>
    /// <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p></li>
    /// <li>
    /// <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p></li>
    /// <li>
    /// <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p></li>
    /// </ul></li>
    /// <li>
    /// <p>Values: An array of one or more filter values.</p>
    /// <ul>
    /// <li>
    /// <p>The IN and NOT_IN operators take a values array that has one or more elements.</p></li>
    /// <li>
    /// <p>The other operators require an array with a single element.</p></li>
    /// <li>
    /// <p>In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>
    /// </ul></li>
    /// </ul>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DeviceFilter>> {
        self.inner.get_filters()
    }
}