aws_sdk_amp/operation/list_scrapers/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_scrapers::_list_scrapers_output::ListScrapersOutputBuilder;
3
4pub use crate::operation::list_scrapers::_list_scrapers_input::ListScrapersInputBuilder;
5
6impl crate::operation::list_scrapers::builders::ListScrapersInputBuilder {
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_scrapers::ListScrapersOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::list_scrapers::ListScrapersError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.list_scrapers();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `ListScrapers`.
24///
25/// <p>The <code>ListScrapers</code> operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct ListScrapersFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::list_scrapers::builders::ListScrapersInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::list_scrapers::ListScrapersOutput,
35 crate::operation::list_scrapers::ListScrapersError,
36 > for ListScrapersFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::list_scrapers::ListScrapersOutput,
44 crate::operation::list_scrapers::ListScrapersError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl ListScrapersFluentBuilder {
51 /// Creates a new `ListScrapersFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the ListScrapers as a reference.
60 pub fn as_input(&self) -> &crate::operation::list_scrapers::builders::ListScrapersInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::list_scrapers::ListScrapersOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::list_scrapers::ListScrapersError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::list_scrapers::ListScrapers::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::list_scrapers::ListScrapers::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::list_scrapers::ListScrapersOutput,
97 crate::operation::list_scrapers::ListScrapersError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// Create a paginator for this request
112 ///
113 /// Paginators are used by calling [`send().await`](crate::operation::list_scrapers::paginator::ListScrapersPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
114 pub fn into_paginator(self) -> crate::operation::list_scrapers::paginator::ListScrapersPaginator {
115 crate::operation::list_scrapers::paginator::ListScrapersPaginator::new(self.handle, self.inner)
116 }
117 ///
118 /// Adds a key-value pair to `filters`.
119 ///
120 /// To override the contents of this collection use [`set_filters`](Self::set_filters).
121 ///
122 /// <p>(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include <code>status</code>, <code>sourceArn</code>, <code>destinationArn</code>, and <code>alias</code>.</p>
123 /// <p>Filters on the same key are <code>OR</code>'d together, and filters on different keys are <code>AND</code>'d together. For example, <code>status=ACTIVE&status=CREATING&alias=Test</code>, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</p>
124 /// <p>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:</p>
125 /// <p><code>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</code></p>
126 /// <p>If this is included, it filters the results to only the scrapers that match the filter.</p>
127 pub fn filters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: ::std::vec::Vec<::std::string::String>) -> Self {
128 self.inner = self.inner.filters(k.into(), v);
129 self
130 }
131 /// <p>(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include <code>status</code>, <code>sourceArn</code>, <code>destinationArn</code>, and <code>alias</code>.</p>
132 /// <p>Filters on the same key are <code>OR</code>'d together, and filters on different keys are <code>AND</code>'d together. For example, <code>status=ACTIVE&status=CREATING&alias=Test</code>, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</p>
133 /// <p>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:</p>
134 /// <p><code>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</code></p>
135 /// <p>If this is included, it filters the results to only the scrapers that match the filter.</p>
136 pub fn set_filters(
137 mut self,
138 input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>>,
139 ) -> Self {
140 self.inner = self.inner.set_filters(input);
141 self
142 }
143 /// <p>(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include <code>status</code>, <code>sourceArn</code>, <code>destinationArn</code>, and <code>alias</code>.</p>
144 /// <p>Filters on the same key are <code>OR</code>'d together, and filters on different keys are <code>AND</code>'d together. For example, <code>status=ACTIVE&status=CREATING&alias=Test</code>, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</p>
145 /// <p>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:</p>
146 /// <p><code>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</code></p>
147 /// <p>If this is included, it filters the results to only the scrapers that match the filter.</p>
148 pub fn get_filters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::vec::Vec<::std::string::String>>> {
149 self.inner.get_filters()
150 }
151 /// <p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>
152 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
153 self.inner = self.inner.next_token(input.into());
154 self
155 }
156 /// <p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>
157 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
158 self.inner = self.inner.set_next_token(input);
159 self
160 }
161 /// <p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>
162 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
163 self.inner.get_next_token()
164 }
165 /// <p>Optional) The maximum number of scrapers to return in one <code>ListScrapers</code> operation. The range is 1-1000.</p>
166 /// <p>If you omit this parameter, the default of 100 is used.</p>
167 pub fn max_results(mut self, input: i32) -> Self {
168 self.inner = self.inner.max_results(input);
169 self
170 }
171 /// <p>Optional) The maximum number of scrapers to return in one <code>ListScrapers</code> operation. The range is 1-1000.</p>
172 /// <p>If you omit this parameter, the default of 100 is used.</p>
173 pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
174 self.inner = self.inner.set_max_results(input);
175 self
176 }
177 /// <p>Optional) The maximum number of scrapers to return in one <code>ListScrapers</code> operation. The range is 1-1000.</p>
178 /// <p>If you omit this parameter, the default of 100 is used.</p>
179 pub fn get_max_results(&self) -> &::std::option::Option<i32> {
180 self.inner.get_max_results()
181 }
182}