aws_sdk_lookoutvision/operation/list_dataset_entries/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_dataset_entries::_list_dataset_entries_output::ListDatasetEntriesOutputBuilder;
3
4pub use crate::operation::list_dataset_entries::_list_dataset_entries_input::ListDatasetEntriesInputBuilder;
5
6impl crate::operation::list_dataset_entries::builders::ListDatasetEntriesInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_dataset_entries::ListDatasetEntriesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_dataset_entries::ListDatasetEntriesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_dataset_entries();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListDatasetEntries`.
24///
25/// <p>Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.</p>
26/// <p>This operation requires permissions to perform the <code>lookoutvision:ListDatasetEntries</code> operation.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListDatasetEntriesFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_dataset_entries::builders::ListDatasetEntriesInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_dataset_entries::ListDatasetEntriesOutput,
36        crate::operation::list_dataset_entries::ListDatasetEntriesError,
37    > for ListDatasetEntriesFluentBuilder
38{
39    fn send(
40        self,
41        config_override: crate::config::Builder,
42    ) -> crate::client::customize::internal::BoxFuture<
43        crate::client::customize::internal::SendResult<
44            crate::operation::list_dataset_entries::ListDatasetEntriesOutput,
45            crate::operation::list_dataset_entries::ListDatasetEntriesError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListDatasetEntriesFluentBuilder {
52    /// Creates a new `ListDatasetEntriesFluentBuilder`.
53    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54        Self {
55            handle,
56            inner: ::std::default::Default::default(),
57            config_override: ::std::option::Option::None,
58        }
59    }
60    /// Access the ListDatasetEntries as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_dataset_entries::builders::ListDatasetEntriesInputBuilder {
62        &self.inner
63    }
64    /// Sends the request and returns the response.
65    ///
66    /// If an error occurs, an `SdkError` will be returned with additional details that
67    /// can be matched against.
68    ///
69    /// By default, any retryable failures will be retried twice. Retry behavior
70    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71    /// set when configuring the client.
72    pub async fn send(
73        self,
74    ) -> ::std::result::Result<
75        crate::operation::list_dataset_entries::ListDatasetEntriesOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_dataset_entries::ListDatasetEntriesError,
78            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79        >,
80    > {
81        let input = self
82            .inner
83            .build()
84            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85        let runtime_plugins = crate::operation::list_dataset_entries::ListDatasetEntries::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_dataset_entries::ListDatasetEntries::orchestrate(&runtime_plugins, input).await
91    }
92
93    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94    pub fn customize(
95        self,
96    ) -> crate::client::customize::CustomizableOperation<
97        crate::operation::list_dataset_entries::ListDatasetEntriesOutput,
98        crate::operation::list_dataset_entries::ListDatasetEntriesError,
99        Self,
100    > {
101        crate::client::customize::CustomizableOperation::new(self)
102    }
103    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104        self.set_config_override(::std::option::Option::Some(config_override.into()));
105        self
106    }
107
108    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109        self.config_override = config_override;
110        self
111    }
112    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::list_dataset_entries::paginator::ListDatasetEntriesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_dataset_entries::paginator::ListDatasetEntriesPaginator {
116        crate::operation::list_dataset_entries::paginator::ListDatasetEntriesPaginator::new(self.handle, self.inner)
117    }
118    /// <p>The name of the project that contains the dataset that you want to list.</p>
119    pub fn project_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120        self.inner = self.inner.project_name(input.into());
121        self
122    }
123    /// <p>The name of the project that contains the dataset that you want to list.</p>
124    pub fn set_project_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_project_name(input);
126        self
127    }
128    /// <p>The name of the project that contains the dataset that you want to list.</p>
129    pub fn get_project_name(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_project_name()
131    }
132    /// <p>The type of the dataset that you want to list. Specify <code>train</code> to list the training dataset. Specify <code>test</code> to list the test dataset. If you have a single dataset project, specify <code>train</code>.</p>
133    pub fn dataset_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134        self.inner = self.inner.dataset_type(input.into());
135        self
136    }
137    /// <p>The type of the dataset that you want to list. Specify <code>train</code> to list the training dataset. Specify <code>test</code> to list the test dataset. If you have a single dataset project, specify <code>train</code>.</p>
138    pub fn set_dataset_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139        self.inner = self.inner.set_dataset_type(input);
140        self
141    }
142    /// <p>The type of the dataset that you want to list. Specify <code>train</code> to list the training dataset. Specify <code>test</code> to list the test dataset. If you have a single dataset project, specify <code>train</code>.</p>
143    pub fn get_dataset_type(&self) -> &::std::option::Option<::std::string::String> {
144        self.inner.get_dataset_type()
145    }
146    /// <p>Specify <code>true</code> to include labeled entries, otherwise specify <code>false</code>. If you don't specify a value, Lookout for Vision returns all entries.</p>
147    pub fn labeled(mut self, input: bool) -> Self {
148        self.inner = self.inner.labeled(input);
149        self
150    }
151    /// <p>Specify <code>true</code> to include labeled entries, otherwise specify <code>false</code>. If you don't specify a value, Lookout for Vision returns all entries.</p>
152    pub fn set_labeled(mut self, input: ::std::option::Option<bool>) -> Self {
153        self.inner = self.inner.set_labeled(input);
154        self
155    }
156    /// <p>Specify <code>true</code> to include labeled entries, otherwise specify <code>false</code>. If you don't specify a value, Lookout for Vision returns all entries.</p>
157    pub fn get_labeled(&self) -> &::std::option::Option<bool> {
158        self.inner.get_labeled()
159    }
160    /// <p>Specify <code>normal</code> to include only normal images. Specify <code>anomaly</code> to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.</p>
161    pub fn anomaly_class(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
162        self.inner = self.inner.anomaly_class(input.into());
163        self
164    }
165    /// <p>Specify <code>normal</code> to include only normal images. Specify <code>anomaly</code> to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.</p>
166    pub fn set_anomaly_class(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
167        self.inner = self.inner.set_anomaly_class(input);
168        self
169    }
170    /// <p>Specify <code>normal</code> to include only normal images. Specify <code>anomaly</code> to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.</p>
171    pub fn get_anomaly_class(&self) -> &::std::option::Option<::std::string::String> {
172        self.inner.get_anomaly_class()
173    }
174    /// <p>Only includes entries before the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>
175    pub fn before_creation_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
176        self.inner = self.inner.before_creation_date(input);
177        self
178    }
179    /// <p>Only includes entries before the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>
180    pub fn set_before_creation_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
181        self.inner = self.inner.set_before_creation_date(input);
182        self
183    }
184    /// <p>Only includes entries before the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>
185    pub fn get_before_creation_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
186        self.inner.get_before_creation_date()
187    }
188    /// <p>Only includes entries after the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>
189    pub fn after_creation_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
190        self.inner = self.inner.after_creation_date(input);
191        self
192    }
193    /// <p>Only includes entries after the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>
194    pub fn set_after_creation_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
195        self.inner = self.inner.set_after_creation_date(input);
196        self
197    }
198    /// <p>Only includes entries after the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</p>
199    pub fn get_after_creation_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
200        self.inner.get_after_creation_date()
201    }
202    /// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.</p>
203    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
204        self.inner = self.inner.next_token(input.into());
205        self
206    }
207    /// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.</p>
208    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
209        self.inner = self.inner.set_next_token(input);
210        self
211    }
212    /// <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.</p>
213    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
214        self.inner.get_next_token()
215    }
216    /// <p>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</p>
217    pub fn max_results(mut self, input: i32) -> Self {
218        self.inner = self.inner.max_results(input);
219        self
220    }
221    /// <p>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</p>
222    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
223        self.inner = self.inner.set_max_results(input);
224        self
225    }
226    /// <p>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</p>
227    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
228        self.inner.get_max_results()
229    }
230    /// <p>Perform a "contains" search on the values of the <code>source-ref</code> key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the <code>source-ref</code> key value matches <i>*IMG_17*</i>.</p>
231    pub fn source_ref_contains(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
232        self.inner = self.inner.source_ref_contains(input.into());
233        self
234    }
235    /// <p>Perform a "contains" search on the values of the <code>source-ref</code> key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the <code>source-ref</code> key value matches <i>*IMG_17*</i>.</p>
236    pub fn set_source_ref_contains(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
237        self.inner = self.inner.set_source_ref_contains(input);
238        self
239    }
240    /// <p>Perform a "contains" search on the values of the <code>source-ref</code> key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the <code>source-ref</code> key value matches <i>*IMG_17*</i>.</p>
241    pub fn get_source_ref_contains(&self) -> &::std::option::Option<::std::string::String> {
242        self.inner.get_source_ref_contains()
243    }
244}