dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts@v1.0.2/clients/interfaces/deviceservicecallback.go (about)

     1  //
     2  // Copyright (C) 2020-2022 IOTech Ltd
     3  //
     4  // SPDX-License-Identifier: Apache-2.0
     5  
     6  package interfaces
     7  
     8  import (
     9  	"context"
    10  
    11  	"dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts/dtos/common"
    12  	"dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts/dtos/requests"
    13  	"dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts/errors"
    14  )
    15  
    16  // DeviceServiceCallbackClient defines the interface for interactions with the callback endpoint on the EdgeX Foundry device service.
    17  type DeviceServiceCallbackClient interface {
    18  	// AddDeviceCallback invokes device service's callback API for adding device
    19  	AddDeviceCallback(ctx context.Context, request requests.AddDeviceRequest) (common.BaseResponse, errors.EdgeX)
    20  	// UpdateDeviceCallback invokes device service's callback API for updating device
    21  	UpdateDeviceCallback(ctx context.Context, request requests.UpdateDeviceRequest) (common.BaseResponse, errors.EdgeX)
    22  	// DeleteDeviceCallback invokes device service's callback API for deleting device
    23  	DeleteDeviceCallback(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)
    24  	// ValidateDeviceCallback invokes device service's validation API for validating device
    25  	ValidateDeviceCallback(ctx context.Context, request requests.AddDeviceRequest) (common.BaseResponse, errors.EdgeX)
    26  	// UpdateDeviceProfileCallback invokes device service's callback API for updating device profile
    27  	UpdateDeviceProfileCallback(ctx context.Context, request requests.DeviceProfileRequest) (common.BaseResponse, errors.EdgeX)
    28  	// AddProvisionWatcherCallback invokes device service's callback API for adding provision watcher
    29  	AddProvisionWatcherCallback(ctx context.Context, request requests.AddProvisionWatcherRequest) (common.BaseResponse, errors.EdgeX)
    30  	// UpdateProvisionWatcherCallback invokes device service's callback API for updating provision watcher
    31  	UpdateProvisionWatcherCallback(ctx context.Context, request requests.UpdateProvisionWatcherRequest) (common.BaseResponse, errors.EdgeX)
    32  	// DeleteProvisionWatcherCallback invokes device service's callback API for deleting provision watcher
    33  	DeleteProvisionWatcherCallback(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)
    34  	// UpdateDeviceServiceCallback invokes device service's callback API for updating device service
    35  	UpdateDeviceServiceCallback(ctx context.Context, request requests.UpdateDeviceServiceRequest) (common.BaseResponse, errors.EdgeX)
    36  }