apis

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckDeviceIdRequest added in v1.8.0

type CheckDeviceIdRequest struct {
	core.JDCloudRequest

	/* Device 唯一标识  */
	DeviceId string `json:"deviceId"`
}

func NewCheckDeviceIdRequest added in v1.8.0

func NewCheckDeviceIdRequest(
	deviceId string,
) *CheckDeviceIdRequest

* param deviceId: Device 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewCheckDeviceIdRequestWithAllParams added in v1.8.0

func NewCheckDeviceIdRequestWithAllParams(
	deviceId string,
) *CheckDeviceIdRequest

* param deviceId: Device 唯一标识 (Required)

func NewCheckDeviceIdRequestWithoutParam added in v1.8.0

func NewCheckDeviceIdRequestWithoutParam() *CheckDeviceIdRequest

This constructor has better compatible ability when API parameters changed

func (CheckDeviceIdRequest) GetRegionId added in v1.8.0

func (r CheckDeviceIdRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*CheckDeviceIdRequest) SetDeviceId added in v1.8.0

func (r *CheckDeviceIdRequest) SetDeviceId(deviceId string)

param deviceId: Device 唯一标识(Required)

type CheckDeviceIdResponse added in v1.8.0

type CheckDeviceIdResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    CheckDeviceIdResult `json:"result"`
}

type CheckDeviceIdResult added in v1.8.0

type CheckDeviceIdResult struct {
}

type DeleteDeviceRequest added in v1.6.0

type DeleteDeviceRequest struct {
	core.JDCloudRequest

	/* 设备Id (Optional) */
	DeviceId *string `json:"deviceId"`

	/* hub实例instanceId (Optional) */
	InstanceId *string `json:"instanceId"`
}

func NewDeleteDeviceRequest added in v1.6.0

func NewDeleteDeviceRequest() *DeleteDeviceRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteDeviceRequestWithAllParams added in v1.6.0

func NewDeleteDeviceRequestWithAllParams(
	deviceId *string,
	instanceId *string,
) *DeleteDeviceRequest

* param deviceId: 设备Id (Optional) * param instanceId: hub实例instanceId (Optional)

func NewDeleteDeviceRequestWithoutParam added in v1.6.0

func NewDeleteDeviceRequestWithoutParam() *DeleteDeviceRequest

This constructor has better compatible ability when API parameters changed

func (DeleteDeviceRequest) GetRegionId added in v1.6.0

func (r DeleteDeviceRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteDeviceRequest) SetDeviceId added in v1.6.0

func (r *DeleteDeviceRequest) SetDeviceId(deviceId string)

param deviceId: 设备Id(Optional)

func (*DeleteDeviceRequest) SetInstanceId added in v1.6.0

func (r *DeleteDeviceRequest) SetInstanceId(instanceId string)

param instanceId: hub实例instanceId(Optional)

type DeleteDeviceResponse added in v1.6.0

type DeleteDeviceResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteDeviceResult `json:"result"`
}

type DeleteDeviceResult added in v1.6.0

type DeleteDeviceResult struct {
}

type DeleteEdgeRequest added in v1.8.0

type DeleteEdgeRequest struct {
	core.JDCloudRequest

	/* 边缘计算节点编号  */
	EdgeId string `json:"edgeId"`
}

func NewDeleteEdgeRequest added in v1.8.0

func NewDeleteEdgeRequest(
	edgeId string,
) *DeleteEdgeRequest

* param edgeId: 边缘计算节点编号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteEdgeRequestWithAllParams added in v1.8.0

func NewDeleteEdgeRequestWithAllParams(
	edgeId string,
) *DeleteEdgeRequest

* param edgeId: 边缘计算节点编号 (Required)

func NewDeleteEdgeRequestWithoutParam added in v1.8.0

func NewDeleteEdgeRequestWithoutParam() *DeleteEdgeRequest

This constructor has better compatible ability when API parameters changed

func (DeleteEdgeRequest) GetRegionId added in v1.8.0

func (r DeleteEdgeRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteEdgeRequest) SetEdgeId added in v1.8.0

func (r *DeleteEdgeRequest) SetEdgeId(edgeId string)

param edgeId: 边缘计算节点编号(Required)

type DeleteEdgeResponse added in v1.8.0

type DeleteEdgeResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteEdgeResult   `json:"result"`
}

type DeleteEdgeResult added in v1.8.0

type DeleteEdgeResult struct {
}

type DeleteModuleRequest added in v1.8.0

