Class: Aws::IoTTwinMaker::Types::GetComponentTypeResponse

Inherits:

Struct

Object
Struct
Aws::IoTTwinMaker::Types::GetComponentTypeResponse

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iottwinmaker/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The ARN of the component type.
#component_type_id ⇒ String

The ID of the component type.
#component_type_name ⇒ String

The component type name.
#composite_component_types ⇒ Hash<String,Types::CompositeComponentTypeResponse>

This is an object that maps strings to ‘compositeComponentTypes` of the `componentType`.
#creation_date_time ⇒ Time

The date and time when the component type was created.
#description ⇒ String

The description of the component type.
#extends_from ⇒ Array<String>

The name of the parent component type that this component type extends.
#functions ⇒ Hash<String,Types::FunctionResponse>

An object that maps strings to the functions in the component type.
#is_abstract ⇒ Boolean

A Boolean value that specifies whether the component type is abstract.
#is_schema_initialized ⇒ Boolean

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
#is_singleton ⇒ Boolean

A Boolean value that specifies whether an entity can have more than one component of this type.
#property_definitions ⇒ Hash<String,Types::PropertyDefinitionResponse>

An object that maps strings to the property definitions in the component type.
#property_groups ⇒ Hash<String,Types::PropertyGroupResponse>

The maximum number of results to return at one time.
#status ⇒ Types::Status

The current status of the component type.
#sync_source ⇒ String

The syncSource of the SyncJob, if this entity was created by a SyncJob.
#update_date_time ⇒ Time

The date and time when the component was last updated.
#workspace_id ⇒ String

The ID of the workspace that contains the component type.

Instance Attribute Details

#arn ⇒ `String`

The ARN of the component type.

Returns:

(String)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_id ⇒ `String`

The ID of the component type.

Returns:

(String)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_name ⇒ `String`

The component type name.

Returns:

(String)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#composite_component_types ⇒ `Hash<String,Types::CompositeComponentTypeResponse>`

This is an object that maps strings to ‘compositeComponentTypes` of the `componentType`. `CompositeComponentType` is referenced by `componentTypeId`.

Returns:

(Hash<String,Types::CompositeComponentTypeResponse>)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date_time ⇒ `Time`

The date and time when the component type was created.

Returns:

(Time)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the component type.

Returns:

(String)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#extends_from ⇒ `Array<String>`

The name of the parent component type that this component type extends.

Returns:

(Array<String>)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#functions ⇒ `Hash<String,Types::FunctionResponse>`

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

Returns:

(Hash<String,Types::FunctionResponse>)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#is_abstract ⇒ `Boolean`

A Boolean value that specifies whether the component type is abstract.

Returns:

(Boolean)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#is_schema_initialized ⇒ `Boolean`

A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

Returns:

(Boolean)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#is_singleton ⇒ `Boolean`

A Boolean value that specifies whether an entity can have more than one component of this type.

Returns:

(Boolean)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#property_definitions ⇒ `Hash<String,Types::PropertyDefinitionResponse>`

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

Returns:

(Hash<String,Types::PropertyDefinitionResponse>)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#property_groups ⇒ `Hash<String,Types::PropertyGroupResponse>`

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

Returns:

(Hash<String,Types::PropertyGroupResponse>)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `Types::Status`

The current status of the component type.

Returns:

(Types::Status)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#sync_source ⇒ `String`

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

Returns:

(String)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#update_date_time ⇒ `Time`

The date and time when the component was last updated.

Returns:

(Time)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_id ⇒ `String`

The ID of the workspace that contains the component type.

Returns:

(String)

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

class GetComponentTypeResponse < Struct.new(
  :workspace_id,
  :is_singleton,
  :component_type_id,
  :description,
  :property_definitions,
  :extends_from,
  :functions,
  :creation_date_time,
  :update_date_time,
  :arn,
  :is_abstract,
  :is_schema_initialized,
  :status,
  :property_groups,
  :sync_source,
  :component_type_name,
  :composite_component_types)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::IoTTwinMaker::Types::GetComponentTypeResponse

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#component_type_id ⇒ String

#component_type_name ⇒ String

#composite_component_types ⇒ Hash<String,Types::CompositeComponentTypeResponse>

#creation_date_time ⇒ Time

#description ⇒ String

#extends_from ⇒ Array<String>

#functions ⇒ Hash<String,Types::FunctionResponse>

#is_abstract ⇒ Boolean

#is_schema_initialized ⇒ Boolean

#is_singleton ⇒ Boolean

#property_definitions ⇒ Hash<String,Types::PropertyDefinitionResponse>

#property_groups ⇒ Hash<String,Types::PropertyGroupResponse>

#status ⇒ Types::Status

#sync_source ⇒ String

#update_date_time ⇒ Time

#workspace_id ⇒ String

#arn ⇒ `String`

#component_type_id ⇒ `String`

#component_type_name ⇒ `String`

#composite_component_types ⇒ `Hash<String,Types::CompositeComponentTypeResponse>`

#creation_date_time ⇒ `Time`

#description ⇒ `String`

#extends_from ⇒ `Array<String>`

#functions ⇒ `Hash<String,Types::FunctionResponse>`

#is_abstract ⇒ `Boolean`

#is_schema_initialized ⇒ `Boolean`

#is_singleton ⇒ `Boolean`

#property_definitions ⇒ `Hash<String,Types::PropertyDefinitionResponse>`

#property_groups ⇒ `Hash<String,Types::PropertyGroupResponse>`

#status ⇒ `Types::Status`

#sync_source ⇒ `String`

#update_date_time ⇒ `Time`

#workspace_id ⇒ `String`