aws_sdk_codegurusecurity/operation/create_scan/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_scan::_create_scan_output::CreateScanOutputBuilder;
3
4pub use crate::operation::create_scan::_create_scan_input::CreateScanInputBuilder;
5
6impl crate::operation::create_scan::builders::CreateScanInputBuilder {
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::create_scan::CreateScanOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::create_scan::CreateScanError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.create_scan();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `CreateScan`.
24///
25/// <p>Use to create a scan using code uploaded to an Amazon S3 bucket.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateScanFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::create_scan::builders::CreateScanInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::create_scan::CreateScanOutput,
35 crate::operation::create_scan::CreateScanError,
36 > for CreateScanFluentBuilder
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::create_scan::CreateScanOutput,
44 crate::operation::create_scan::CreateScanError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl CreateScanFluentBuilder {
51 /// Creates a new `CreateScanFluentBuilder`.
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 CreateScan as a reference.
60 pub fn as_input(&self) -> &crate::operation::create_scan::builders::CreateScanInputBuilder {
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::create_scan::CreateScanOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::create_scan::CreateScanError,
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::create_scan::CreateScan::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::create_scan::CreateScan::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::create_scan::CreateScanOutput,
97 crate::operation::create_scan::CreateScanError,
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 idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
112 pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.client_token(input.into());
114 self
115 }
116 /// <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
117 pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_client_token(input);
119 self
120 }
121 /// <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
122 pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_client_token()
124 }
125 /// <p>The identifier for the resource object to be scanned.</p>
126 pub fn resource_id(mut self, input: crate::types::ResourceId) -> Self {
127 self.inner = self.inner.resource_id(input);
128 self
129 }
130 /// <p>The identifier for the resource object to be scanned.</p>
131 pub fn set_resource_id(mut self, input: ::std::option::Option<crate::types::ResourceId>) -> Self {
132 self.inner = self.inner.set_resource_id(input);
133 self
134 }
135 /// <p>The identifier for the resource object to be scanned.</p>
136 pub fn get_resource_id(&self) -> &::std::option::Option<crate::types::ResourceId> {
137 self.inner.get_resource_id()
138 }
139 /// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
140 pub fn scan_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141 self.inner = self.inner.scan_name(input.into());
142 self
143 }
144 /// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
145 pub fn set_scan_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146 self.inner = self.inner.set_scan_name(input);
147 self
148 }
149 /// <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type.</p>
150 pub fn get_scan_name(&self) -> &::std::option::Option<::std::string::String> {
151 self.inner.get_scan_name()
152 }
153 /// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
154 /// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
155 pub fn scan_type(mut self, input: crate::types::ScanType) -> Self {
156 self.inner = self.inner.scan_type(input);
157 self
158 }
159 /// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
160 /// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
161 pub fn set_scan_type(mut self, input: ::std::option::Option<crate::types::ScanType>) -> Self {
162 self.inner = self.inner.set_scan_type(input);
163 self
164 }
165 /// <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p>
166 /// <p><code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
167 pub fn get_scan_type(&self) -> &::std::option::Option<crate::types::ScanType> {
168 self.inner.get_scan_type()
169 }
170 /// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
171 pub fn analysis_type(mut self, input: crate::types::AnalysisType) -> Self {
172 self.inner = self.inner.analysis_type(input);
173 self
174 }
175 /// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
176 pub fn set_analysis_type(mut self, input: ::std::option::Option<crate::types::AnalysisType>) -> Self {
177 self.inner = self.inner.set_analysis_type(input);
178 self
179 }
180 /// <p>The type of analysis you want CodeGuru Security to perform in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings. Defaults to <code>Security</code> type if missing.</p>
181 pub fn get_analysis_type(&self) -> &::std::option::Option<crate::types::AnalysisType> {
182 self.inner.get_analysis_type()
183 }
184 ///
185 /// Adds a key-value pair to `tags`.
186 ///
187 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
188 ///
189 /// <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
190 /// <ul>
191 /// <li>
192 /// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
193 /// <li>
194 /// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
195 /// </ul>
196 pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
197 self.inner = self.inner.tags(k.into(), v.into());
198 self
199 }
200 /// <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
201 /// <ul>
202 /// <li>
203 /// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
204 /// <li>
205 /// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
206 /// </ul>
207 pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
208 self.inner = self.inner.set_tags(input);
209 self
210 }
211 /// <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p>
212 /// <ul>
213 /// <li>
214 /// <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p></li>
215 /// <li>
216 /// <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p></li>
217 /// </ul>
218 pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
219 self.inner.get_tags()
220 }
221}