Class: Aws::IoTTwinMaker::Types::ComponentSummary

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iottwinmaker/types.rb

Overview

An object that returns information about a component summary.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_nameString

The name of the component.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#component_pathString

This string specifies the path to the composite component, starting from the top-level component.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_idString

The ID of the component type.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#defined_inString

The name of the property definition set in the request.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the component request.

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#property_groupsHash<String,Types::ComponentPropertyGroupResponse>

The property groups.

Returns:



342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::Status

The status of the component type.

Returns:



342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end

#sync_sourceString

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

Returns:

  • (String)


342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 342

class ComponentSummary < Struct.new(
  :component_name,
  :component_type_id,
  :defined_in,
  :description,
  :property_groups,
  :status,
  :sync_source,
  :component_path)
  SENSITIVE = []
  include Aws::Structure
end