type DeleteModuleRequest struct {
	core.JDCloudRequest

	/* 边缘计算节点编号  */
	EdgeId string `json:"edgeId"`

	/* 边缘计算模块编号  */
	ModuleId string `json:"moduleId"`
}

func NewDeleteModuleRequest added in v1.8.0

func NewDeleteModuleRequest(
	edgeId string,
	moduleId string,
) *DeleteModuleRequest

* param edgeId: 边缘计算节点编号 (Required) * param moduleId: 边缘计算模块编号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeleteModuleRequestWithAllParams added in v1.8.0

func NewDeleteModuleRequestWithAllParams(
	edgeId string,
	moduleId string,
) *DeleteModuleRequest

* param edgeId: 边缘计算节点编号 (Required) * param moduleId: 边缘计算模块编号 (Required)

func NewDeleteModuleRequestWithoutParam added in v1.8.0

func NewDeleteModuleRequestWithoutParam() *DeleteModuleRequest

This constructor has better compatible ability when API parameters changed

func (DeleteModuleRequest) GetRegionId added in v1.8.0

func (r DeleteModuleRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeleteModuleRequest) SetEdgeId added in v1.8.0

func (r *DeleteModuleRequest) SetEdgeId(edgeId string)

param edgeId: 边缘计算节点编号(Required)

func (*DeleteModuleRequest) SetModuleId added in v1.8.0

func (r *DeleteModuleRequest) SetModuleId(moduleId string)

param moduleId: 边缘计算模块编号(Required)

type DeleteModuleResponse added in v1.8.0

type DeleteModuleResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeleteModuleResult `json:"result"`
}

type DeleteModuleResult added in v1.8.0

type DeleteModuleResult struct {
}

type DeployModuleRequest added in v1.8.0

type DeployModuleRequest struct {
	core.JDCloudRequest

	/* 边缘计算节点编号  */
	EdgeId string `json:"edgeId"`

	/* 边缘计算模块编号  */
	ModuleId string `json:"moduleId"`
}

func NewDeployModuleRequest added in v1.8.0

func NewDeployModuleRequest(
	edgeId string,
	moduleId string,
) *DeployModuleRequest

* param edgeId: 边缘计算节点编号 (Required) * param moduleId: 边缘计算模块编号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeployModuleRequestWithAllParams added in v1.8.0

func NewDeployModuleRequestWithAllParams(
	edgeId string,
	moduleId string,
) *DeployModuleRequest

* param edgeId: 边缘计算节点编号 (Required) * param moduleId: 边缘计算模块编号 (Required)

func NewDeployModuleRequestWithoutParam added in v1.8.0

func NewDeployModuleRequestWithoutParam() *DeployModuleRequest

This constructor has better compatible ability when API parameters changed

func (DeployModuleRequest) GetRegionId added in v1.8.0

func (r DeployModuleRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeployModuleRequest) SetEdgeId added in v1.8.0

func (r *DeployModuleRequest) SetEdgeId(edgeId string)

param edgeId: 边缘计算节点编号(Required)

func (*DeployModuleRequest) SetModuleId added in v1.8.0

func (r *DeployModuleRequest) SetModuleId(moduleId string)

param moduleId: 边缘计算模块编号(Required)

type DeployModuleResponse added in v1.8.0

type DeployModuleResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeployModuleResult `json:"result"`
}

type DeployModuleResult added in v1.8.0

type DeployModuleResult struct {
}

type DeviceActivateRequest

type DeviceActivateRequest struct {
	core.JDCloudRequest

	/* Device 唯一标识  */
	DeviceId string `json:"deviceId"`
}

func NewDeviceActivateRequest

func NewDeviceActivateRequest(
	deviceId string,
) *DeviceActivateRequest

* param deviceId: Device 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeviceActivateRequestWithAllParams

func NewDeviceActivateRequestWithAllParams(
	deviceId string,
) *DeviceActivateRequest

* param deviceId: Device 唯一标识 (Required)

func NewDeviceActivateRequestWithoutParam

func NewDeviceActivateRequestWithoutParam() *DeviceActivateRequest

This constructor has better compatible ability when API parameters changed

func (DeviceActivateRequest) GetRegionId

func (r DeviceActivateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeviceActivateRequest) SetDeviceId

func (r *DeviceActivateRequest) SetDeviceId(deviceId string)

param deviceId: Device 唯一标识(Required)

type DeviceActivateResponse

type DeviceActivateResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    DeviceActivateResult `json:"result"`
}

