遠端物件服務
以下是可與「遠端物件」搭配使用的服務清單。
服務
描述
EvaluateReporting
此服務會根據策略評估物件的報告狀況。
以下是適用於服務的輸入參數:
eventName:事件的名稱
eventTime:觸發事件的時間
source:觸發事件的物件名稱
sourceProperty:來源內容 eventData
執行此服務後,不會收到輸出。
GetEventSubscriptions
取得繫結至遠端「物件」的事件。
此服務不需要輸入。
執行此服務會以「資料負載」的形式傳回「遠端物件」的訂閱事件。
執行此服務後,會收到下列參數:
Data Shape:EdgeThingEventNotification
Infotable Type:僅限資料負載
GetPropertySubscriptions
取得內容加上 Edge 物件的資料變更類型與資料變更臨界值。
以下是適用於服務的輸入參數:
options:呼叫 SDK 所支援的繫結選項
執行此服務會以「資料負載」的形式傳回「遠端物件」的訂閱內容。
執行此服務後,會收到下列參數:
Data Shape:EdgeThingEventNotification
Infotable Type:僅限資料負載
GetQueuedTasks
擷取此連線「物件」的任何任務。
此服務不需要輸入。
執行此服務會以「資料負載」的形式傳回 Edge 物件。
執行此服務後,會收到下列參數:
Data Shape:MessageStoreList
Infotable Type:僅限資料負載
GetRemoteMetadata
傳回連線物件的中繼資料。
此服務不需要輸入。
執行此服務會傳回 JSON 格式的「連線物件」中繼資料。
GetReportingStrategy
擷取此物件的報告策略。
此服務不需要輸入。
執行此服務會傳回 STRING 格式的「連線物件」中繼資料。
Invoke
以下是適用於服務的輸入參數:
endpointUri
paramsTable
headerParams
resultType
執行此服務會以「資料負載」的形式傳回輸出。
ProcessRemoteEvents
處理遠端事件。
以下是適用於服務的輸入參數:
values
執行此服務後,不會收到輸出。
ReceiveRouteLifecycleEvent
以下是適用於服務的輸入參數:
eventPayload
執行此服務後,不會收到輸出。
RegisterRoute
以下是適用於服務的輸入參數:
routeXml
執行此服務後,不會收到輸出。
SendMaxQueuedTasks
將最多為特定最大數量的排入佇列任務傳送至連線物件。
以下是適用於服務的輸入參數:
maxCount:Edge 裝置需要的最大訊息數。
執行此服務會以 INTEGER 格式傳回已傳送的排入佇列任務數,最多為 maxCount。
SendQueuedTasks
將任何排入佇列的任務傳送至連線物件。
此服務不需要輸入。
執行此服務後,不會收到輸出。
SetReportingStrategy
設定此物件的報告策略。
以下是適用於服務的輸入參數:
strategyThing:策略物件的名稱。
執行此服務後,不會收到輸出。
UpdateSubscribedPropertyValues
針對連線「物件」寫入已訂閱的內容值。
以下是適用於服務的輸入參數:
values
執行此服務後,不會收到輸出。
values 參數是包含多列的資料負載,其中每列都包含內容名稱、值與品質,並隨附更新時間戳記。內容值不得設定為 null。
依預設,會分別針對每個內容執行值更新。欲依時間戳記而非內容排序及分組值,應在 platform-settings.jsonBasicSettings 部份中將 GroupPropertyValuesByTime 設定設為 true
將上述設定設為 true 時,會一起觸發以相同時間戳記更新之所有內容的資料觸發事件與警示。因此,針對部份或全部事件註冊的多事件訂閱只會針對每個時間戳記執行一次,且會將相符事件傳入 events 參數。
UpdateSubscribedPropertyValuesBatched
針對連線「物件」批次寫入已訂閱的內容值。
以下是適用於服務的輸入參數:
batches
執行此服務後,不會收到輸出。
Batches 參數是包含多列的資料負載。每列都包含一批內容值與更新時間戳記。
batch 欄位值是包含多列的資料負載。每列都包含內容名稱、值與品質。內容值不得設定為 null。
內容的值會依批次的時間戳記進行排序與分組,這表示會一起觸發以相同時間戳記更新之所有內容的資料觸發事件與警示。因此,針對部份或全部事件註冊的多事件訂閱只會針對每個時間戳記執行一次,且會將所有相符事件傳入 events 參數。
這是否有幫助?