物接入IoT Hub

    模板管理

    创建模板

    创建模板可以参考代码如下:

    String schemaName = "schema_name";    // 设置创建的模板名字
    String description = "description";   // 设置创建的模板描述
     
    String propertyName = "property_name";                                    // 设置属性名称
    String displayName = "display_name";                                  // 设置属性显示名称
    String unit = "unit";                                                 // 设置属性单位
    String defaultValue = "default_value";                                    // 设置属性默认值
    SchemaProperty.PropertyType type = SchemaProperty.PropertyType.STRING;  // 设置属性类型,支持数字/布尔值/字符串
    // 设置模板属性
    SchemaProperty property = new SchemaProperty()
            .withName(propertyName)
            .withDisplayName(DISPLAY_NAME)
            .withUnit(UNIT)
            .withDefaultValue(defaultValue)
            .withType(type);
     
    // 设置模板属性列表
    List<SchemaProperty> properties = Arrays.asList(property);
    SchemaCreateRequest request = new SchemaCreateRequest()
            .withName(schemaName)
            .withDescription(description)
            .withProperties(properties);
     
    SchemaCreateResponse response = client.createSchema(request);
     
    String schemaId = response.getSchemaId();   // 创建的模板ID

    删除模板

    删除模板可以参考代码如下:

    String schemaId = "schema_id";    // 设置需要删除的模板ID
     
    client.deleteSchema(schemaId); 

    更新模板

    更新模板可以参考代码如下:

    String schemaId = "schemaId"; // 设置需要更新的模板ID
     
    String description = "new_description"    // 设置变更的模板描述
     
    String propertyName = "new_property_name"                                    // 设置变更的属性名称
    String displayName = "new_display_name"                                  // 设置变更的属性显示名称
    String unit = "new_unit";                                                 // 设置变更的属性单位
    String defaultValue = "new_default_value";                                    // 设置变更的属性默认值
    SchemaProperty.PropertyType type = SchemaProperty.PropertyType.STRING;      // 设置变更的属性类型,支持数字/布尔值/字符串
    // 设置变更的模板属性
    SchemaProperty property = new SchemaProperty()
            .withName(propertyName)
            .withDisplayName(DISPLAY_NAME)
            .withUnit(UNIT)
            .withDefaultValue(defaultValue)
            .withType(type);
     
    // 设置变更的模板属性列表
    List<SchemaProperty> properties = Arrays.asList(property);
     
    SchemaUpdateRequest request = new SchemaUpdateRequest()
            .withDescription(description)
            .withProperties(properties);
     
    client.updateSchema(schemaId, request);

    获取模板详情

    获取模板详情可以参考代码如下:

    String schemaId = "schema_id";    // 需要查询的模板ID
     
    SchemaResponse response = client.getSchema(schemaId);
     
    String id = response.getId();                               // 模板ID
    String name = response.getName();                           // 模板的名称
    String description = response.getDescription();             // 模板的描述
    long createTime = response.getCreateTime();                 // 模板的创建时间
    long lastUpdatedTime = response.getLastUpdatedTime();       // 模板最后一次更新时间
    List<SchemaProperty> properties = response.getProperties();   // 模板的属性列表

    获取及查询模板列表

    获取及查询模板列表可以参考代码如下:

    int pageNo = 1;                 // 设置需要获取所有查询结果的第几页
    int pageSize = 10;              // 设置每页返回的最大个数
    String order = "desc";            // 设置按照升序、降序排列结果,支持asc/desc
    String orderBy = "createTime";    // 设置排序的索引列,支持name/createTime/lastUpdatedTime
    String key = "schema_name";       // 查询关键字,支持模板名称/模板描述
     
    SchemaListResponse response = client.getSchemas(pageNo, pageSize, orderBy, order, key);
     
    int totalCount = response.getTotalCount();  // 满足查询条件的模版数目
    int pageNo = response.getPageNo();          // 当前页页码
    int pageSize = response.getPageSize();      // 返回的每页的最大个数
    List<Schema> result = response.getResult();   // 当前页模板详情列表
    上一篇
    设备管理
    下一篇
    权限组管理