Interface GatewayCapabilitySummary.Builder

  • Method Details

    • capabilityNamespace

      GatewayCapabilitySummary.Builder capabilityNamespace(String capabilityNamespace)

      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.

      Parameters:
      capabilityNamespace - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • capabilitySyncStatus

      GatewayCapabilitySummary.Builder capabilitySyncStatus(String capabilitySyncStatus)

      The synchronization status of the gateway capability configuration. The sync status can be one of the following:

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Parameters:
      capabilitySyncStatus - The synchronization status of the gateway capability configuration. The sync status can be one of the following:

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • capabilitySyncStatus

      GatewayCapabilitySummary.Builder capabilitySyncStatus(CapabilitySyncStatus capabilitySyncStatus)

      The synchronization status of the gateway capability configuration. The sync status can be one of the following:

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Parameters:
      capabilitySyncStatus - The synchronization status of the gateway capability configuration. The sync status can be one of the following:

      • IN_SYNC - The gateway is running with the latest configuration.

      • OUT_OF_SYNC - The gateway hasn't received the latest configuration.

      • SYNC_FAILED - The gateway rejected the latest configuration.

      • UNKNOWN - The gateway hasn't reported its sync status.

      • NOT_APPLICABLE - The gateway doesn't support this capability. This is most common when integrating partner data sources, because the data integration is handled externally by the partner.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: