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

Inherits:

Struct

• Object
• Struct
• Aws::IoTTwinMaker::Types::PropertyDefinitionResponse

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

SENSITIVE =

[]

Instance Attribute Summary

• #configuration ⇒ Hash<String,String>

  A mapping that specifies configuration information about the property.

• #data_type ⇒ Types::DataType

  An object that contains information about the data type.

• #default_value ⇒ Types::DataValue

  An object that contains the default value.

• #display_name ⇒ String

  A friendly name for the property.

• #is_external_id ⇒ Boolean

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

• #is_final ⇒ Boolean

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

• #is_imported ⇒ Boolean

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

• #is_inherited ⇒ Boolean

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

• #is_required_in_entity ⇒ Boolean

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

• #is_stored_externally ⇒ Boolean

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

• #is_time_series ⇒ Boolean

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

Instance Attribute Details

#configuration ⇒ Hash<String,String>

A mapping that specifies configuration information about the property.

Returns:

• (Hash<String,String>)

# 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_type ⇒ Types::DataType

An object that contains information about the data type.

Returns:

• (Types::DataType)

# 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_value ⇒ Types::DataValue

An object that contains the default value.

Returns:

• (Types::DataValue)

# 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_name ⇒ String

A friendly name for the property.

Returns:

• (String)

# 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_id ⇒ Boolean

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

Returns:

• (Boolean)

# 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_final ⇒ Boolean

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

Returns:

• (Boolean)

# 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_imported ⇒ Boolean

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

Returns:

• (Boolean)

# 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_inherited ⇒ Boolean

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

Returns:

• (Boolean)

# 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_entity ⇒ Boolean

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

Returns:

• (Boolean)

# 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_externally ⇒ Boolean

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

Returns:

• (Boolean)

# 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_series ⇒ Boolean

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

Returns:

• (Boolean)

# 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