aws_sdk_codepipeline/operation/poll_for_jobs/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::poll_for_jobs::_poll_for_jobs_output::PollForJobsOutputBuilder;
3
4pub use crate::operation::poll_for_jobs::_poll_for_jobs_input::PollForJobsInputBuilder;
5
6impl crate::operation::poll_for_jobs::builders::PollForJobsInputBuilder {
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::poll_for_jobs::PollForJobsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::poll_for_jobs::PollForJobsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.poll_for_jobs();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PollForJobs`.
24///
25/// <p>Returns information about any jobs for CodePipeline to act on. <code>PollForJobs</code> is valid only for action types with "Custom" in the owner field. If the action type contains <code>AWS</code> or <code>ThirdParty</code> in the owner field, the <code>PollForJobs</code> action returns an error.</p><important>
26/// <p>When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.</p>
27/// </important>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct PollForJobsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::poll_for_jobs::builders::PollForJobsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::poll_for_jobs::PollForJobsOutput,
37        crate::operation::poll_for_jobs::PollForJobsError,
38    > for PollForJobsFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::poll_for_jobs::PollForJobsOutput,
46            crate::operation::poll_for_jobs::PollForJobsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl PollForJobsFluentBuilder {
53    /// Creates a new `PollForJobsFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the PollForJobs as a reference.
62    pub fn as_input(&self) -> &crate::operation::poll_for_jobs::builders::PollForJobsInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::poll_for_jobs::PollForJobsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::poll_for_jobs::PollForJobsError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::poll_for_jobs::PollForJobs::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::poll_for_jobs::PollForJobs::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::poll_for_jobs::PollForJobsOutput,
99        crate::operation::poll_for_jobs::PollForJobsError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>Represents information about an action type.</p>
114    pub fn action_type_id(mut self, input: crate::types::ActionTypeId) -> Self {
115        self.inner = self.inner.action_type_id(input);
116        self
117    }
118    /// <p>Represents information about an action type.</p>
119    pub fn set_action_type_id(mut self, input: ::std::option::Option<crate::types::ActionTypeId>) -> Self {
120        self.inner = self.inner.set_action_type_id(input);
121        self
122    }
123    /// <p>Represents information about an action type.</p>
124    pub fn get_action_type_id(&self) -> &::std::option::Option<crate::types::ActionTypeId> {
125        self.inner.get_action_type_id()
126    }
127    /// <p>The maximum number of jobs to return in a poll for jobs call.</p>
128    pub fn max_batch_size(mut self, input: i32) -> Self {
129        self.inner = self.inner.max_batch_size(input);
130        self
131    }
132    /// <p>The maximum number of jobs to return in a poll for jobs call.</p>
133    pub fn set_max_batch_size(mut self, input: ::std::option::Option<i32>) -> Self {
134        self.inner = self.inner.set_max_batch_size(input);
135        self
136    }
137    /// <p>The maximum number of jobs to return in a poll for jobs call.</p>
138    pub fn get_max_batch_size(&self) -> &::std::option::Option<i32> {
139        self.inner.get_max_batch_size()
140    }
141    ///
142    /// Adds a key-value pair to `queryParam`.
143    ///
144    /// To override the contents of this collection use [`set_query_param`](Self::set_query_param).
145    ///
146    /// <p>A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.</p>
147    pub fn query_param(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.inner = self.inner.query_param(k.into(), v.into());
149        self
150    }
151    /// <p>A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.</p>
152    pub fn set_query_param(
153        mut self,
154        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
155    ) -> Self {
156        self.inner = self.inner.set_query_param(input);
157        self
158    }
159    /// <p>A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.</p>
160    pub fn get_query_param(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
161        self.inner.get_query_param()
162    }
163}
aws_sdk_codepipeline/operation/poll_for_jobs/builders.rs

aws_sdk_codepipeline/operation/poll_for_jobs/
builders.rs
