aws_sdk_iotthingsgraph/operation/upload_entity_definitions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::upload_entity_definitions::_upload_entity_definitions_output::UploadEntityDefinitionsOutputBuilder;
3
4pub use crate::operation::upload_entity_definitions::_upload_entity_definitions_input::UploadEntityDefinitionsInputBuilder;
5
6impl crate::operation::upload_entity_definitions::builders::UploadEntityDefinitionsInputBuilder {
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::upload_entity_definitions::UploadEntityDefinitionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::upload_entity_definitions::UploadEntityDefinitionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.upload_entity_definitions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UploadEntityDefinitions`.
24///
25/// <p>Asynchronously uploads one or more entity definitions to the user's namespace. The <code>document</code> parameter is required if <code>syncWithPublicNamespace</code> and <code>deleteExistingEntites</code> are false. If the <code>syncWithPublicNamespace</code> parameter is set to <code>true</code>, the user's namespace will synchronize with the latest version of the public namespace. If <code>deprecateExistingEntities</code> is set to true, all entities in the latest version will be deleted before the new <code>DefinitionDocument</code> is uploaded.</p>
26/// <p>When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the <code>syncWithPublicNamespace</code> parameter or the <code>deprecateExistingEntities</code> parameter to <code>true</code>.</p>
27/// <p>The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.</p>
28/// <p>Valid entities are <code>Device</code>, <code>DeviceModel</code>, <code>Service</code>, <code>Capability</code>, <code>State</code>, <code>Action</code>, <code>Event</code>, <code>Property</code>, <code>Mapping</code>, <code>Enum</code>.</p>
29#[deprecated(note = "since: 2022-08-30")]
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct UploadEntityDefinitionsFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::upload_entity_definitions::builders::UploadEntityDefinitionsInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::upload_entity_definitions::UploadEntityDefinitionsOutput,
39        crate::operation::upload_entity_definitions::UploadEntityDefinitionsError,
40    > for UploadEntityDefinitionsFluentBuilder
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::upload_entity_definitions::UploadEntityDefinitionsOutput,
48            crate::operation::upload_entity_definitions::UploadEntityDefinitionsError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl UploadEntityDefinitionsFluentBuilder {
55    /// Creates a new `UploadEntityDefinitionsFluentBuilder`.
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 UploadEntityDefinitions as a reference.
64    pub fn as_input(&self) -> &crate::operation::upload_entity_definitions::builders::UploadEntityDefinitionsInputBuilder {
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::upload_entity_definitions::UploadEntityDefinitionsOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::upload_entity_definitions::UploadEntityDefinitionsError,
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::upload_entity_definitions::UploadEntityDefinitions::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::upload_entity_definitions::UploadEntityDefinitions::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::upload_entity_definitions::UploadEntityDefinitionsOutput,
101        crate::operation::upload_entity_definitions::UploadEntityDefinitionsError,
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>The <code>DefinitionDocument</code> that defines the updated entities.</p>
116    pub fn document(mut self, input: crate::types::DefinitionDocument) -> Self {
117        self.inner = self.inner.document(input);
118        self
119    }
120    /// <p>The <code>DefinitionDocument</code> that defines the updated entities.</p>
121    pub fn set_document(mut self, input: ::std::option::Option<crate::types::DefinitionDocument>) -> Self {
122        self.inner = self.inner.set_document(input);
123        self
124    }
125    /// <p>The <code>DefinitionDocument</code> that defines the updated entities.</p>
126    pub fn get_document(&self) -> &::std::option::Option<crate::types::DefinitionDocument> {
127        self.inner.get_document()
128    }
129    /// <p>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</p>
130    pub fn sync_with_public_namespace(mut self, input: bool) -> Self {
131        self.inner = self.inner.sync_with_public_namespace(input);
132        self
133    }
134    /// <p>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</p>
135    pub fn set_sync_with_public_namespace(mut self, input: ::std::option::Option<bool>) -> Self {
136        self.inner = self.inner.set_sync_with_public_namespace(input);
137        self
138    }
139    /// <p>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</p>
140    pub fn get_sync_with_public_namespace(&self) -> &::std::option::Option<bool> {
141        self.inner.get_sync_with_public_namespace()
142    }
143    /// <p>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>. If set to <code>true</code>, the upload will create a new namespace version.</p>
144    pub fn deprecate_existing_entities(mut self, input: bool) -> Self {
145        self.inner = self.inner.deprecate_existing_entities(input);
146        self
147    }
148    /// <p>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>. If set to <code>true</code>, the upload will create a new namespace version.</p>
149    pub fn set_deprecate_existing_entities(mut self, input: ::std::option::Option<bool>) -> Self {
150        self.inner = self.inner.set_deprecate_existing_entities(input);
151        self
152    }
153    /// <p>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>. If set to <code>true</code>, the upload will create a new namespace version.</p>
154    pub fn get_deprecate_existing_entities(&self) -> &::std::option::Option<bool> {
155        self.inner.get_deprecate_existing_entities()
156    }
157}
aws_sdk_iotthingsgraph/operation/upload_entity_definitions/builders.rs

aws_sdk_iotthingsgraph/operation/upload_entity_definitions/
builders.rs
