Module Values.AssetModelPropertySource

Contains information about an asset model property.

Sourcetype nonrec t = {
  1. id : CustomID.t option;
    (*

    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.

    *)
  2. externalId : ExternalId.t option;
    (*

    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.

    *)
  3. name : Name.t;
    (*

    The name of the asset model property.

    *)
  4. dataType : PropertyDataType.t;
    (*

    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.

    *)
  5. dataTypeSpec : Name.t option;
    (*

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

    *)
  6. unit : PropertyUnit.t option;
    (*

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

    *)
  7. type_ : PropertyType.t;
    (*

    The property type (see PropertyType).

    *)
  8. path : AssetModelPropertyPath.t option;
    (*

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

    *)
}
Sourceval context_ : string
Sourceval make : ?id:??? -> ?externalId:??? -> ?dataTypeSpec:??? -> ?unit:??? -> ?path:??? -> name:Name.t -> dataType:PropertyDataType.t -> type_:PropertyType.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of ID.t ]) list ] list | `String of CustomID.t | `Structure of (string * [> `Structure of (string * [> `List of [> `Structure of (string * [> `String of VariableName.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of ID.t ]) list ] list | `String of Macro.t ]) list ]) list ] list | `String of DefaultValue.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of Interval.t ]) list ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t