type DeviceActivateResult

type DeviceActivateResult struct {
	Data string `json:"data"`
}

type DeviceCommandRequest

type DeviceCommandRequest struct {
	core.JDCloudRequest

	/* Device 唯一标识  */
	DeviceId string `json:"deviceId"`

	/*  (Optional) */
	Commands *iothub.DeviceCommandVO `json:"commands"`
}

func NewDeviceCommandRequest

func NewDeviceCommandRequest(
	deviceId string,
) *DeviceCommandRequest

* param deviceId: Device 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeviceCommandRequestWithAllParams

func NewDeviceCommandRequestWithAllParams(
	deviceId string,
	commands *iothub.DeviceCommandVO,
) *DeviceCommandRequest

* param deviceId: Device 唯一标识 (Required) * param commands: (Optional)

func NewDeviceCommandRequestWithoutParam

func NewDeviceCommandRequestWithoutParam() *DeviceCommandRequest

This constructor has better compatible ability when API parameters changed

func (DeviceCommandRequest) GetRegionId

func (r DeviceCommandRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeviceCommandRequest) SetCommands

func (r *DeviceCommandRequest) SetCommands(commands *iothub.DeviceCommandVO)

param commands: (Optional)

func (*DeviceCommandRequest) SetDeviceId

func (r *DeviceCommandRequest) SetDeviceId(deviceId string)

param deviceId: Device 唯一标识(Required)

type DeviceCommandResponse

type DeviceCommandResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DeviceCommandResult `json:"result"`
}

type DeviceCommandResult

type DeviceCommandResult struct {
	Data string `json:"data"`
}

type DeviceStateRequest

type DeviceStateRequest struct {
	core.JDCloudRequest

	/* Device 唯一标识  */
	DeviceId string `json:"deviceId"`

	/*  (Optional) */
	States *string `json:"states"`
}

func NewDeviceStateRequest

func NewDeviceStateRequest(
	deviceId string,
) *DeviceStateRequest

* param deviceId: Device 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewDeviceStateRequestWithAllParams

func NewDeviceStateRequestWithAllParams(
	deviceId string,
	states *string,
) *DeviceStateRequest

* param deviceId: Device 唯一标识 (Required) * param states: (Optional)

func NewDeviceStateRequestWithoutParam

func NewDeviceStateRequestWithoutParam() *DeviceStateRequest

This constructor has better compatible ability when API parameters changed

func (DeviceStateRequest) GetRegionId

func (r DeviceStateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DeviceStateRequest) SetDeviceId

func (r *DeviceStateRequest) SetDeviceId(deviceId string)

param deviceId: Device 唯一标识(Required)

func (*DeviceStateRequest) SetStates

func (r *DeviceStateRequest) SetStates(states string)

param states: (Optional)

type DeviceStateResponse

type DeviceStateResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    DeviceStateResult  `json:"result"`
}

type DeviceStateResult

type DeviceStateResult struct {
	Data string `json:"data"`
}

type DevicesEnrollRequest

type DevicesEnrollRequest struct {
	core.JDCloudRequest

	/*  (Optional) */
	InstanceId *string `json:"instanceId"`

	/*  (Optional) */
	Device *iothub.DeviceEnrollVO `json:"device"`
}

func NewDevicesEnrollRequest

func NewDevicesEnrollRequest() *DevicesEnrollRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewDevicesEnrollRequestWithAllParams

func NewDevicesEnrollRequestWithAllParams(
	instanceId *string,
	device *iothub.DeviceEnrollVO,
) *DevicesEnrollRequest

* param instanceId: (Optional) * param device: (Optional)

func NewDevicesEnrollRequestWithoutParam

func NewDevicesEnrollRequestWithoutParam() *DevicesEnrollRequest

This constructor has better compatible ability when API parameters changed

func (DevicesEnrollRequest) GetRegionId

func (r DevicesEnrollRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*DevicesEnrollRequest) SetDevice

func (r *DevicesEnrollRequest) SetDevice(device *iothub.DeviceEnrollVO)

param device: (Optional)

func (*DevicesEnrollRequest) SetInstanceId

func (r *DevicesEnrollRequest) SetInstanceId(instanceId string)

param instanceId: (Optional)

type DevicesEnrollResponse

type DevicesEnrollResponse struct {
	RequestID string              `json:"requestId"`
	Error     core.ErrorResponse  `json:"error"`
	Result    DevicesEnrollResult `json:"result"`
}

