Up – Package index » awso » Library awso.iotsitewise » Awso_iotsitewise » Values » DescribeGatewayCapabilityConfigurationRequest

Module `Values.DescribeGatewayCapabilityConfigurationRequest`Source

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability. . The namespace follows the format service:capability:version, where: service - The service providing the capability, or iotsitewise. capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability. version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways. After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied. A gateway can have multiple capability configurations with different namespaces.

Sourcetype nonrec t = {

gatewayId : ID.t;
(*
The ID of the gateway that defines the capability configuration.
*)
capabilityNamespace : CapabilityNamespace.t;
(*
The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.
*)

}

Sourceval context_ : string

Source

val make : 
  gatewayId:ID.t ->
  capabilityNamespace:CapabilityNamespace.t ->
  unit ->
  t

Sourceval to_value : t -> [> `Structure of (string * [> `String of ID.t ]) 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