Struct aws_sdk_iotthingsgraph::operation::upload_entity_definitions::builders::UploadEntityDefinitionsFluentBuilder
source ยท pub struct UploadEntityDefinitionsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UploadEntityDefinitions
.
Asynchronously uploads one or more entity definitions to the user's namespace. The document
parameter is required if syncWithPublicNamespace
and deleteExistingEntites
are false. If the syncWithPublicNamespace
parameter is set to true
, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities
is set to true, all entities in the latest version will be deleted before the new DefinitionDocument
is uploaded.
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 syncWithPublicNamespace
parameter or the deprecateExistingEntities
parameter to true
.
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.
Valid entities are Device
, DeviceModel
, Service
, Capability
, State
, Action
, Event
, Property
, Mapping
, Enum
.
Implementationsยง
sourceยงimpl UploadEntityDefinitionsFluentBuilder
impl UploadEntityDefinitionsFluentBuilder
sourcepub fn as_input(&self) -> &UploadEntityDefinitionsInputBuilder
pub fn as_input(&self) -> &UploadEntityDefinitionsInputBuilder
Access the UploadEntityDefinitions as a reference.
sourcepub async fn send(
self
) -> Result<UploadEntityDefinitionsOutput, SdkError<UploadEntityDefinitionsError, HttpResponse>>
pub async fn send( self ) -> Result<UploadEntityDefinitionsOutput, SdkError<UploadEntityDefinitionsError, HttpResponse>>
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, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<UploadEntityDefinitionsOutput, UploadEntityDefinitionsError, Self>
pub fn customize( self ) -> CustomizableOperation<UploadEntityDefinitionsOutput, UploadEntityDefinitionsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn document(self, input: DefinitionDocument) -> Self
pub fn document(self, input: DefinitionDocument) -> Self
The DefinitionDocument
that defines the updated entities.
sourcepub fn set_document(self, input: Option<DefinitionDocument>) -> Self
pub fn set_document(self, input: Option<DefinitionDocument>) -> Self
The DefinitionDocument
that defines the updated entities.
sourcepub fn get_document(&self) -> &Option<DefinitionDocument>
pub fn get_document(&self) -> &Option<DefinitionDocument>
The DefinitionDocument
that defines the updated entities.
sourcepub fn sync_with_public_namespace(self, input: bool) -> Self
pub fn sync_with_public_namespace(self, input: bool) -> Self
A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true
, the upload will create a new namespace version.
sourcepub fn set_sync_with_public_namespace(self, input: Option<bool>) -> Self
pub fn set_sync_with_public_namespace(self, input: Option<bool>) -> Self
A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true
, the upload will create a new namespace version.
sourcepub fn get_sync_with_public_namespace(&self) -> &Option<bool>
pub fn get_sync_with_public_namespace(&self) -> &Option<bool>
A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true
, the upload will create a new namespace version.
sourcepub fn deprecate_existing_entities(self, input: bool) -> Self
pub fn deprecate_existing_entities(self, input: bool) -> Self
A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument
. If set to true
, the upload will create a new namespace version.
sourcepub fn set_deprecate_existing_entities(self, input: Option<bool>) -> Self
pub fn set_deprecate_existing_entities(self, input: Option<bool>) -> Self
A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument
. If set to true
, the upload will create a new namespace version.
sourcepub fn get_deprecate_existing_entities(&self) -> &Option<bool>
pub fn get_deprecate_existing_entities(&self) -> &Option<bool>
A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument
. If set to true
, the upload will create a new namespace version.
Trait Implementationsยง
sourceยงimpl Clone for UploadEntityDefinitionsFluentBuilder
impl Clone for UploadEntityDefinitionsFluentBuilder
sourceยงfn clone(&self) -> UploadEntityDefinitionsFluentBuilder
fn clone(&self) -> UploadEntityDefinitionsFluentBuilder
1.0.0 ยท sourceยงfn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementationsยง
impl Freeze for UploadEntityDefinitionsFluentBuilder
impl !RefUnwindSafe for UploadEntityDefinitionsFluentBuilder
impl Send for UploadEntityDefinitionsFluentBuilder
impl Sync for UploadEntityDefinitionsFluentBuilder
impl Unpin for UploadEntityDefinitionsFluentBuilder
impl !UnwindSafe for UploadEntityDefinitionsFluentBuilder
Blanket Implementationsยง
sourceยงimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
sourceยงfn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceยงimpl<T> Instrument for T
impl<T> Instrument for T
sourceยงfn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourceยงfn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceยงimpl<T> IntoEither for T
impl<T> IntoEither for T
sourceยงfn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresourceยงfn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more