type DevicesEnrollResult

type DevicesEnrollResult struct {
	Data string `json:"data"`
}

type EdgeEnrollRequest added in v1.8.0

type EdgeEnrollRequest struct {
	core.JDCloudRequest

	/* 边缘计算节点编号  */
	EdgeId string `json:"edgeId"`

	/* 边缘计算设备显示名称  */
	EdgeName string `json:"edgeName"`

	/* IoTHubInstance编号  */
	InstanceId string `json:"instanceId"`

	/* 操作系统  */
	Os string `json:"os"`

	/* 硬件平台版本  */
	Hardware string `json:"hardware"`

	/* 边缘说明 (Optional) */
	EdgeDesc *string `json:"edgeDesc"`
}

func NewEdgeEnrollRequest added in v1.8.0

func NewEdgeEnrollRequest(
	edgeId string,
	edgeName string,
	instanceId string,
	os string,
	hardware string,
) *EdgeEnrollRequest

* param edgeId: 边缘计算节点编号 (Required) * param edgeName: 边缘计算设备显示名称 (Required) * param instanceId: IoTHubInstance编号 (Required) * param os: 操作系统 (Required) * param hardware: 硬件平台版本 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewEdgeEnrollRequestWithAllParams added in v1.8.0

func NewEdgeEnrollRequestWithAllParams(
	edgeId string,
	edgeName string,
	instanceId string,
	os string,
	hardware string,
	edgeDesc *string,
) *EdgeEnrollRequest

* param edgeId: 边缘计算节点编号 (Required) * param edgeName: 边缘计算设备显示名称 (Required) * param instanceId: IoTHubInstance编号 (Required) * param os: 操作系统 (Required) * param hardware: 硬件平台版本 (Required) * param edgeDesc: 边缘说明 (Optional)

func NewEdgeEnrollRequestWithoutParam added in v1.8.0

func NewEdgeEnrollRequestWithoutParam() *EdgeEnrollRequest

This constructor has better compatible ability when API parameters changed

func (EdgeEnrollRequest) GetRegionId added in v1.8.0

func (r EdgeEnrollRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*EdgeEnrollRequest) SetEdgeDesc added in v1.8.0

func (r *EdgeEnrollRequest) SetEdgeDesc(edgeDesc string)

param edgeDesc: 边缘说明(Optional)

func (*EdgeEnrollRequest) SetEdgeId added in v1.8.0

func (r *EdgeEnrollRequest) SetEdgeId(edgeId string)

param edgeId: 边缘计算节点编号(Required)

func (*EdgeEnrollRequest) SetEdgeName added in v1.8.0

func (r *EdgeEnrollRequest) SetEdgeName(edgeName string)

param edgeName: 边缘计算设备显示名称(Required)

func (*EdgeEnrollRequest) SetHardware added in v1.8.0

func (r *EdgeEnrollRequest) SetHardware(hardware string)

param hardware: 硬件平台版本(Required)

func (*EdgeEnrollRequest) SetInstanceId added in v1.8.0

func (r *EdgeEnrollRequest) SetInstanceId(instanceId string)

param instanceId: IoTHubInstance编号(Required)

func (*EdgeEnrollRequest) SetOs added in v1.8.0

func (r *EdgeEnrollRequest) SetOs(os string)

param os: 操作系统(Required)

type EdgeEnrollResponse added in v1.8.0

type EdgeEnrollResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    EdgeEnrollResult   `json:"result"`
}

type EdgeEnrollResult added in v1.8.0

type EdgeEnrollResult struct {
}

type GetOMPrivateURLRequest added in v1.6.0

type GetOMPrivateURLRequest struct {
	core.JDCloudRequest

	/*   */
	DeviceId string `json:"deviceId"`

	/*  (Optional) */
	InstanceId *string `json:"instanceId"`
}

func NewGetOMPrivateURLRequest added in v1.6.0

func NewGetOMPrivateURLRequest(
	deviceId string,
) *GetOMPrivateURLRequest

