aws_sdk_cloudsearch/operation/describe_index_fields/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_index_fields::_describe_index_fields_output::DescribeIndexFieldsOutputBuilder;
3
4pub use crate::operation::describe_index_fields::_describe_index_fields_input::DescribeIndexFieldsInputBuilder;
5
6impl crate::operation::describe_index_fields::builders::DescribeIndexFieldsInputBuilder {
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::describe_index_fields::DescribeIndexFieldsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::describe_index_fields::DescribeIndexFieldsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.describe_index_fields();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DescribeIndexFields`.
24///
25/// <p>Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DescribeIndexFieldsFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::describe_index_fields::builders::DescribeIndexFieldsInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::describe_index_fields::DescribeIndexFieldsOutput,
35        crate::operation::describe_index_fields::DescribeIndexFieldsError,
36    > for DescribeIndexFieldsFluentBuilder
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::describe_index_fields::DescribeIndexFieldsOutput,
44            crate::operation::describe_index_fields::DescribeIndexFieldsError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DescribeIndexFieldsFluentBuilder {
51    /// Creates a new `DescribeIndexFieldsFluentBuilder`.
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 DescribeIndexFields as a reference.
60    pub fn as_input(&self) -> &crate::operation::describe_index_fields::builders::DescribeIndexFieldsInputBuilder {
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::describe_index_fields::DescribeIndexFieldsOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::describe_index_fields::DescribeIndexFieldsError,
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::describe_index_fields::DescribeIndexFields::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::describe_index_fields::DescribeIndexFields::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::describe_index_fields::DescribeIndexFieldsOutput,
97        crate::operation::describe_index_fields::DescribeIndexFieldsError,
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    /// <p>The name of the domain you want to describe.</p>
112    pub fn domain_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.domain_name(input.into());
114        self
115    }
116    /// <p>The name of the domain you want to describe.</p>
117    pub fn set_domain_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_domain_name(input);
119        self
120    }
121    /// <p>The name of the domain you want to describe.</p>
122    pub fn get_domain_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_domain_name()
124    }
125    ///
126    /// Appends an item to `FieldNames`.
127    ///
128    /// To override the contents of this collection use [`set_field_names`](Self::set_field_names).
129    ///
130    /// <p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>
131    pub fn field_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.field_names(input.into());
133        self
134    }
135    /// <p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>
136    pub fn set_field_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
137        self.inner = self.inner.set_field_names(input);
138        self
139    }
140    /// <p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>
141    pub fn get_field_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
142        self.inner.get_field_names()
143    }
144    /// <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
145    pub fn deployed(mut self, input: bool) -> Self {
146        self.inner = self.inner.deployed(input);
147        self
148    }
149    /// <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
150    pub fn set_deployed(mut self, input: ::std::option::Option<bool>) -> Self {
151        self.inner = self.inner.set_deployed(input);
152        self
153    }
154    /// <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
155    pub fn get_deployed(&self) -> &::std::option::Option<bool> {
156        self.inner.get_deployed()
157    }
158}