com.aliyun.iot20180120.models.QueryDeviceByStatusRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iot20180120 Show documentation
Alibaba Cloud IoT Platform (20180120) SDK for Java
The newest version!
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.iot20180120.models;

import com.aliyun.tea.*;

public class QueryDeviceByStatusRequest extends TeaModel {
    /**
     * The number of the page to return.
     * 
     * example:
     * 1
     */
    @NameInMap("CurrentPage")
    public Integer currentPage;

    /**
     * The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.
     * Important
     * 
     * If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
     * If your instance has no Overview page or ID, you do not need to set this parameter.
     * 
     * For more information, see Overview.
     * 
     * example:
     * iot_instc_pu****_c*-v64********
     */
    @NameInMap("IotInstanceId")
    public String iotInstanceId;

    /**
     * The number of entries to return on each page. Valid values: 1 to 50.
     * 
     * example:
     * 10
     */
    @NameInMap("PageSize")
    public Integer pageSize;

    /**
     * The ProductKey of the product to which the device belongs.
     * 
     * example:
     * a1BwAGV****
     */
    @NameInMap("ProductKey")
    public String productKey;

    /**
     * The ID of the resource group to which the product belongs. You can view the resource group ID in the IoT Platform console.
     * 
     *  If you specify this parameter, the system returns devices of the specified status in the resource group. If you do not specify this parameter, the system returns all devices of the specified status in the current account.
     * 
     * 
     * example:
     * rg-acfm4l5tcwd***
     */
    @NameInMap("ResourceGroupId")
    public String resourceGroupId;

    /**
     * The status of the devices. Valid values:
     * 
     * 0: inactive
     * 1: online
     * 3: offline
     * 8: disabled
     * 
     * This parameter is required.
     * 
     * example:
     * 1
     */
    @NameInMap("Status")
    public Integer status;

    public static QueryDeviceByStatusRequest build(java.util.Map map) throws Exception {
        QueryDeviceByStatusRequest self = new QueryDeviceByStatusRequest();
        return TeaModel.build(map, self);
    }

    public QueryDeviceByStatusRequest setCurrentPage(Integer currentPage) {
        this.currentPage = currentPage;
        return this;
    }
    public Integer getCurrentPage() {
        return this.currentPage;
    }

    public QueryDeviceByStatusRequest setIotInstanceId(String iotInstanceId) {
        this.iotInstanceId = iotInstanceId;
        return this;
    }
    public String getIotInstanceId() {
        return this.iotInstanceId;
    }

    public QueryDeviceByStatusRequest setPageSize(Integer pageSize) {
        this.pageSize = pageSize;
        return this;
    }
    public Integer getPageSize() {
        return this.pageSize;
    }

    public QueryDeviceByStatusRequest setProductKey(String productKey) {
        this.productKey = productKey;
        return this;
    }
    public String getProductKey() {
        return this.productKey;
    }

    public QueryDeviceByStatusRequest setResourceGroupId(String resourceGroupId) {
        this.resourceGroupId = resourceGroupId;
        return this;
    }
    public String getResourceGroupId() {
        return this.resourceGroupId;
    }

    public QueryDeviceByStatusRequest setStatus(Integer status) {
        this.status = status;
        return this;
    }
    public Integer getStatus() {
        return this.status;
    }

}