aws-sdk-greengrassv2 1.112.0

AWS SDK for AWS IoT Greengrass V2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::resolve_component_candidates::_resolve_component_candidates_input::ResolveComponentCandidatesInputBuilder;

pub use crate::operation::resolve_component_candidates::_resolve_component_candidates_output::ResolveComponentCandidatesOutputBuilder;

impl crate::operation::resolve_component_candidates::builders::ResolveComponentCandidatesInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::resolve_component_candidates::ResolveComponentCandidatesOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::resolve_component_candidates::ResolveComponentCandidatesError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.resolve_component_candidates();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `ResolveComponentCandidates`.
///
/// <p>Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.</p>
/// <p>This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component <code>A</code> requires version <code>&gt;2.0.0</code> and component <code>B</code> requires version <code>&lt;2.0.0</code> of a component dependency.</p>
/// <p>When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.</p><important>
/// <p>To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/greengrass.html">IoT Greengrass endpoints and quotas</a>.</p>
/// </important>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ResolveComponentCandidatesFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::resolve_component_candidates::builders::ResolveComponentCandidatesInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::resolve_component_candidates::ResolveComponentCandidatesOutput,
        crate::operation::resolve_component_candidates::ResolveComponentCandidatesError,
    > for ResolveComponentCandidatesFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::resolve_component_candidates::ResolveComponentCandidatesOutput,
            crate::operation::resolve_component_candidates::ResolveComponentCandidatesError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl ResolveComponentCandidatesFluentBuilder {
    /// Creates a new `ResolveComponentCandidatesFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the ResolveComponentCandidates as a reference.
    pub fn as_input(&self) -> &crate::operation::resolve_component_candidates::builders::ResolveComponentCandidatesInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::resolve_component_candidates::ResolveComponentCandidatesOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::resolve_component_candidates::ResolveComponentCandidatesError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::resolve_component_candidates::ResolveComponentCandidates::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::resolve_component_candidates::ResolveComponentCandidates::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::resolve_component_candidates::ResolveComponentCandidatesOutput,
        crate::operation::resolve_component_candidates::ResolveComponentCandidatesError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The platform to use to resolve compatible components.</p>
    pub fn platform(mut self, input: crate::types::ComponentPlatform) -> Self {
        self.inner = self.inner.platform(input);
        self
    }
    /// <p>The platform to use to resolve compatible components.</p>
    pub fn set_platform(mut self, input: ::std::option::Option<crate::types::ComponentPlatform>) -> Self {
        self.inner = self.inner.set_platform(input);
        self
    }
    /// <p>The platform to use to resolve compatible components.</p>
    pub fn get_platform(&self) -> &::std::option::Option<crate::types::ComponentPlatform> {
        self.inner.get_platform()
    }
    ///
    /// Appends an item to `componentCandidates`.
    ///
    /// To override the contents of this collection use [`set_component_candidates`](Self::set_component_candidates).
    ///
    /// <p>The list of components to resolve.</p>
    pub fn component_candidates(mut self, input: crate::types::ComponentCandidate) -> Self {
        self.inner = self.inner.component_candidates(input);
        self
    }
    /// <p>The list of components to resolve.</p>
    pub fn set_component_candidates(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ComponentCandidate>>) -> Self {
        self.inner = self.inner.set_component_candidates(input);
        self
    }
    /// <p>The list of components to resolve.</p>
    pub fn get_component_candidates(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ComponentCandidate>> {
        self.inner.get_component_candidates()
    }
}