aws_sdk_xray/operation/start_trace_retrieval/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::start_trace_retrieval::_start_trace_retrieval_output::StartTraceRetrievalOutputBuilder;
3
4pub use crate::operation::start_trace_retrieval::_start_trace_retrieval_input::StartTraceRetrievalInputBuilder;
5
6impl crate::operation::start_trace_retrieval::builders::StartTraceRetrievalInputBuilder {
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::start_trace_retrieval::StartTraceRetrievalOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::start_trace_retrieval::StartTraceRetrievalError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.start_trace_retrieval();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StartTraceRetrieval`.
24///
25/// <p>Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>.</p>
26/// <p>API returns a <code>RetrievalToken</code>, which can be used with <code>ListRetrievedTraces</code> or <code>GetRetrievedTracesGraph</code> to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.</p>
27/// <p>If you are using <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.</p>
28/// <p>For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see <a href="https://docs.aws.amazon.com/xray/latest/api/API_BatchGetTraces.html">BatchGetTraces</a>.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct StartTraceRetrievalFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::start_trace_retrieval::builders::StartTraceRetrievalInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::start_trace_retrieval::StartTraceRetrievalOutput,
38        crate::operation::start_trace_retrieval::StartTraceRetrievalError,
39    > for StartTraceRetrievalFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::start_trace_retrieval::StartTraceRetrievalOutput,
47            crate::operation::start_trace_retrieval::StartTraceRetrievalError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl StartTraceRetrievalFluentBuilder {
54    /// Creates a new `StartTraceRetrievalFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the StartTraceRetrieval as a reference.
63    pub fn as_input(&self) -> &crate::operation::start_trace_retrieval::builders::StartTraceRetrievalInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::start_trace_retrieval::StartTraceRetrievalOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::start_trace_retrieval::StartTraceRetrievalError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::start_trace_retrieval::StartTraceRetrieval::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::start_trace_retrieval::StartTraceRetrieval::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::start_trace_retrieval::StartTraceRetrievalOutput,
100        crate::operation::start_trace_retrieval::StartTraceRetrievalError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    ///
115    /// Appends an item to `TraceIds`.
116    ///
117    /// To override the contents of this collection use [`set_trace_ids`](Self::set_trace_ids).
118    ///
119    /// <p>Specify the trace IDs of the traces to be retrieved.</p>
120    pub fn trace_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.trace_ids(input.into());
122        self
123    }
124    /// <p>Specify the trace IDs of the traces to be retrieved.</p>
125    pub fn set_trace_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
126        self.inner = self.inner.set_trace_ids(input);
127        self
128    }
129    /// <p>Specify the trace IDs of the traces to be retrieved.</p>
130    pub fn get_trace_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
131        self.inner.get_trace_ids()
132    }
133    /// <p>The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
134    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
135        self.inner = self.inner.start_time(input);
136        self
137    }
138    /// <p>The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
139    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
140        self.inner = self.inner.set_start_time(input);
141        self
142    }
143    /// <p>The start of the time range to retrieve traces. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
144    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
145        self.inner.get_start_time()
146    }
147    /// <p>The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
148    pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
149        self.inner = self.inner.end_time(input);
150        self
151    }
152    /// <p>The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
153    pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
154        self.inner = self.inner.set_end_time(input);
155        self
156    }
157    /// <p>The end of the time range to retrieve traces. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.</p>
158    pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
159        self.inner.get_end_time()
160    }
161}
aws_sdk_xray/operation/start_trace_retrieval/builders.rs

aws_sdk_xray/operation/start_trace_retrieval/
builders.rs
