IotClient (tencentcloud-sdk-java 3.0.6 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.iot.v20180123.IotClient

public class IotClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明
`IotClient(Credential credential, String region)` 构造client
`IotClient(Credential credential, String region, ClientProfile profile)` 构造client

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ActivateRuleResponse`	`ActivateRule(ActivateRuleRequest req)` 启用规则
`AddDeviceResponse`	`AddDevice(AddDeviceRequest req)` 提供在指定的产品Id下创建一个设备的能力，生成设备名称与设备秘钥。
`AddProductResponse`	`AddProduct(AddProductRequest req)` 本接口(AddProduct)用于创建、定义某款硬件产品。
`AddRuleResponse`	`AddRule(AddRuleRequest req)` 新增规则
`AddTopicResponse`	`AddTopic(AddTopicRequest req)` 新增Topic，用于设备或应用发布消息至该Topic或订阅该Topic的消息。
`AddUserResponse`	`AddUser(AddUserRequest req)` 注册用户
`AppAddUserResponse`	`AppAddUser(AppAddUserRequest req)` 注册应用用户
`DeactivateRuleResponse`	`DeactivateRule(DeactivateRuleRequest req)` 禁用规则
`DeleteDeviceResponse`	`DeleteDevice(DeleteDeviceRequest req)` 提供在指定的产品Id下删除一个设备的能力。
`DeleteProductResponse`	`DeleteProduct(DeleteProductRequest req)` 删除用户指定的产品Id对应的信息。
`DeleteRuleResponse`	`DeleteRule(DeleteRuleRequest req)` 删除规则
`DeleteTopicResponse`	`DeleteTopic(DeleteTopicRequest req)` 删除Topic
`GetDataHistoryResponse`	`GetDataHistory(GetDataHistoryRequest req)` 批量获取设备某一段时间范围的设备上报数据。
`GetDeviceResponse`	`GetDevice(GetDeviceRequest req)` 提供查询某个设备详细信息的能力。
`GetDeviceDataResponse`	`GetDeviceData(GetDeviceDataRequest req)` 获取某个设备当前上报到云端的数据，该接口适用于使用数据模板协议的产品。
`GetDeviceLogResponse`	`GetDeviceLog(GetDeviceLogRequest req)` 批量获取设备与云端的详细通信日志，该接口适用于使用数据模板类型的产品。
`GetDevicesResponse`	`GetDevices(GetDevicesRequest req)` 提供分页查询某个产品Id下设备信息的能力。
`GetDeviceStatusesResponse`	`GetDeviceStatuses(GetDeviceStatusesRequest req)` 批量获取设备的当前状态，状态包括在线、离线或未激活状态。
`GetProductResponse`	`GetProduct(GetProductRequest req)` 获取产品定义的详细信息，包括产品名称、产品描述，鉴权模式等信息。
`GetProductsResponse`	`GetProducts(GetProductsRequest req)` 获取用户在物联网套件所创建的所有产品信息。
`GetRuleResponse`	`GetRule(GetRuleRequest req)` 获取转发规则信息
`GetRulesResponse`	`GetRules(GetRulesRequest req)` 获取转发规则列表
`GetTopicResponse`	`GetTopic(GetTopicRequest req)` 获取Topic信息
`GetTopicsResponse`	`GetTopics(GetTopicsRequest req)` 获取Topic列表
`GetUserResponse`	`GetUser(GetUserRequest req)` 获取用户信息
`IssueDeviceControlResponse`	`IssueDeviceControl(IssueDeviceControlRequest req)` 提供下发控制指令到指定设备的能力，该接口适用于使用数据模板类型的产品。
`PublishMsgResponse`	`PublishMsg(PublishMsgRequest req)` 提供向指定的Topic发布消息的能力，常用于向设备下发控制指令；该接口只适用于数据协议为“自定义”类型的产品，使用数据模板类型的产品需使用IssueDeviceControl接口
`ResetDeviceResponse`	`ResetDevice(ResetDeviceRequest req)` 重置设备操作，将会为设备生成新的证书及清空最新数据，需谨慎操作。
`UpdateProductResponse`	`UpdateProduct(UpdateProductRequest req)` 提供修改产品信息及数据模板的能力。
`UpdateRuleResponse`	`UpdateRule(UpdateRuleRequest req)` 更新规则

从类继承的方法 com.tencentcloudapi.common.AbstractClient
getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - IotClient
```
public IotClient(Credential credential,
                 String region)
```
    构造client
    
    参数:
    
    credential - 认证信息实例
    
    region - 产品地域
  - IotClient
```
public IotClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
    构造client
    
    参数:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- 方法详细资料
  - ActivateRule
```
public ActivateRuleResponse ActivateRule(ActivateRuleRequest req)
                                  throws TencentCloudSDKException
```
    启用规则
    
    参数:
    
    req - ActivateRuleRequest
    
    返回:
    
    ActivateRuleResponse
    
    抛出:
    
    TencentCloudSDKException
  - AddDevice
```
public AddDeviceResponse AddDevice(AddDeviceRequest req)
                            throws TencentCloudSDKException
```
    提供在指定的产品Id下创建一个设备的能力，生成设备名称与设备秘钥。
    
    参数:
    
    req - AddDeviceRequest
    
    返回:
    
    AddDeviceResponse
    
    抛出:
    
    TencentCloudSDKException
  - AddProduct
```
public AddProductResponse AddProduct(AddProductRequest req)
                              throws TencentCloudSDKException
```
    本接口(AddProduct)用于创建、定义某款硬件产品。
    
    参数:
    
    req - AddProductRequest
    
    返回:
    
    AddProductResponse
    
    抛出:
    
    TencentCloudSDKException
  - AddRule
```
public AddRuleResponse AddRule(AddRuleRequest req)
                        throws TencentCloudSDKException
```
    新增规则
    
    参数:
    
    req - AddRuleRequest
    
    返回:
    
    AddRuleResponse
    
    抛出:
    
    TencentCloudSDKException
  - AddTopic
```
public AddTopicResponse AddTopic(AddTopicRequest req)
                          throws TencentCloudSDKException
```
    新增Topic，用于设备或应用发布消息至该Topic或订阅该Topic的消息。
    
    参数:
    
    req - AddTopicRequest
    
    返回:
    
    AddTopicResponse
    
    抛出:
    
    TencentCloudSDKException
  - AddUser
```
public AddUserResponse AddUser(AddUserRequest req)
                        throws TencentCloudSDKException
```
    注册用户
    
    参数:
    
    req - AddUserRequest
    
    返回:
    
    AddUserResponse
    
    抛出:
    
    TencentCloudSDKException
  - AppAddUser
```
public AppAddUserResponse AppAddUser(AppAddUserRequest req)
                              throws TencentCloudSDKException
```
    注册应用用户
    
    参数:
    
    req - AppAddUserRequest
    
    返回:
    
    AppAddUserResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeactivateRule
```
public DeactivateRuleResponse DeactivateRule(DeactivateRuleRequest req)
                                      throws TencentCloudSDKException
```
    禁用规则
    
    参数:
    
    req - DeactivateRuleRequest
    
    返回:
    
    DeactivateRuleResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteDevice
```
public DeleteDeviceResponse DeleteDevice(DeleteDeviceRequest req)
                                  throws TencentCloudSDKException
```
    提供在指定的产品Id下删除一个设备的能力。
    
    参数:
    
    req - DeleteDeviceRequest
    
    返回:
    
    DeleteDeviceResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteProduct
```
public DeleteProductResponse DeleteProduct(DeleteProductRequest req)
                                    throws TencentCloudSDKException
```
    删除用户指定的产品Id对应的信息。
    
    参数:
    
    req - DeleteProductRequest
    
    返回:
    
    DeleteProductResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteRule
```
public DeleteRuleResponse DeleteRule(DeleteRuleRequest req)
                              throws TencentCloudSDKException
```
    删除规则
    
    参数:
    
    req - DeleteRuleRequest
    
    返回:
    
    DeleteRuleResponse
    
    抛出:
    
    TencentCloudSDKException
  - DeleteTopic
```
public DeleteTopicResponse DeleteTopic(DeleteTopicRequest req)
                                throws TencentCloudSDKException
```
    删除Topic
    
    参数:
    
    req - DeleteTopicRequest
    
    返回:
    
    DeleteTopicResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetDataHistory
```
public GetDataHistoryResponse GetDataHistory(GetDataHistoryRequest req)
                                      throws TencentCloudSDKException
```
    批量获取设备某一段时间范围的设备上报数据。该接口只允许使用数据模板类型的产品通过REST API方式同步设备上报数据至用户的应用系统。
    
    参数:
    
    req - GetDataHistoryRequest
    
    返回:
    
    GetDataHistoryResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetDevice
```
public GetDeviceResponse GetDevice(GetDeviceRequest req)
                            throws TencentCloudSDKException
```
    提供查询某个设备详细信息的能力。
    
    参数:
    
    req - GetDeviceRequest
    
    返回:
    
    GetDeviceResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetDeviceData
```
public GetDeviceDataResponse GetDeviceData(GetDeviceDataRequest req)
                                    throws TencentCloudSDKException
```
    获取某个设备当前上报到云端的数据，该接口适用于使用数据模板协议的产品。
    
    参数:
    
    req - GetDeviceDataRequest
    
    返回:
    
    GetDeviceDataResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetDeviceLog
```
public GetDeviceLogResponse GetDeviceLog(GetDeviceLogRequest req)
                                  throws TencentCloudSDKException
```
    批量获取设备与云端的详细通信日志，该接口适用于使用数据模板类型的产品。
    
    参数:
    
    req - GetDeviceLogRequest
    
    返回:
    
    GetDeviceLogResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetDeviceStatuses
```
public GetDeviceStatusesResponse GetDeviceStatuses(GetDeviceStatusesRequest req)
                                            throws TencentCloudSDKException
```
    批量获取设备的当前状态，状态包括在线、离线或未激活状态。
    
    参数:
    
    req - GetDeviceStatusesRequest
    
    返回:
    
    GetDeviceStatusesResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetDevices
```
public GetDevicesResponse GetDevices(GetDevicesRequest req)
                              throws TencentCloudSDKException
```
    提供分页查询某个产品Id下设备信息的能力。
    
    参数:
    
    req - GetDevicesRequest
    
    返回:
    
    GetDevicesResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetProduct
```
public GetProductResponse GetProduct(GetProductRequest req)
                              throws TencentCloudSDKException
```
    获取产品定义的详细信息，包括产品名称、产品描述，鉴权模式等信息。
    
    参数:
    
    req - GetProductRequest
    
    返回:
    
    GetProductResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetProducts
```
public GetProductsResponse GetProducts(GetProductsRequest req)
                                throws TencentCloudSDKException
```
    获取用户在物联网套件所创建的所有产品信息。
    
    参数:
    
    req - GetProductsRequest
    
    返回:
    
    GetProductsResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetRule
```
public GetRuleResponse GetRule(GetRuleRequest req)
                        throws TencentCloudSDKException
```
    获取转发规则信息
    
    参数:
    
    req - GetRuleRequest
    
    返回:
    
    GetRuleResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetRules
```
public GetRulesResponse GetRules(GetRulesRequest req)
                          throws TencentCloudSDKException
```
    获取转发规则列表
    
    参数:
    
    req - GetRulesRequest
    
    返回:
    
    GetRulesResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetTopic
```
public GetTopicResponse GetTopic(GetTopicRequest req)
                          throws TencentCloudSDKException
```
    获取Topic信息
    
    参数:
    
    req - GetTopicRequest
    
    返回:
    
    GetTopicResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetTopics
```
public GetTopicsResponse GetTopics(GetTopicsRequest req)
                            throws TencentCloudSDKException
```
    获取Topic列表
    
    参数:
    
    req - GetTopicsRequest
    
    返回:
    
    GetTopicsResponse
    
    抛出:
    
    TencentCloudSDKException
  - GetUser
```
public GetUserResponse GetUser(GetUserRequest req)
                        throws TencentCloudSDKException
```
    获取用户信息
    
    参数:
    
    req - GetUserRequest
    
    返回:
    
    GetUserResponse
    
    抛出:
    
    TencentCloudSDKException
  - IssueDeviceControl
```
public IssueDeviceControlResponse IssueDeviceControl(IssueDeviceControlRequest req)
                                              throws TencentCloudSDKException
```
    提供下发控制指令到指定设备的能力，该接口适用于使用数据模板类型的产品。
    
    参数:
    
    req - IssueDeviceControlRequest
    
    返回:
    
    IssueDeviceControlResponse
    
    抛出:
    
    TencentCloudSDKException
  - PublishMsg
```
public PublishMsgResponse PublishMsg(PublishMsgRequest req)
                              throws TencentCloudSDKException
```
    提供向指定的Topic发布消息的能力，常用于向设备下发控制指令；该接口只适用于数据协议为“自定义”类型的产品，使用数据模板类型的产品需使用IssueDeviceControl接口
    
    参数:
    
    req - PublishMsgRequest
    
    返回:
    
    PublishMsgResponse
    
    抛出:
    
    TencentCloudSDKException
  - ResetDevice
```
public ResetDeviceResponse ResetDevice(ResetDeviceRequest req)
                                throws TencentCloudSDKException
```
    重置设备操作，将会为设备生成新的证书及清空最新数据，需谨慎操作。
    
    参数:
    
    req - ResetDeviceRequest
    
    返回:
    
    ResetDeviceResponse
    
    抛出:
    
    TencentCloudSDKException
  - UpdateProduct
```
public UpdateProductResponse UpdateProduct(UpdateProductRequest req)
                                    throws TencentCloudSDKException
```
    提供修改产品信息及数据模板的能力。
    
    参数:
    
    req - UpdateProductRequest
    
    返回:
    
    UpdateProductResponse
    
    抛出:
    
    TencentCloudSDKException
  - UpdateRule
```
public UpdateRuleResponse UpdateRule(UpdateRuleRequest req)
                              throws TencentCloudSDKException
```
    更新规则
    
    参数:
    
    req - UpdateRuleRequest
    
    返回:
    
    UpdateRuleResponse
    
    抛出:
    
    TencentCloudSDKException

类 IotClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

IotClient

IotClient

方法详细资料

ActivateRule

AddDevice

AddProduct

AddRule

AddTopic

AddUser

AppAddUser

DeactivateRule

DeleteDevice

DeleteProduct

DeleteRule

DeleteTopic

GetDataHistory

GetDevice

GetDeviceData

GetDeviceLog

GetDeviceStatuses

GetDevices

GetProduct

GetProducts

GetRule

GetRules

GetTopic

GetTopics

GetUser

IssueDeviceControl

PublishMsg

ResetDevice

UpdateProduct

UpdateRule