* param deviceId: (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewGetOMPrivateURLRequestWithAllParams added in v1.6.0

func NewGetOMPrivateURLRequestWithAllParams(
	deviceId string,
	instanceId *string,
) *GetOMPrivateURLRequest

* param deviceId: (Required) * param instanceId: (Optional)

func NewGetOMPrivateURLRequestWithoutParam added in v1.6.0

func NewGetOMPrivateURLRequestWithoutParam() *GetOMPrivateURLRequest

This constructor has better compatible ability when API parameters changed

func (GetOMPrivateURLRequest) GetRegionId added in v1.6.0

func (r GetOMPrivateURLRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*GetOMPrivateURLRequest) SetDeviceId added in v1.6.0

func (r *GetOMPrivateURLRequest) SetDeviceId(deviceId string)

param deviceId: (Required)

func (*GetOMPrivateURLRequest) SetInstanceId added in v1.6.0

func (r *GetOMPrivateURLRequest) SetInstanceId(instanceId string)

param instanceId: (Optional)

type GetOMPrivateURLResponse added in v1.6.0

type GetOMPrivateURLResponse struct {
	RequestID string                `json:"requestId"`
	Error     core.ErrorResponse    `json:"error"`
	Result    GetOMPrivateURLResult `json:"result"`
}

type GetOMPrivateURLResult added in v1.6.0

type GetOMPrivateURLResult struct {
	PrivateUrl string `json:"privateUrl"`
}

type ModuleEnrollRequest

type ModuleEnrollRequest struct {
	core.JDCloudRequest

	/* 边缘计算节点编号  */
	EdgeId string `json:"edgeId"`

	/* 待添加的设备编号 (Optional) */
	DeviceId *string `json:"deviceId"`

	/* 边缘计算模块名称 (Optional) */
	ModuleId *string `json:"moduleId"`

	/* 边缘计算模块类型编号 (Optional) */
	ModuleTypeId *string `json:"moduleTypeId"`

	/* 边缘计算模块配置编号 (Optional) */
	ModuleConfId *string `json:"moduleConfId"`

	/* 是否立即部署[0-立即部署,1-暂不部署] (Optional) */
	IsDeploy *int `json:"isDeploy"`
}

func NewModuleEnrollRequest

func NewModuleEnrollRequest(
	edgeId string,
) *ModuleEnrollRequest

* param edgeId: 边缘计算节点编号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModuleEnrollRequestWithAllParams

func NewModuleEnrollRequestWithAllParams(
	edgeId string,
	deviceId *string,
	moduleId *string,
	moduleTypeId *string,
	moduleConfId *string,
	isDeploy *int,
) *ModuleEnrollRequest

* param edgeId: 边缘计算节点编号 (Required) * param deviceId: 待添加的设备编号 (Optional) * param moduleId: 边缘计算模块名称 (Optional) * param moduleTypeId: 边缘计算模块类型编号 (Optional) * param moduleConfId: 边缘计算模块配置编号 (Optional) * param isDeploy: 是否立即部署[0-立即部署,1-暂不部署] (Optional)

func NewModuleEnrollRequestWithoutParam

func NewModuleEnrollRequestWithoutParam() *ModuleEnrollRequest

This constructor has better compatible ability when API parameters changed

func (ModuleEnrollRequest) GetRegionId

func (r ModuleEnrollRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModuleEnrollRequest) SetDeviceId added in v1.8.0

func (r *ModuleEnrollRequest) SetDeviceId(deviceId string)

param deviceId: 待添加的设备编号(Optional)

func (*ModuleEnrollRequest) SetEdgeId added in v1.8.0

func (r *ModuleEnrollRequest) SetEdgeId(edgeId string)

param edgeId: 边缘计算节点编号(Required)

func (*ModuleEnrollRequest) SetIsDeploy added in v1.8.0

func (r *ModuleEnrollRequest) SetIsDeploy(isDeploy int)

param isDeploy: 是否立即部署[0-立即部署,1-暂不部署](Optional)

func (*ModuleEnrollRequest) SetModuleConfId added in v1.8.0

func (r *ModuleEnrollRequest) SetModuleConfId(moduleConfId string)

param moduleConfId: 边缘计算模块配置编号(Optional)

func (*ModuleEnrollRequest) SetModuleId added in v1.8.0

func (r *ModuleEnrollRequest) SetModuleId(moduleId string)

param moduleId: 边缘计算模块名称(Optional)

func (*ModuleEnrollRequest) SetModuleTypeId added in v1.8.0

func (r *ModuleEnrollRequest) SetModuleTypeId(moduleTypeId string)

param moduleTypeId: 边缘计算模块类型编号(Optional)

type ModuleEnrollResponse

type ModuleEnrollResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ModuleEnrollResult `json:"result"`
}

type ModuleEnrollResult

type ModuleEnrollResult struct {
}

type ModuleEnrollmentRequest added in v1.8.0

