Class: Aws::IoTTwinMaker::Types::GetEntityResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTTwinMaker::Types::GetEntityResponse

Includes:

Structure

Defined in:

lib/aws-sdk-iottwinmaker/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #are_all_components_returned ⇒ Boolean

  This flag notes whether all components are returned in the API response.

• #arn ⇒ String

  The ARN of the entity.

• #components ⇒ Hash<String,Types::ComponentResponse>

  An object that maps strings to the components in the entity.

• #creation_date_time ⇒ Time

  The date and time when the entity was created.

• #description ⇒ String

  The description of the entity.

• #entity_id ⇒ String

  The ID of the entity.

• #entity_name ⇒ String

  The name of the entity.

• #has_child_entities ⇒ Boolean

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

• #parent_entity_id ⇒ String

  The ID of the parent entity for this entity.

• #status ⇒ Types::Status

  The current status of the entity.

• #sync_source ⇒ String

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

• #update_date_time ⇒ Time

  The date and time when the entity was last updated.

• #workspace_id ⇒ String

  The ID of the workspace.

Instance Attribute Details

#are_all_components_returned ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The ARN of the entity.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#components ⇒ Hash<String,Types::ComponentResponse>

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

Returns:

• (Hash<String,Types::ComponentResponse>)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ Time

The date and time when the entity was created.

Returns:

• (Time)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the entity.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

The ID of the entity.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#entity_name ⇒ String

The name of the entity.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#has_child_entities ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#parent_entity_id ⇒ String

The ID of the parent entity for this entity.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::Status

The current status of the entity.

Returns:

• (Types::Status)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#sync_source ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#update_date_time ⇒ Time

The date and time when the entity was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_id ⇒ String

The ID of the workspace.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1629

class GetEntityResponse < Struct.new(
  :entity_id,
  :entity_name,
  :arn,
  :status,
  :workspace_id,
  :description,
  :components,
  :parent_entity_id,
  :has_child_entities,
  :creation_date_time,
  :update_date_time,
  :sync_source,
  :are_all_components_returned)
  SENSITIVE = []
  include Aws::Structure
end