Class: Aws::IoTTwinMaker::Types::PropertyDefinitionResponse

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

Overview

An object that contains response data from a property definition request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configurationHash<String,String>

A mapping that specifies configuration information about the property.

Returns:

  • (Hash<String,String>)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#data_typeTypes::DataType

An object that contains information about the data type.

Returns:



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#default_valueTypes::DataValue

An object that contains the default value.

Returns:



2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#display_nameString

A friendly name for the property.

Returns:

  • (String)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_external_idBoolean

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

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_finalBoolean

A Boolean value that specifies whether the property definition can be updated.

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_importedBoolean

A Boolean value that specifies whether the property definition is imported from an external data store.

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_inheritedBoolean

A Boolean value that specifies whether the property definition is inherited from a parent entity.

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_required_in_entityBoolean

A Boolean value that specifies whether the property is required in an entity.

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_stored_externallyBoolean

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

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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

#is_time_seriesBoolean

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

Returns:

  • (Boolean)


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
# File 'gems/aws-sdk-iottwinmaker/lib/aws-sdk-iottwinmaker/types.rb', line 2216

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