com.tencentcloudapi.emr.v20190103.models.DescribeInstancesRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.tencentcloudapi.emr.v20190103.models;

import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;

public class DescribeInstancesRequest extends AbstractModel{

    /**
    * Cluster filtering policy. Valid values:
clusterList: queries the list of clusters except terminated ones.
monitorManage: queries the list of clusters except those that have been terminated, are being created, or failed to be created.
cloudHardwareManage/componentManage: reserved fields with the same meaning as `monitorManage`.
    */
    @SerializedName("DisplayStrategy")
    @Expose
    private String DisplayStrategy;

    /**
    * Queries by one or more instance IDs in the format of `emr-xxxxxxxx`. For the format of this parameter, please see the `id.N` section in [API Overview](https://intl.cloud.tencent.com/document/api/213/15688). If no instance ID is entered, the list of all instances under this `APPID` will be returned.
    */
    @SerializedName("InstanceIds")
    @Expose
    private String [] InstanceIds;

    /**
    * Page number. Default value: 0, indicating the first page.
    */
    @SerializedName("Offset")
    @Expose
    private Long Offset;

    /**
    * Number of returned results per page. Default value: 10. Maximum value: 100
    */
    @SerializedName("Limit")
    @Expose
    private Long Limit;

    /**
    * ID of the project to which the instance belongs. This parameter can be obtained from the `projectId` field in the return value of the `DescribeProject` API. If this value is -1, the list of all instances will be returned.
    */
    @SerializedName("ProjectId")
    @Expose
    private Long ProjectId;

    /**
    * Sorting field. Valid values:
clusterId: sorts by cluster ID.
addTime: sorts by instance creation time.
status: sorts by instance status code.
    */
    @SerializedName("OrderField")
    @Expose
    private String OrderField;

    /**
    * Sorts according to `OrderField` in ascending or descending order. Valid values:
0: descending order.
1: ascending order.Default value: 0.
    */
    @SerializedName("Asc")
    @Expose
    private Long Asc;

    /**
     * Get Cluster filtering policy. Valid values:
clusterList: queries the list of clusters except terminated ones.
monitorManage: queries the list of clusters except those that have been terminated, are being created, or failed to be created.
cloudHardwareManage/componentManage: reserved fields with the same meaning as `monitorManage`. 
     * @return DisplayStrategy Cluster filtering policy. Valid values:
clusterList: queries the list of clusters except terminated ones.
monitorManage: queries the list of clusters except those that have been terminated, are being created, or failed to be created.
cloudHardwareManage/componentManage: reserved fields with the same meaning as `monitorManage`.
     */
    public String getDisplayStrategy() {
        return this.DisplayStrategy;
    }

    /**
     * Set Cluster filtering policy. Valid values:
clusterList: queries the list of clusters except terminated ones.
monitorManage: queries the list of clusters except those that have been terminated, are being created, or failed to be created.
cloudHardwareManage/componentManage: reserved fields with the same meaning as `monitorManage`.
     * @param DisplayStrategy Cluster filtering policy. Valid values:
clusterList: queries the list of clusters except terminated ones.
monitorManage: queries the list of clusters except those that have been terminated, are being created, or failed to be created.
cloudHardwareManage/componentManage: reserved fields with the same meaning as `monitorManage`.
     */
    public void setDisplayStrategy(String DisplayStrategy) {
        this.DisplayStrategy = DisplayStrategy;
    }

    /**
     * Get Queries by one or more instance IDs in the format of `emr-xxxxxxxx`. For the format of this parameter, please see the `id.N` section in [API Overview](https://intl.cloud.tencent.com/document/api/213/15688). If no instance ID is entered, the list of all instances under this `APPID` will be returned. 
     * @return InstanceIds Queries by one or more instance IDs in the format of `emr-xxxxxxxx`. For the format of this parameter, please see the `id.N` section in [API Overview](https://intl.cloud.tencent.com/document/api/213/15688). If no instance ID is entered, the list of all instances under this `APPID` will be returned.
     */
    public String [] getInstanceIds() {
        return this.InstanceIds;
    }

    /**
     * Set Queries by one or more instance IDs in the format of `emr-xxxxxxxx`. For the format of this parameter, please see the `id.N` section in [API Overview](https://intl.cloud.tencent.com/document/api/213/15688). If no instance ID is entered, the list of all instances under this `APPID` will be returned.
     * @param InstanceIds Queries by one or more instance IDs in the format of `emr-xxxxxxxx`. For the format of this parameter, please see the `id.N` section in [API Overview](https://intl.cloud.tencent.com/document/api/213/15688). If no instance ID is entered, the list of all instances under this `APPID` will be returned.
     */
    public void setInstanceIds(String [] InstanceIds) {
        this.InstanceIds = InstanceIds;
    }

