Struct aws_sdk_iotthingsgraph::client::fluent_builders::UploadEntityDefinitions

pub struct UploadEntityDefinitions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

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, 

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.

pub fn document(self, input: DefinitionDocument) -> Self

The DefinitionDocument that defines the updated entities.

pub fn set_document(self, input: Option<DefinitionDocument>) -> Self

The DefinitionDocument that defines the updated entities.

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.

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.

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.

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.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for UploadEntityDefinitions<C, M, R>

fn clone(&self) -> UploadEntityDefinitions<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for UploadEntityDefinitions<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.