Class: Aws::IoTSiteWise::Types::AssetModelProperty

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

Overview

Contains information about an asset model property.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_type ⇒ String

The data type of the asset model property.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property.

Returns:

  • (String) 


770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#data_type_spec ⇒ String

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

Returns:

  • (String) 


770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#external_id ⇒ String

The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel. However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

  • (String) 


770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the asset model property.

  • If you are callling UpdateAssetModel to create a new property: You can specify its ID here, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

  • If you are calling UpdateAssetModel to modify an existing property: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Returns:

  • (String) 


770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the asset model property.

Returns:

  • (String) 


770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ Array<Types::AssetModelPropertyPathSegment>

The structured path to the property from the root of the asset model.

Returns:



770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ Types::PropertyType

The property type (see PropertyType).

Returns:



770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The unit of the asset model property, such as Newtons or RPM.

Returns:

  • (String) 


770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 770

class AssetModelProperty < Struct.new(
  :id,
  :external_id,
  :name,
  :data_type,
  :data_type_spec,
  :unit,
  :type,
  :path)
  SENSITIVE = []
  include Aws::Structure
end