Class: Aws::IoTTwinMaker::Types::ListPropertiesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTTwinMaker::Types::ListPropertiesRequest

Defined in:

gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #component_name ⇒ String

  The name of the component whose properties are returned by the operation.

• #component_path ⇒ String

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

• #entity_id ⇒ String

  The ID for the entity whose metadata (component/properties) is returned by the operation.

• #max_results ⇒ Integer

  The maximum number of results returned at one time.

• #next_token ⇒ String

  The string that specifies the next page of results.

• #workspace_id ⇒ String

  The workspace ID.

Instance Attribute Details

#component_name ⇒ String

The name of the component whose properties are returned by the operation.

Returns:

• (String)

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

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#component_path ⇒ String

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

Returns:

• (String)

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

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

The ID for the entity whose metadata (component/properties) is returned by the operation.

Returns:

• (String)

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

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

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

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The string that specifies the next page of results.

Returns:

• (String)

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

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_id ⇒ String

The workspace ID.

Returns:

• (String)

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

class ListPropertiesRequest < Struct.new(
  :workspace_id,
  :component_name,
  :component_path,
  :entity_id,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end