    /**
     * Get Page number. Default value: 0, indicating the first page. 
     * @return Offset Page number. Default value: 0, indicating the first page.
     */
    public Long getOffset() {
        return this.Offset;
    }

    /**
     * Set Page number. Default value: 0, indicating the first page.
     * @param Offset Page number. Default value: 0, indicating the first page.
     */
    public void setOffset(Long Offset) {
        this.Offset = Offset;
    }

    /**
     * Get Number of returned results per page. Default value: 10. Maximum value: 100 
     * @return Limit Number of returned results per page. Default value: 10. Maximum value: 100
     */
    public Long getLimit() {
        return this.Limit;
    }

    /**
     * Set Number of returned results per page. Default value: 10. Maximum value: 100
     * @param Limit Number of returned results per page. Default value: 10. Maximum value: 100
     */
    public void setLimit(Long Limit) {
        this.Limit = Limit;
    }

    /**
     * Get ID of the project to which the instance belongs. This parameter can be obtained from the `projectId` field in the return value of the `DescribeProject` API. If this value is -1, the list of all instances will be returned. 
     * @return ProjectId ID of the project to which the instance belongs. This parameter can be obtained from the `projectId` field in the return value of the `DescribeProject` API. If this value is -1, the list of all instances will be returned.
     */
    public Long getProjectId() {
        return this.ProjectId;
    }

    /**
     * Set ID of the project to which the instance belongs. This parameter can be obtained from the `projectId` field in the return value of the `DescribeProject` API. If this value is -1, the list of all instances will be returned.
     * @param ProjectId ID of the project to which the instance belongs. This parameter can be obtained from the `projectId` field in the return value of the `DescribeProject` API. If this value is -1, the list of all instances will be returned.
     */
    public void setProjectId(Long ProjectId) {
        this.ProjectId = ProjectId;
    }

    /**
     * Get Sorting field. Valid values:
clusterId: sorts by cluster ID.
addTime: sorts by instance creation time.
status: sorts by instance status code. 
     * @return OrderField Sorting field. Valid values:
clusterId: sorts by cluster ID.
addTime: sorts by instance creation time.
status: sorts by instance status code.
     */
    public String getOrderField() {
        return this.OrderField;
    }

    /**
     * Set Sorting field. Valid values:
clusterId: sorts by cluster ID.
addTime: sorts by instance creation time.
status: sorts by instance status code.
     * @param OrderField Sorting field. Valid values:
clusterId: sorts by cluster ID.
addTime: sorts by instance creation time.
status: sorts by instance status code.
     */
    public void setOrderField(String OrderField) {
        this.OrderField = OrderField;
    }

    /**
     * Get Sorts according to `OrderField` in ascending or descending order. Valid values:
0: descending order.
1: ascending order.Default value: 0. 
     * @return Asc Sorts according to `OrderField` in ascending or descending order. Valid values:
0: descending order.
1: ascending order.Default value: 0.
     */
    public Long getAsc() {
        return this.Asc;
    }

    /**
     * Set Sorts according to `OrderField` in ascending or descending order. Valid values:
0: descending order.
1: ascending order.Default value: 0.
     * @param Asc Sorts according to `OrderField` in ascending or descending order. Valid values:
0: descending order.
1: ascending order.Default value: 0.
     */
    public void setAsc(Long Asc) {
        this.Asc = Asc;
    }

    public DescribeInstancesRequest() {
    }

    /**
     * NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
     *       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
     */
    public DescribeInstancesRequest(DescribeInstancesRequest source) {
        if (source.DisplayStrategy != null) {
            this.DisplayStrategy = new String(source.DisplayStrategy);
        }
        if (source.InstanceIds != null) {
            this.InstanceIds = new String[source.InstanceIds.length];
            for (int i = 0; i < source.InstanceIds.length; i++) {
                this.InstanceIds[i] = new String(source.InstanceIds[i]);
            }
        }
        if (source.Offset != null) {
            this.Offset = new Long(source.Offset);
        }
        if (source.Limit != null) {
            this.Limit = new Long(source.Limit);
        }
        if (source.ProjectId != null) {
            this.ProjectId = new Long(source.ProjectId);
        }
        if (source.OrderField != null) {
            this.OrderField = new String(source.OrderField);
        }
        if (source.Asc != null) {
            this.Asc = new Long(source.Asc);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamSimple(map, prefix + "DisplayStrategy", this.DisplayStrategy);
        this.setParamArraySimple(map, prefix + "InstanceIds.", this.InstanceIds);
        this.setParamSimple(map, prefix + "Offset", this.Offset);
        this.setParamSimple(map, prefix + "Limit", this.Limit);
        this.setParamSimple(map, prefix + "ProjectId", this.ProjectId);
        this.setParamSimple(map, prefix + "OrderField", this.OrderField);
        this.setParamSimple(map, prefix + "Asc", this.Asc);

    }
}