aws_sdk_entityresolution/operation/generate_match_id/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::generate_match_id::_generate_match_id_output::GenerateMatchIdOutputBuilder;
3
4pub use crate::operation::generate_match_id::_generate_match_id_input::GenerateMatchIdInputBuilder;
5
6impl crate::operation::generate_match_id::builders::GenerateMatchIdInputBuilder {
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::generate_match_id::GenerateMatchIdOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::generate_match_id::GenerateMatchIdError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.generate_match_id();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GenerateMatchId`.
24///
25/// <p>Generates or retrieves Match IDs for records using a rule-based matching workflow. When you call this operation, it processes your records against the workflow's matching rules to identify potential matches. For existing records, it retrieves their Match IDs and associated rules. For records without matches, it generates new Match IDs. The operation saves results to Amazon S3.</p>
26/// <p>The processing type (<code>processingType</code>) you choose affects both the accuracy and response time of the operation. Additional charges apply for each API call, whether made through the Entity Resolution console or directly via the API. The rule-based matching workflow must exist and be active before calling this operation.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct GenerateMatchIdFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::generate_match_id::builders::GenerateMatchIdInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::generate_match_id::GenerateMatchIdOutput,
36 crate::operation::generate_match_id::GenerateMatchIdError,
37 > for GenerateMatchIdFluentBuilder
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::generate_match_id::GenerateMatchIdOutput,
45 crate::operation::generate_match_id::GenerateMatchIdError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl GenerateMatchIdFluentBuilder {
52 /// Creates a new `GenerateMatchIdFluentBuilder`.
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 GenerateMatchId as a reference.
61 pub fn as_input(&self) -> &crate::operation::generate_match_id::builders::GenerateMatchIdInputBuilder {
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::generate_match_id::GenerateMatchIdOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::generate_match_id::GenerateMatchIdError,
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::generate_match_id::GenerateMatchId::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::generate_match_id::GenerateMatchId::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::generate_match_id::GenerateMatchIdOutput,
98 crate::operation::generate_match_id::GenerateMatchIdError,
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 /// <p>The name of the rule-based matching workflow.</p>
113 pub fn workflow_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114 self.inner = self.inner.workflow_name(input.into());
115 self
116 }
117 /// <p>The name of the rule-based matching workflow.</p>
118 pub fn set_workflow_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119 self.inner = self.inner.set_workflow_name(input);
120 self
121 }
122 /// <p>The name of the rule-based matching workflow.</p>
123 pub fn get_workflow_name(&self) -> &::std::option::Option<::std::string::String> {
124 self.inner.get_workflow_name()
125 }
126 ///
127 /// Appends an item to `records`.
128 ///
129 /// To override the contents of this collection use [`set_records`](Self::set_records).
130 ///
131 /// <p>The records to match.</p>
132 pub fn records(mut self, input: crate::types::Record) -> Self {
133 self.inner = self.inner.records(input);
134 self
135 }
136 /// <p>The records to match.</p>
137 pub fn set_records(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Record>>) -> Self {
138 self.inner = self.inner.set_records(input);
139 self
140 }
141 /// <p>The records to match.</p>
142 pub fn get_records(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Record>> {
143 self.inner.get_records()
144 }
145 /// <p>The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results.</p>
146 /// <p>If not specified, defaults to <code>CONSISTENT</code>.</p>
147 /// <p><code>CONSISTENT</code>: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time.</p>
148 /// <p><code>EVENTUAL</code> (shown as <i>Background</i> in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, with complete matching results available later in S3.</p>
149 /// <p><code>EVENTUAL_NO_LOOKUP</code> (shown as <i>Quick ID generation</i> in the console): Generates new match IDs without checking existing matches, with updates processed asynchronously. Provides fastest response time but should only be used for records known to be unique.</p>
150 pub fn processing_type(mut self, input: crate::types::ProcessingType) -> Self {
151 self.inner = self.inner.processing_type(input);
152 self
153 }
154 /// <p>The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results.</p>
155 /// <p>If not specified, defaults to <code>CONSISTENT</code>.</p>
156 /// <p><code>CONSISTENT</code>: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time.</p>
157 /// <p><code>EVENTUAL</code> (shown as <i>Background</i> in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, with complete matching results available later in S3.</p>
158 /// <p><code>EVENTUAL_NO_LOOKUP</code> (shown as <i>Quick ID generation</i> in the console): Generates new match IDs without checking existing matches, with updates processed asynchronously. Provides fastest response time but should only be used for records known to be unique.</p>
159 pub fn set_processing_type(mut self, input: ::std::option::Option<crate::types::ProcessingType>) -> Self {
160 self.inner = self.inner.set_processing_type(input);
161 self
162 }
163 /// <p>The processing mode that determines how Match IDs are generated and results are saved. Each mode provides different levels of accuracy, response time, and completeness of results.</p>
164 /// <p>If not specified, defaults to <code>CONSISTENT</code>.</p>
165 /// <p><code>CONSISTENT</code>: Performs immediate lookup and matching against all existing records, with results saved synchronously. Provides highest accuracy but slower response time.</p>
166 /// <p><code>EVENTUAL</code> (shown as <i>Background</i> in the console): Performs initial match ID lookup or generation immediately, with record updates processed asynchronously in the background. Offers faster initial response time, with complete matching results available later in S3.</p>
167 /// <p><code>EVENTUAL_NO_LOOKUP</code> (shown as <i>Quick ID generation</i> in the console): Generates new match IDs without checking existing matches, with updates processed asynchronously. Provides fastest response time but should only be used for records known to be unique.</p>
168 pub fn get_processing_type(&self) -> &::std::option::Option<crate::types::ProcessingType> {
169 self.inner.get_processing_type()
170 }
171}