Struct aws_sdk_iottwinmaker::operation::get_entity::GetEntityOutput

#[non_exhaustive]
pub struct GetEntityOutput {

    pub entity_id: String,
    pub entity_name: String,
    pub arn: String,
    pub status: Option<Status>,
    pub workspace_id: String,
    pub description: Option<String>,
    pub components: Option<HashMap<String, ComponentResponse>>,
    pub parent_entity_id: String,
    pub has_child_entities: bool,
    pub creation_date_time: DateTime,
    pub update_date_time: DateTime,
    pub sync_source: Option<String>,
    pub are_all_components_returned: Option<bool>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

entity_id: String

The ID of the entity.

entity_name: String

The name of the entity.

arn: String

The ARN of the entity.

status: Option<Status>

The current status of the entity.

workspace_id: String

The ID of the workspace.

description: Option<String>

The description of the entity.

components: Option<HashMap<String, ComponentResponse>>

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

parent_entity_id: String

The ID of the parent entity for this entity.

has_child_entities: bool

A Boolean value that specifies whether the entity has associated child entities.

creation_date_time: DateTime

The date and time when the entity was created.

update_date_time: DateTime

The date and time when the entity was last updated.

sync_source: Option<String>

The syncSource of the sync job, if this entity was created by a sync job.

are_all_components_returned: Option<bool>

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

Implementations

impl GetEntityOutput

pub fn entity_id(&self) -> &str

The ID of the entity.

pub fn entity_name(&self) -> &str

The name of the entity.

pub fn arn(&self) -> &str

The ARN of the entity.

pub fn status(&self) -> Option<&Status>

The current status of the entity.

pub fn workspace_id(&self) -> &str

The ID of the workspace.

pub fn description(&self) -> Option<&str>

The description of the entity.

pub fn components(&self) -> Option<&HashMap<String, ComponentResponse>>

An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

pub fn parent_entity_id(&self) -> &str

The ID of the parent entity for this entity.

pub fn has_child_entities(&self) -> bool

A Boolean value that specifies whether the entity has associated child entities.

pub fn creation_date_time(&self) -> &DateTime

The date and time when the entity was created.

pub fn update_date_time(&self) -> &DateTime

The date and time when the entity was last updated.

pub fn sync_source(&self) -> Option<&str>

The syncSource of the sync job, if this entity was created by a sync job.

pub fn are_all_components_returned(&self) -> Option<bool>

This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.

impl GetEntityOutput

pub fn builder() -> GetEntityOutputBuilder

Creates a new builder-style object to manufacture GetEntityOutput.

Trait Implementations

impl Clone for GetEntityOutput

fn clone(&self) -> GetEntityOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetEntityOutput

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

Formats the value using the given formatter.

impl PartialEq for GetEntityOutput

fn eq(&self, other: &GetEntityOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetEntityOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetEntityOutput