Class: Aws::IoTTwinMaker::Types::ComponentResponse

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

Overview

An object that returns information about a component type create or update request.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#are_all_composite_components_returned ⇒ Boolean

This flag notes whether all ‘compositeComponents` are returned in the API response.

Returns:

  • (Boolean) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#are_all_properties_returned ⇒ Boolean

This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.

Returns:

  • (Boolean) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#component_name ⇒ String

The name of the component.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_id ⇒ String

The ID of the component type.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#composite_components ⇒ Hash<String,Types::ComponentSummary>

This lists objects that contain information about the ‘compositeComponents`.

Returns:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#defined_in ⇒ String

The name of the property definition set in the request.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the component type.

Returns:

  • (String) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#properties ⇒ Hash<String,Types::PropertyResponse>

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

Returns:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

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

The property groups.

Returns:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::Status

The status of the component type.

Returns:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_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) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 290

class ComponentResponse < Struct.new(
  :component_name,
  :description,
  :component_type_id,
  :status,
  :defined_in,
  :properties,
  :property_groups,
  :sync_source,
  :are_all_properties_returned,
  :composite_components,
  :are_all_composite_components_returned)
  SENSITIVE = []
  include Aws::Structure
end