Struct aws_sdk_iotthingsgraph::client::fluent_builders::GetEntities

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

Fluent builder constructing a request to GetEntities.

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

• Properties

• States

• Events

• Actions

• Capabilities

• Mappings

• Devices

• Device Models

• Services

This action doesn't return definitions for systems, flows, and deployments.

Implementations

impl<C, M, R> GetEntities<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<GetEntitiesOutput, SdkError<GetEntitiesError>> where
    R::Policy: SmithyRetryPolicy<GetEntitiesInputOperationOutputAlias, GetEntitiesOutput, GetEntitiesError, GetEntitiesInputOperationRetryAlias>, 

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 ids(self, input: impl Into<String>) -> Self

Appends an item to ids.

To override the contents of this collection use set_ids.

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

pub fn set_ids(self, input: Option<Vec<String>>) -> Self

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

pub fn namespace_version(self, input: i64) -> Self

The version of the user's namespace. Defaults to the latest version of the user's namespace.

pub fn set_namespace_version(self, input: Option<i64>) -> Self

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Trait Implementations

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

fn clone(&self) -> GetEntities<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 GetEntities<C, M, R>

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

Formats the value using the given formatter.