aws_sdk_xray/operation/list_retrieved_traces/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_retrieved_traces::_list_retrieved_traces_output::ListRetrievedTracesOutputBuilder;
3
4pub use crate::operation::list_retrieved_traces::_list_retrieved_traces_input::ListRetrievedTracesInputBuilder;
5
6impl crate::operation::list_retrieved_traces::builders::ListRetrievedTracesInputBuilder {
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_retrieved_traces::ListRetrievedTracesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_retrieved_traces::ListRetrievedTracesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_retrieved_traces();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListRetrievedTraces`.
24///
25/// <p>Retrieves a list of traces for a given <code>RetrievalToken</code> from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>.</p>
26/// <p>This API does not initiate a retrieval process. To start a trace retrieval, use <code>StartTraceRetrieval</code>, which generates the required <code>RetrievalToken</code>.</p>
27/// <p>When the <code>RetrievalStatus</code> is not <i>COMPLETE</i>, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.</p>
28/// <p>For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
29/// <p>For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>.</p>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct ListRetrievedTracesFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::list_retrieved_traces::builders::ListRetrievedTracesInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::list_retrieved_traces::ListRetrievedTracesOutput,
39        crate::operation::list_retrieved_traces::ListRetrievedTracesError,
40    > for ListRetrievedTracesFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::list_retrieved_traces::ListRetrievedTracesOutput,
48            crate::operation::list_retrieved_traces::ListRetrievedTracesError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl ListRetrievedTracesFluentBuilder {
55    /// Creates a new `ListRetrievedTracesFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the ListRetrievedTraces as a reference.
64    pub fn as_input(&self) -> &crate::operation::list_retrieved_traces::builders::ListRetrievedTracesInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::list_retrieved_traces::ListRetrievedTracesOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::list_retrieved_traces::ListRetrievedTracesError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::list_retrieved_traces::ListRetrievedTraces::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::list_retrieved_traces::ListRetrievedTraces::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::list_retrieved_traces::ListRetrievedTracesOutput,
101        crate::operation::list_retrieved_traces::ListRetrievedTracesError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>Retrieval token.</p>
116    pub fn retrieval_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.retrieval_token(input.into());
118        self
119    }
120    /// <p>Retrieval token.</p>
121    pub fn set_retrieval_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_retrieval_token(input);
123        self
124    }
125    /// <p>Retrieval token.</p>
126    pub fn get_retrieval_token(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_retrieval_token()
128    }
129    /// <p>Format of the requested traces.</p>
130    pub fn trace_format(mut self, input: crate::types::TraceFormatType) -> Self {
131        self.inner = self.inner.trace_format(input);
132        self
133    }
134    /// <p>Format of the requested traces.</p>
135    pub fn set_trace_format(mut self, input: ::std::option::Option<crate::types::TraceFormatType>) -> Self {
136        self.inner = self.inner.set_trace_format(input);
137        self
138    }
139    /// <p>Format of the requested traces.</p>
140    pub fn get_trace_format(&self) -> &::std::option::Option<crate::types::TraceFormatType> {
141        self.inner.get_trace_format()
142    }
143    /// <p>Specify the pagination token returned by a previous request to retrieve the next page of indexes.</p>
144    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
145        self.inner = self.inner.next_token(input.into());
146        self
147    }
148    /// <p>Specify the pagination token returned by a previous request to retrieve the next page of indexes.</p>
149    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
150        self.inner = self.inner.set_next_token(input);
151        self
152    }
153    /// <p>Specify the pagination token returned by a previous request to retrieve the next page of indexes.</p>
154    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
155        self.inner.get_next_token()
156    }
157}
aws_sdk_xray/operation/list_retrieved_traces/builders.rs

aws_sdk_xray/operation/list_retrieved_traces/
builders.rs
