Class: Aws::IoTTwinMaker::Types::PropertyDefinitionRequest

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

Overview

An object that sets information about a property.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration ⇒ Hash<String,String>

A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.

Returns:

  • (Hash<String,String>) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ Types::DataType

An object that contains information about the data type.

Returns:



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#default_value ⇒ Types::DataValue

An object that contains the default value.

Returns:



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

A friendly name for the property.

Returns:

  • (String) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_external_id ⇒ Boolean

A Boolean value that specifies whether the property ID comes from an external data store.

Returns:

  • (Boolean) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_required_in_entity ⇒ Boolean

A Boolean value that specifies whether the property is required.

Returns:

  • (Boolean) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_stored_externally ⇒ Boolean

A Boolean value that specifies whether the property is stored externally.

Returns:

  • (Boolean) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end

#is_time_series ⇒ Boolean

A Boolean value that specifies whether the property consists of time series data.

Returns:

  • (Boolean) 


2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
 
# File 'lib/aws-sdk-iottwinmaker/types.rb', line 2173

class PropertyDefinitionRequest < Struct.new(
  :data_type,
  :is_required_in_entity,
  :is_external_id,
  :is_stored_externally,
  :is_time_series,
  :default_value,
  :configuration,
  :display_name)
  SENSITIVE = []
  include Aws::Structure
end