pub struct UploadEntityDefinitions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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
impl<C, M, R> UploadEntityDefinitions<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> UploadEntityDefinitions<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<UploadEntityDefinitionsOutput, SdkError<UploadEntityDefinitionsError>> where
R::Policy: SmithyRetryPolicy<UploadEntityDefinitionsInputOperationOutputAlias, UploadEntityDefinitionsOutput, UploadEntityDefinitionsError, UploadEntityDefinitionsInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<UploadEntityDefinitionsOutput, SdkError<UploadEntityDefinitionsError>> where
R::Policy: SmithyRetryPolicy<UploadEntityDefinitionsInputOperationOutputAlias, UploadEntityDefinitionsOutput, UploadEntityDefinitionsError, UploadEntityDefinitionsInputOperationRetryAlias>,
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.
The DefinitionDocument
that defines the updated entities.
The DefinitionDocument
that defines the updated entities.
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.
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.
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.
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
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for UploadEntityDefinitions<C, M, R>
impl<C, M, R> Send for UploadEntityDefinitions<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for UploadEntityDefinitions<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for UploadEntityDefinitions<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for UploadEntityDefinitions<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more