Class: Aws::IoTTwinMaker::Types::GetPropertyValueHistoryRequest

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

Overview

Note:

When making an API call, you may pass GetPropertyValueHistoryRequest data as a hash:

{
  component_name: "Name",
  component_type_id: "ComponentTypeId",
  end_date_time: Time.now,
  end_time: "Time",
  entity_id: "EntityId",
  interpolation: {
    interpolation_type: "LINEAR", # accepts LINEAR
    interval_in_seconds: 1,
  },
  max_results: 1,
  next_token: "NextToken",
  order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING
  property_filters: [
    {
      operator: "String",
      property_name: "String",
      value: {
        boolean_value: false,
        double_value: 1.0,
        expression: "Expression",
        integer_value: 1,
        list_value: [
          {
            # recursive DataValue
          },
        ],
        long_value: 1,
        map_value: {
          "String" => {
            # recursive DataValue
          },
        },
        relationship_value: {
          target_component_name: "Name",
          target_entity_id: "EntityId",
        },
        string_value: "String",
      },
    },
  ],
  selected_properties: ["String"], # required
  start_date_time: Time.now,
  start_time: "Time",
  workspace_id: "Id", # required
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#component_name ⇒ String

The name of the component.

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#component_type_id ⇒ String

The ID of the component type.

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#end_date_time ⇒ Time

The date and time of the latest property value to return.

Returns:

  • (Time) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ String

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type [PropertyValue].

[1]: docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#entity_id ⇒ String

The ID of the entity.

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#interpolation ⇒ Types::InterpolationParameters

An object that specifies the interpolation type and the interval over which to interpolate data.

Returns:



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return.

Returns:

  • (Integer) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The string that specifies the next page of results.

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#order_by_time ⇒ String

The time direction to use in the result order.

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#property_filters ⇒ Array<Types::PropertyFilter>

A list of objects that filter the property value history request.

Returns:



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#selected_properties ⇒ Array<String>

A list of properties whose value histories the request retrieves.

Returns:

  • (Array<String>) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_date_time ⇒ Time

The date and time of the earliest property value to return.

Returns:

  • (Time) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ String

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type [PropertyValue].

[1]: docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_id ⇒ String

The ID of the workspace.

Returns:

  • (String) 


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 1794

class GetPropertyValueHistoryRequest < Struct.new(
  :component_name,
  :component_type_id,
  :end_date_time,
  :end_time,
  :entity_id,
  :interpolation,
  :max_results,
  :next_token,
  :order_by_time,
  :property_filters,
  :selected_properties,
  :start_date_time,
  :start_time,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end