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_typeString

The data type of the asset model property.

Returns:

  • (String)


774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#data_type_specString

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

Returns:

  • (String)


774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#external_idString

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)


774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#idString

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)


774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#nameString

The name of the asset model property.

Returns:

  • (String)


774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#pathArray<Types::AssetModelPropertyPathSegment>

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



774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#typeTypes::PropertyType

The property type (see PropertyType).

Returns:



774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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

#unitString

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

Returns:

  • (String)


774
775
776
777
778
779
780
781
782
783
784
785
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 774

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