Class: Aws::IoTTwinMaker::Types::GetPropertyValueRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTTwinMaker::Types::GetPropertyValueRequest

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 property values the operation returns.

• #component_path ⇒ String

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

• #component_type_id ⇒ String

  The ID of the component type whose property values the operation returns.

• #entity_id ⇒ String

  The ID of the entity whose property values the operation returns.

• #max_results ⇒ Integer

  The maximum number of results to return at one time.

• #next_token ⇒ String

  The string that specifies the next page of results.

• #property_group_name ⇒ String

  The property group name.

• #selected_properties ⇒ Array<String>

  The properties whose values the operation returns.

• #tabular_conditions ⇒ Types::TabularConditions

  The tabular conditions.

• #workspace_id ⇒ String

  The ID of the workspace whose values the operation returns.

Instance Attribute Details

#component_name ⇒ String

The name of the component whose property values the operation returns.

Returns:

• (String)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  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 1898

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_id ⇒ String

The ID of the component type whose property values the operation returns.

Returns:

• (String)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

The ID of the entity whose property values the operation returns.

Returns:

• (String)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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:

• (Integer)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  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 1898

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#property_group_name ⇒ String

The property group name.

Returns:

• (String)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#selected_properties ⇒ Array<String>

The properties whose values the operation returns.

Returns:

• (Array<String>)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#tabular_conditions ⇒ Types::TabularConditions

The tabular conditions.

Returns:

• (Types::TabularConditions)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_id ⇒ String

The ID of the workspace whose values the operation returns.

Returns:

• (String)

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

class GetPropertyValueRequest < Struct.new(
  :component_name,
  :component_path,
  :component_type_id,
  :entity_id,
  :selected_properties,
  :workspace_id,
  :max_results,
  :next_token,
  :property_group_name,
  :tabular_conditions)
  SENSITIVE = []
  include Aws::Structure
end