IotcloudClient (tencentcloud-sdk-java 3.0.103 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.iotcloud.v20180614.IotcloudClient

public class IotcloudClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`IotcloudClient(Credential credential, String region)` 构造client
`IotcloudClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BindDevicesResponse`	`BindDevices(BindDevicesRequest req)` 本接口（BindDevices）用于网关设备批量绑定子设备
`CancelTaskResponse`	`CancelTask(CancelTaskRequest req)` 本接口（CancelTask）用于取消一个未被调度的任务。
`CreateDeviceResponse`	`CreateDevice(CreateDeviceRequest req)` 本接口（CreateDevice）用于新建一个物联网通信设备。
`CreateLoraDeviceResponse`	`CreateLoraDevice(CreateLoraDeviceRequest req)` 创建lora类型的设备
`CreateMultiDeviceResponse`	`CreateMultiDevice(CreateMultiDeviceRequest req)` 本接口（CreateMultiDevice）用于批量创建物联云设备。
`CreateProductResponse`	`CreateProduct(CreateProductRequest req)` 本接口（CreateProduct）用于创建一个新的物联网通信产品
`CreateTaskResponse`	`CreateTask(CreateTaskRequest req)` 本接口（CreateTask）用于创建一个批量任务。目前此接口可以创建批量更新影子以及批量下发消息的任务
`CreateTopicPolicyResponse`	`CreateTopicPolicy(CreateTopicPolicyRequest req)` 本接口（CreateTopicPolicy）用于创建一个Topic
`CreateTopicRuleResponse`	`CreateTopicRule(CreateTopicRuleRequest req)` 本接口（CreateTopicRule）用于创建一个规则
`DeleteDeviceResponse`	`DeleteDevice(DeleteDeviceRequest req)` 本接口（DeleteDevice）用于删除物联网通信设备。
`DeleteLoraDeviceResponse`	`DeleteLoraDevice(DeleteLoraDeviceRequest req)` 删除lora类型的设备
`DeleteProductResponse`	`DeleteProduct(DeleteProductRequest req)` 本接口（DeleteProduct）用于删除一个物联网通信产品。
`DeleteTopicRuleResponse`	`DeleteTopicRule(DeleteTopicRuleRequest req)` 本接口（DeleteTopicRule）用于删除规则
`DescribeDeviceResponse`	`DescribeDevice(DescribeDeviceRequest req)` 本接口（DescribeDevice）用于查看设备信息
`DescribeDeviceClientKeyResponse`	`DescribeDeviceClientKey(DescribeDeviceClientKeyRequest req)` 获取证书认证类型设备的私钥，刚生成或者重置设备后仅可调用一次
`DescribeDevicesResponse`	`DescribeDevices(DescribeDevicesRequest req)` 本接口（DescribeDevices）用于查询物联网通信设备的设备列表。
`DescribeDeviceShadowResponse`	`DescribeDeviceShadow(DescribeDeviceShadowRequest req)` 本接口（DescribeDeviceShadow）用于查询虚拟设备信息。
`DescribeLoraDeviceResponse`	`DescribeLoraDevice(DescribeLoraDeviceRequest req)` 获取lora类型设备的详细信息
`DescribeMultiDevicesResponse`	`DescribeMultiDevices(DescribeMultiDevicesRequest req)` 本接口（DescribeMultiDevices）用于查询批量创建设备的执行结果。
`DescribeMultiDevTaskResponse`	`DescribeMultiDevTask(DescribeMultiDevTaskRequest req)` 本接口（DescribeMultiDevTask）用于查询批量创建设备任务的执行状态。
`DescribeProductsResponse`	`DescribeProducts(DescribeProductsRequest req)` 本接口（DescribeProducts）用于列出产品列表。
`DescribeTaskResponse`	`DescribeTask(DescribeTaskRequest req)` 本接口（DescribeTask）用于查询一个已创建任务的详情，任务保留一个月
`DescribeTasksResponse`	`DescribeTasks(DescribeTasksRequest req)` 本接口（DescribeTasks）用于查询已创建的任务列表，任务保留一个月
`DisableTopicRuleResponse`	`DisableTopicRule(DisableTopicRuleRequest req)` 本接口（DisableTopicRule）用于禁用规则
`EnableTopicRuleResponse`	`EnableTopicRule(EnableTopicRuleRequest req)` 本接口（EnableTopicRule）用于启用规则
`PublishAsDeviceResponse`	`PublishAsDevice(PublishAsDeviceRequest req)` 模拟lora类型的设备端向服务器端发送消息
`PublishMessageResponse`	`PublishMessage(PublishMessageRequest req)` 本接口（PublishMessage）用于向某个主题发消息。
`PublishToDeviceResponse`	`PublishToDevice(PublishToDeviceRequest req)` 服务器端下发消息给lora类型的设备
`ReplaceTopicRuleResponse`	`ReplaceTopicRule(ReplaceTopicRuleRequest req)` 本接口（ReplaceTopicRule）用于修改替换规则
`ResetDeviceStateResponse`	`ResetDeviceState(ResetDeviceStateRequest req)` 重置设备的连接状态
`UnbindDevicesResponse`	`UnbindDevices(UnbindDevicesRequest req)` 本接口（UnbindDevices）用于网关设备批量解绑子设备
`UpdateDeviceAvailableStateResponse`	`UpdateDeviceAvailableState(UpdateDeviceAvailableStateRequest req)` 启用或者禁用设备
`UpdateDeviceShadowResponse`	`UpdateDeviceShadow(UpdateDeviceShadowRequest req)` 本接口（UpdateDeviceShadow）用于更新虚拟设备信息。
`UpdateTopicPolicyResponse`	`UpdateTopicPolicy(UpdateTopicPolicyRequest req)` 本接口（UpdateTopicPolicy）用于更新Topic信息

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IotcloudClient
```
public IotcloudClient(Credential credential,
                      String region)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - IotcloudClient
```
public IotcloudClient(Credential credential,
                      String region,
                      ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - BindDevices
```
public BindDevicesResponse BindDevices(BindDevicesRequest req)
                                throws TencentCloudSDKException
```
    本接口（BindDevices）用于网关设备批量绑定子设备
    
    Parameters:
    
    req - BindDevicesRequest
    
    Returns:
    
    BindDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - CancelTask
```
public CancelTaskResponse CancelTask(CancelTaskRequest req)
                              throws TencentCloudSDKException
```
    本接口（CancelTask）用于取消一个未被调度的任务。
    
    Parameters:
    
    req - CancelTaskRequest
    
    Returns:
    
    CancelTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDevice
```
public CreateDeviceResponse CreateDevice(CreateDeviceRequest req)
                                  throws TencentCloudSDKException
```
    本接口（CreateDevice）用于新建一个物联网通信设备。
    
    Parameters:
    
    req - CreateDeviceRequest
    
    Returns:
    
    CreateDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateLoraDevice
```
public CreateLoraDeviceResponse CreateLoraDevice(CreateLoraDeviceRequest req)
                                          throws TencentCloudSDKException
```
    创建lora类型的设备
    
    Parameters:
    
    req - CreateLoraDeviceRequest
    
    Returns:
    
    CreateLoraDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateMultiDevice
```
public CreateMultiDeviceResponse CreateMultiDevice(CreateMultiDeviceRequest req)
                                            throws TencentCloudSDKException
```
    本接口（CreateMultiDevice）用于批量创建物联云设备。
    
    Parameters:
    
    req - CreateMultiDeviceRequest
    
    Returns:
    
    CreateMultiDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateProduct
```
public CreateProductResponse CreateProduct(CreateProductRequest req)
                                    throws TencentCloudSDKException
```
    本接口（CreateProduct）用于创建一个新的物联网通信产品
    
    Parameters:
    
    req - CreateProductRequest
    
    Returns:
    
    CreateProductResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTask
```
public CreateTaskResponse CreateTask(CreateTaskRequest req)
                              throws TencentCloudSDKException
```
    本接口（CreateTask）用于创建一个批量任务。目前此接口可以创建批量更新影子以及批量下发消息的任务
    
    Parameters:
    
    req - CreateTaskRequest
    
    Returns:
    
    CreateTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTopicPolicy
```
public CreateTopicPolicyResponse CreateTopicPolicy(CreateTopicPolicyRequest req)
                                            throws TencentCloudSDKException
```
    本接口（CreateTopicPolicy）用于创建一个Topic
    
    Parameters:
    
    req - CreateTopicPolicyRequest
    
    Returns:
    
    CreateTopicPolicyResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTopicRule
```
public CreateTopicRuleResponse CreateTopicRule(CreateTopicRuleRequest req)
                                        throws TencentCloudSDKException
```
    本接口（CreateTopicRule）用于创建一个规则
    
    Parameters:
    
    req - CreateTopicRuleRequest
    
    Returns:
    
    CreateTopicRuleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteDevice
```
public DeleteDeviceResponse DeleteDevice(DeleteDeviceRequest req)
                                  throws TencentCloudSDKException
```
    本接口（DeleteDevice）用于删除物联网通信设备。
    
    Parameters:
    
    req - DeleteDeviceRequest
    
    Returns:
    
    DeleteDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteLoraDevice
```
public DeleteLoraDeviceResponse DeleteLoraDevice(DeleteLoraDeviceRequest req)
                                          throws TencentCloudSDKException
```
    删除lora类型的设备
    
    Parameters:
    
    req - DeleteLoraDeviceRequest
    
    Returns:
    
    DeleteLoraDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteProduct
```
public DeleteProductResponse DeleteProduct(DeleteProductRequest req)
                                    throws TencentCloudSDKException
```
    本接口（DeleteProduct）用于删除一个物联网通信产品。
    
    Parameters:
    
    req - DeleteProductRequest
    
    Returns:
    
    DeleteProductResponse
    
    Throws:
    
    TencentCloudSDKException
  - DeleteTopicRule
```
public DeleteTopicRuleResponse DeleteTopicRule(DeleteTopicRuleRequest req)
                                        throws TencentCloudSDKException
```
    本接口（DeleteTopicRule）用于删除规则
    
    Parameters:
    
    req - DeleteTopicRuleRequest
    
    Returns:
    
    DeleteTopicRuleResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDevice
```
public DescribeDeviceResponse DescribeDevice(DescribeDeviceRequest req)
                                      throws TencentCloudSDKException
```
    本接口（DescribeDevice）用于查看设备信息
    
    Parameters:
    
    req - DescribeDeviceRequest
    
    Returns:
    
    DescribeDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceClientKey
```
public DescribeDeviceClientKeyResponse DescribeDeviceClientKey(DescribeDeviceClientKeyRequest req)
                                                        throws TencentCloudSDKException
```
    获取证书认证类型设备的私钥，刚生成或者重置设备后仅可调用一次
    
    Parameters:
    
    req - DescribeDeviceClientKeyRequest
    
    Returns:
    
    DescribeDeviceClientKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDeviceShadow
```
public DescribeDeviceShadowResponse DescribeDeviceShadow(DescribeDeviceShadowRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（DescribeDeviceShadow）用于查询虚拟设备信息。
    
    Parameters:
    
    req - DescribeDeviceShadowRequest
    
    Returns:
    
    DescribeDeviceShadowResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDevices
```
public DescribeDevicesResponse DescribeDevices(DescribeDevicesRequest req)
                                        throws TencentCloudSDKException
```
    本接口（DescribeDevices）用于查询物联网通信设备的设备列表。
    
    Parameters:
    
    req - DescribeDevicesRequest
    
    Returns:
    
    DescribeDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeLoraDevice
```
public DescribeLoraDeviceResponse DescribeLoraDevice(DescribeLoraDeviceRequest req)
                                              throws TencentCloudSDKException
```
    获取lora类型设备的详细信息
    
    Parameters:
    
    req - DescribeLoraDeviceRequest
    
    Returns:
    
    DescribeLoraDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMultiDevTask
```
public DescribeMultiDevTaskResponse DescribeMultiDevTask(DescribeMultiDevTaskRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（DescribeMultiDevTask）用于查询批量创建设备任务的执行状态。
    
    Parameters:
    
    req - DescribeMultiDevTaskRequest
    
    Returns:
    
    DescribeMultiDevTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeMultiDevices
```
public DescribeMultiDevicesResponse DescribeMultiDevices(DescribeMultiDevicesRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（DescribeMultiDevices）用于查询批量创建设备的执行结果。
    
    Parameters:
    
    req - DescribeMultiDevicesRequest
    
    Returns:
    
    DescribeMultiDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeProducts
```
public DescribeProductsResponse DescribeProducts(DescribeProductsRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DescribeProducts）用于列出产品列表。
    
    Parameters:
    
    req - DescribeProductsRequest
    
    Returns:
    
    DescribeProductsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTask
```
public DescribeTaskResponse DescribeTask(DescribeTaskRequest req)
                                  throws TencentCloudSDKException
```
    本接口（DescribeTask）用于查询一个已创建任务的详情，任务保留一个月
    
    Parameters:
    
    req - DescribeTaskRequest
    
    Returns:
    
    DescribeTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTasks
```
public DescribeTasksResponse DescribeTasks(DescribeTasksRequest req)
                                    throws TencentCloudSDKException
```
    本接口（DescribeTasks）用于查询已创建的任务列表，任务保留一个月
    
    Parameters:
    
    req - DescribeTasksRequest
    
    Returns:
    
    DescribeTasksResponse
    
    Throws:
    
    TencentCloudSDKException
  - DisableTopicRule
```
public DisableTopicRuleResponse DisableTopicRule(DisableTopicRuleRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DisableTopicRule）用于禁用规则
    
    Parameters:
    
    req - DisableTopicRuleRequest
    
    Returns:
    
    DisableTopicRuleResponse
    
    Throws:
    
    TencentCloudSDKException
  - EnableTopicRule
```
public EnableTopicRuleResponse EnableTopicRule(EnableTopicRuleRequest req)
                                        throws TencentCloudSDKException
```
    本接口（EnableTopicRule）用于启用规则
    
    Parameters:
    
    req - EnableTopicRuleRequest
    
    Returns:
    
    EnableTopicRuleResponse
    
    Throws:
    
    TencentCloudSDKException
  - PublishAsDevice
```
public PublishAsDeviceResponse PublishAsDevice(PublishAsDeviceRequest req)
                                        throws TencentCloudSDKException
```
    模拟lora类型的设备端向服务器端发送消息
    
    Parameters:
    
    req - PublishAsDeviceRequest
    
    Returns:
    
    PublishAsDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - PublishMessage
```
public PublishMessageResponse PublishMessage(PublishMessageRequest req)
                                      throws TencentCloudSDKException
```
    本接口（PublishMessage）用于向某个主题发消息。
    
    Parameters:
    
    req - PublishMessageRequest
    
    Returns:
    
    PublishMessageResponse
    
    Throws:
    
    TencentCloudSDKException
  - PublishToDevice
```
public PublishToDeviceResponse PublishToDevice(PublishToDeviceRequest req)
                                        throws TencentCloudSDKException
```
    服务器端下发消息给lora类型的设备
    
    Parameters:
    
    req - PublishToDeviceRequest
    
    Returns:
    
    PublishToDeviceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ReplaceTopicRule
```
public ReplaceTopicRuleResponse ReplaceTopicRule(ReplaceTopicRuleRequest req)
                                          throws TencentCloudSDKException
```
    本接口（ReplaceTopicRule）用于修改替换规则
    
    Parameters:
    
    req - ReplaceTopicRuleRequest
    
    Returns:
    
    ReplaceTopicRuleResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetDeviceState
```
public ResetDeviceStateResponse ResetDeviceState(ResetDeviceStateRequest req)
                                          throws TencentCloudSDKException
```
    重置设备的连接状态
    
    Parameters:
    
    req - ResetDeviceStateRequest
    
    Returns:
    
    ResetDeviceStateResponse
    
    Throws:
    
    TencentCloudSDKException
  - UnbindDevices
```
public UnbindDevicesResponse UnbindDevices(UnbindDevicesRequest req)
                                    throws TencentCloudSDKException
```
    本接口（UnbindDevices）用于网关设备批量解绑子设备
    
    Parameters:
    
    req - UnbindDevicesRequest
    
    Returns:
    
    UnbindDevicesResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDeviceAvailableState
```
public UpdateDeviceAvailableStateResponse UpdateDeviceAvailableState(UpdateDeviceAvailableStateRequest req)
                                                              throws TencentCloudSDKException
```
    启用或者禁用设备
    
    Parameters:
    
    req - UpdateDeviceAvailableStateRequest
    
    Returns:
    
    UpdateDeviceAvailableStateResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateDeviceShadow
```
public UpdateDeviceShadowResponse UpdateDeviceShadow(UpdateDeviceShadowRequest req)
                                              throws TencentCloudSDKException
```
    本接口（UpdateDeviceShadow）用于更新虚拟设备信息。
    
    Parameters:
    
    req - UpdateDeviceShadowRequest
    
    Returns:
    
    UpdateDeviceShadowResponse
    
    Throws:
    
    TencentCloudSDKException
  - UpdateTopicPolicy
```
public UpdateTopicPolicyResponse UpdateTopicPolicy(UpdateTopicPolicyRequest req)
                                            throws TencentCloudSDKException
```
    本接口（UpdateTopicPolicy）用于更新Topic信息
    
    Parameters:
    
    req - UpdateTopicPolicyRequest
    
    Returns:
    
    UpdateTopicPolicyResponse
    
    Throws:
    
    TencentCloudSDKException

Class IotcloudClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

IotcloudClient

IotcloudClient

Method Detail

BindDevices

CancelTask

CreateDevice

CreateLoraDevice

CreateMultiDevice

CreateProduct

CreateTask

CreateTopicPolicy

CreateTopicRule

DeleteDevice

DeleteLoraDevice

DeleteProduct

DeleteTopicRule

DescribeDevice

DescribeDeviceClientKey

DescribeDeviceShadow

DescribeDevices

DescribeLoraDevice

DescribeMultiDevTask

DescribeMultiDevices

DescribeProducts

DescribeTask

DescribeTasks

DisableTopicRule

EnableTopicRule

PublishAsDevice

PublishMessage

PublishToDevice

ReplaceTopicRule

ResetDeviceState

UnbindDevices

UpdateDeviceAvailableState

UpdateDeviceShadow

UpdateTopicPolicy