type ModuleEnrollmentRequest struct {
	core.JDCloudRequest

	/* moduleName 唯一标识  */
	ModuleName string `json:"moduleName"`

	/*  (Optional) */
	InstanceId *string `json:"instanceId"`

	/*  (Optional) */
	ModelName *string `json:"modelName"`

	/*  (Optional) */
	ParentDeviceName *string `json:"parentDeviceName"`

	/*  (Optional) */
	Name *string `json:"name"`
}

func NewModuleEnrollmentRequest added in v1.8.0

func NewModuleEnrollmentRequest(
	moduleName string,
) *ModuleEnrollmentRequest

* param moduleName: moduleName 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModuleEnrollmentRequestWithAllParams added in v1.8.0

func NewModuleEnrollmentRequestWithAllParams(
	moduleName string,
	instanceId *string,
	modelName *string,
	parentDeviceName *string,
	name *string,
) *ModuleEnrollmentRequest

* param moduleName: moduleName 唯一标识 (Required) * param instanceId: (Optional) * param modelName: (Optional) * param parentDeviceName: (Optional) * param name: (Optional)

func NewModuleEnrollmentRequestWithoutParam added in v1.8.0

func NewModuleEnrollmentRequestWithoutParam() *ModuleEnrollmentRequest

This constructor has better compatible ability when API parameters changed

func (ModuleEnrollmentRequest) GetRegionId added in v1.8.0

func (r ModuleEnrollmentRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModuleEnrollmentRequest) SetInstanceId added in v1.8.0

func (r *ModuleEnrollmentRequest) SetInstanceId(instanceId string)

param instanceId: (Optional)

func (*ModuleEnrollmentRequest) SetModelName added in v1.8.0

func (r *ModuleEnrollmentRequest) SetModelName(modelName string)

param modelName: (Optional)

func (*ModuleEnrollmentRequest) SetModuleName added in v1.8.0

func (r *ModuleEnrollmentRequest) SetModuleName(moduleName string)

param moduleName: moduleName 唯一标识(Required)

func (*ModuleEnrollmentRequest) SetName added in v1.8.0

func (r *ModuleEnrollmentRequest) SetName(name string)

param name: (Optional)

func (*ModuleEnrollmentRequest) SetParentDeviceName added in v1.8.0

func (r *ModuleEnrollmentRequest) SetParentDeviceName(parentDeviceName string)

param parentDeviceName: (Optional)

type ModuleEnrollmentResponse added in v1.8.0

type ModuleEnrollmentResponse struct {
	RequestID string                 `json:"requestId"`
	Error     core.ErrorResponse     `json:"error"`
	Result    ModuleEnrollmentResult `json:"result"`
}

type ModuleEnrollmentResult added in v1.8.0

type ModuleEnrollmentResult struct {
	Data string `json:"data"`
}

type ModuleStateRequest

type ModuleStateRequest struct {
	core.JDCloudRequest

	/* moduleName 唯一标识  */
	ModuleName string `json:"moduleName"`

	/*  (Optional) */
	States *string `json:"states"`
}

func NewModuleStateRequest

func NewModuleStateRequest(
	moduleName string,
) *ModuleStateRequest

* param moduleName: moduleName 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewModuleStateRequestWithAllParams

func NewModuleStateRequestWithAllParams(
	moduleName string,
	states *string,
) *ModuleStateRequest

* param moduleName: moduleName 唯一标识 (Required) * param states: (Optional)

func NewModuleStateRequestWithoutParam

func NewModuleStateRequestWithoutParam() *ModuleStateRequest

This constructor has better compatible ability when API parameters changed

func (ModuleStateRequest) GetRegionId

func (r ModuleStateRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*ModuleStateRequest) SetModuleName

func (r *ModuleStateRequest) SetModuleName(moduleName string)

param moduleName: moduleName 唯一标识(Required)

func (*ModuleStateRequest) SetStates

func (r *ModuleStateRequest) SetStates(states string)

param states: (Optional)

type ModuleStateResponse

type ModuleStateResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    ModuleStateResult  `json:"result"`
}

type ModuleStateResult

type ModuleStateResult struct {
	Data string `json:"data"`
}

type OmEnrollRequest

type OmEnrollRequest struct {
	core.JDCloudRequest

	/* 物模型唯一标识  */
	OmName string `json:"omName"`

	/*  (Optional) */
	InstanceId *string `json:"instanceId"`

	/*  (Optional) */
	Payload *string `json:"payload"`
}

