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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_nameString

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

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_pathString

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

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_idString

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

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_idString

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

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_resultsInteger

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)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_tokenString

The string that specifies the next page of results.

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_nameString

The property group name.

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_propertiesArray<String>

The properties whose values the operation returns.

Returns:

  • (Array<String>)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_conditionsTypes::TabularConditions

The tabular conditions.



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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_idString

The ID of the workspace whose values the operation returns.

Returns:

  • (String)


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
# File '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