func NewOmEnrollRequest

func NewOmEnrollRequest(
	omName string,
) *OmEnrollRequest

* param omName: 物模型唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewOmEnrollRequestWithAllParams

func NewOmEnrollRequestWithAllParams(
	omName string,
	instanceId *string,
	payload *string,
) *OmEnrollRequest

* param omName: 物模型唯一标识 (Required) * param instanceId: (Optional) * param payload: (Optional)

func NewOmEnrollRequestWithoutParam

func NewOmEnrollRequestWithoutParam() *OmEnrollRequest

This constructor has better compatible ability when API parameters changed

func (OmEnrollRequest) GetRegionId

func (r OmEnrollRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*OmEnrollRequest) SetInstanceId

func (r *OmEnrollRequest) SetInstanceId(instanceId string)

param instanceId: (Optional)

func (*OmEnrollRequest) SetOmName

func (r *OmEnrollRequest) SetOmName(omName string)

param omName: 物模型唯一标识(Required)

func (*OmEnrollRequest) SetPayload

func (r *OmEnrollRequest) SetPayload(payload string)

param payload: (Optional)

type OmEnrollResponse

type OmEnrollResponse struct {
	RequestID string             `json:"requestId"`
	Error     core.ErrorResponse `json:"error"`
	Result    OmEnrollResult     `json:"result"`
}

type OmEnrollResult

type OmEnrollResult struct {
	Data string `json:"data"`
}

type OmEnrollbyFileRequest added in v1.6.0

type OmEnrollbyFileRequest struct {
	core.JDCloudRequest

	/* 物模型文件名称  */
	FileName string `json:"fileName"`

	/* 待上传物模型的IoT Hub实例编号  */
	InstanceId string `json:"instanceId"`
}

func NewOmEnrollbyFileRequest added in v1.6.0

func NewOmEnrollbyFileRequest(
	fileName string,
	instanceId string,
) *OmEnrollbyFileRequest

* param fileName: 物模型文件名称 (Required) * param instanceId: 待上传物模型的IoT Hub实例编号 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewOmEnrollbyFileRequestWithAllParams added in v1.6.0

func NewOmEnrollbyFileRequestWithAllParams(
	fileName string,
	instanceId string,
) *OmEnrollbyFileRequest

* param fileName: 物模型文件名称 (Required) * param instanceId: 待上传物模型的IoT Hub实例编号 (Required)

func NewOmEnrollbyFileRequestWithoutParam added in v1.6.0

func NewOmEnrollbyFileRequestWithoutParam() *OmEnrollbyFileRequest

This constructor has better compatible ability when API parameters changed

func (OmEnrollbyFileRequest) GetRegionId added in v1.6.0

func (r OmEnrollbyFileRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*OmEnrollbyFileRequest) SetFileName added in v1.6.0

func (r *OmEnrollbyFileRequest) SetFileName(fileName string)

param fileName: 物模型文件名称(Required)

func (*OmEnrollbyFileRequest) SetInstanceId added in v1.6.0

func (r *OmEnrollbyFileRequest) SetInstanceId(instanceId string)

param instanceId: 待上传物模型的IoT Hub实例编号(Required)

type OmEnrollbyFileResponse added in v1.6.0

type OmEnrollbyFileResponse struct {
	RequestID string               `json:"requestId"`
	Error     core.ErrorResponse   `json:"error"`
	Result    OmEnrollbyFileResult `json:"result"`
}

type OmEnrollbyFileResult added in v1.6.0

type OmEnrollbyFileResult struct {
	Data string `json:"data"`
}

type QueryDeviceCommandsRequest added in v1.6.0

type QueryDeviceCommandsRequest struct {
	core.JDCloudRequest

	/* Device 唯一标识  */
	DeviceId string `json:"deviceId"`
}

func NewQueryDeviceCommandsRequest added in v1.6.0

func NewQueryDeviceCommandsRequest(
	deviceId string,
) *QueryDeviceCommandsRequest

* param deviceId: Device 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewQueryDeviceCommandsRequestWithAllParams added in v1.6.0

func NewQueryDeviceCommandsRequestWithAllParams(
	deviceId string,
) *QueryDeviceCommandsRequest

* param deviceId: Device 唯一标识 (Required)

func NewQueryDeviceCommandsRequestWithoutParam added in v1.6.0

func NewQueryDeviceCommandsRequestWithoutParam() *QueryDeviceCommandsRequest

This constructor has better compatible ability when API parameters changed

func (QueryDeviceCommandsRequest) GetRegionId added in v1.6.0

func (r QueryDeviceCommandsRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*QueryDeviceCommandsRequest) SetDeviceId added in v1.6.0

func (r *QueryDeviceCommandsRequest) SetDeviceId(deviceId string)

param deviceId: Device 唯一标识(Required)

type QueryDeviceCommandsResponse added in v1.6.0

type QueryDeviceCommandsResponse struct {
	RequestID string                    `json:"requestId"`
	Error     core.ErrorResponse        `json:"error"`
	Result    QueryDeviceCommandsResult `json:"result"`
}

type QueryDeviceCommandsResult added in v1.6.0

type QueryDeviceCommandsResult struct {
	Commands string `json:"commands"`
}

type QueryDeviceOnlineInfosRequest added in v1.6.0

type QueryDeviceOnlineInfosRequest struct {
	core.JDCloudRequest

	/* 设备Id集合 (Optional) */
	DeviceIds []string `json:"deviceIds"`
}

func NewQueryDeviceOnlineInfosRequest added in v1.6.0

func NewQueryDeviceOnlineInfosRequest() *QueryDeviceOnlineInfosRequest

* * @Deprecated, not compatible when mandatory parameters changed

func NewQueryDeviceOnlineInfosRequestWithAllParams added in v1.6.0

func NewQueryDeviceOnlineInfosRequestWithAllParams(
	deviceIds []string,
) *QueryDeviceOnlineInfosRequest

* param deviceIds: 设备Id集合 (Optional)

func NewQueryDeviceOnlineInfosRequestWithoutParam added in v1.6.0

func NewQueryDeviceOnlineInfosRequestWithoutParam() *QueryDeviceOnlineInfosRequest

This constructor has better compatible ability when API parameters changed

func (QueryDeviceOnlineInfosRequest) GetRegionId added in v1.6.0

func (r QueryDeviceOnlineInfosRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*QueryDeviceOnlineInfosRequest) SetDeviceIds added in v1.6.0

func (r *QueryDeviceOnlineInfosRequest) SetDeviceIds(deviceIds []string)

param deviceIds: 设备Id集合(Optional)

type QueryDeviceOnlineInfosResponse added in v1.6.0

type QueryDeviceOnlineInfosResponse struct {
	RequestID string                       `json:"requestId"`
	Error     core.ErrorResponse           `json:"error"`
	Result    QueryDeviceOnlineInfosResult `json:"result"`
}

type QueryDeviceOnlineInfosResult added in v1.6.0

type QueryDeviceOnlineInfosResult struct {
	OnlineInfos []iothub.OnlineInfo `json:"onlineInfos"`
}

type QueryDeviceStatesRequest added in v1.6.0

type QueryDeviceStatesRequest struct {
	core.JDCloudRequest

	/* Device 唯一标识  */
	DeviceId string `json:"deviceId"`
}

func NewQueryDeviceStatesRequest added in v1.6.0

func NewQueryDeviceStatesRequest(
	deviceId string,
) *QueryDeviceStatesRequest

* param deviceId: Device 唯一标识 (Required) * * @Deprecated, not compatible when mandatory parameters changed

func NewQueryDeviceStatesRequestWithAllParams added in v1.6.0

func NewQueryDeviceStatesRequestWithAllParams(
	deviceId string,
) *QueryDeviceStatesRequest

* param deviceId: Device 唯一标识 (Required)

func NewQueryDeviceStatesRequestWithoutParam added in v1.6.0

func NewQueryDeviceStatesRequestWithoutParam() *QueryDeviceStatesRequest

This constructor has better compatible ability when API parameters changed

func (QueryDeviceStatesRequest) GetRegionId added in v1.6.0

func (r QueryDeviceStatesRequest) GetRegionId() string

GetRegionId returns path parameter 'regionId' if exist, otherwise return empty string

func (*QueryDeviceStatesRequest) SetDeviceId added in v1.6.0

func (r *QueryDeviceStatesRequest) SetDeviceId(deviceId string)

param deviceId: Device 唯一标识(Required)

type QueryDeviceStatesResponse added in v1.6.0

type QueryDeviceStatesResponse struct {
	RequestID string                  `json:"requestId"`
	Error     core.ErrorResponse      `json:"error"`
	Result    QueryDeviceStatesResult `json:"result"`
}

type QueryDeviceStatesResult added in v1.6.0

type QueryDeviceStatesResult struct {
	State string `json:"state"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL