All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.tencentcloudapi.ecm.v20190719.models.DescribeInstancesRequest Maven / Gradle / Ivy

There is a newer version: 3.1.977
Show newest version
/*
 * 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.ecm.v20190719.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{

    /**
    * 过滤条件。
zone      String      是否必填:否     (过滤条件)按照可用区英文标识符过滤。
zone-name      String      是否必填:否     (过滤条件)按照可用区中文名过滤,支持模糊匹配。
module-id      String      是否必填:否     (过滤条件)按照模块ID过滤。
instance-id      String      是否必填:否      (过滤条件)按照实例ID过滤。
instance-name      String      是否必填:否      (过滤条件)按照实例名称过滤,支持模糊匹配。
ip-address      String      是否必填:否      (过滤条件)按照实例的内网/公网IP过滤。
instance-uuid   string 是否必填:否 (过滤条件)按照uuid过滤实例列表。
instance-state  string  是否必填:否 (过滤条件)按照实例状态更新实例列表。
internet-service-provider      String      是否必填:否      (过滤条件)按照实例公网IP所属的运营商进行过滤。
tag-key      String      是否必填:否      (过滤条件)按照标签键进行过滤。
tag:tag-key      String      是否必填:否      (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
instance-family      String      是否必填:否      (过滤条件)按照机型family过滤。
module-name      String      是否必填:否      (过滤条件)按照模块名称过滤,支持模糊匹配。
image-id      String      是否必填:否      (过滤条件)按照实例的镜像ID过滤。
vpc-id String      是否必填:否      (过滤条件)按照实例的vpc id过滤。
subnet-id String      是否必填:否      (过滤条件)按照实例的subnet id过滤。

若不传Filters参数则表示查询所有相关的实例信息。
单次请求的Filter.Values的上限为5。
    */
    @SerializedName("Filters")
    @Expose
    private Filter [] Filters;

    /**
    * 偏移量,默认为0。
    */
    @SerializedName("Offset")
    @Expose
    private Long Offset;

    /**
    * 返回数量,默认为20(如果查询结果数目大于等于20),最大值为100。
    */
    @SerializedName("Limit")
    @Expose
    private Long Limit;

    /**
    * 指定排序字段。目前支持的可选值如下
timestamp 按实例创建时间排序。
注意:目前仅支持按创建时间排序,后续可能会有扩展。
如果不传,默认按实例创建时间排序
    */
    @SerializedName("OrderByField")
    @Expose
    private String OrderByField;

    /**
    * 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
    */
    @SerializedName("OrderDirection")
    @Expose
    private Long OrderDirection;

    /**
     * Get 过滤条件。
zone      String      是否必填:否     (过滤条件)按照可用区英文标识符过滤。
zone-name      String      是否必填:否     (过滤条件)按照可用区中文名过滤,支持模糊匹配。
module-id      String      是否必填:否     (过滤条件)按照模块ID过滤。
instance-id      String      是否必填:否      (过滤条件)按照实例ID过滤。
instance-name      String      是否必填:否      (过滤条件)按照实例名称过滤,支持模糊匹配。
ip-address      String      是否必填:否      (过滤条件)按照实例的内网/公网IP过滤。
instance-uuid   string 是否必填:否 (过滤条件)按照uuid过滤实例列表。
instance-state  string  是否必填:否 (过滤条件)按照实例状态更新实例列表。
internet-service-provider      String      是否必填:否      (过滤条件)按照实例公网IP所属的运营商进行过滤。
tag-key      String      是否必填:否      (过滤条件)按照标签键进行过滤。
tag:tag-key      String      是否必填:否      (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
instance-family      String      是否必填:否      (过滤条件)按照机型family过滤。
module-name      String      是否必填:否      (过滤条件)按照模块名称过滤,支持模糊匹配。
image-id      String      是否必填:否      (过滤条件)按照实例的镜像ID过滤。
vpc-id String      是否必填:否      (过滤条件)按照实例的vpc id过滤。
subnet-id String      是否必填:否      (过滤条件)按照实例的subnet id过滤。

若不传Filters参数则表示查询所有相关的实例信息。
单次请求的Filter.Values的上限为5。 
     * @return Filters 过滤条件。
zone      String      是否必填:否     (过滤条件)按照可用区英文标识符过滤。
zone-name      String      是否必填:否     (过滤条件)按照可用区中文名过滤,支持模糊匹配。
module-id      String      是否必填:否     (过滤条件)按照模块ID过滤。
instance-id      String      是否必填:否      (过滤条件)按照实例ID过滤。
instance-name      String      是否必填:否      (过滤条件)按照实例名称过滤,支持模糊匹配。
ip-address      String      是否必填:否      (过滤条件)按照实例的内网/公网IP过滤。
instance-uuid   string 是否必填:否 (过滤条件)按照uuid过滤实例列表。
instance-state  string  是否必填:否 (过滤条件)按照实例状态更新实例列表。
internet-service-provider      String      是否必填:否      (过滤条件)按照实例公网IP所属的运营商进行过滤。
tag-key      String      是否必填:否      (过滤条件)按照标签键进行过滤。
tag:tag-key      String      是否必填:否      (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
instance-family      String      是否必填:否      (过滤条件)按照机型family过滤。
module-name      String      是否必填:否      (过滤条件)按照模块名称过滤,支持模糊匹配。
image-id      String      是否必填:否      (过滤条件)按照实例的镜像ID过滤。
vpc-id String      是否必填:否      (过滤条件)按照实例的vpc id过滤。
subnet-id String      是否必填:否      (过滤条件)按照实例的subnet id过滤。

若不传Filters参数则表示查询所有相关的实例信息。
单次请求的Filter.Values的上限为5。
     */
    public Filter [] getFilters() {
        return this.Filters;
    }

    /**
     * Set 过滤条件。
zone      String      是否必填:否     (过滤条件)按照可用区英文标识符过滤。
zone-name      String      是否必填:否     (过滤条件)按照可用区中文名过滤,支持模糊匹配。
module-id      String      是否必填:否     (过滤条件)按照模块ID过滤。
instance-id      String      是否必填:否      (过滤条件)按照实例ID过滤。
instance-name      String      是否必填:否      (过滤条件)按照实例名称过滤,支持模糊匹配。
ip-address      String      是否必填:否      (过滤条件)按照实例的内网/公网IP过滤。
instance-uuid   string 是否必填:否 (过滤条件)按照uuid过滤实例列表。
instance-state  string  是否必填:否 (过滤条件)按照实例状态更新实例列表。
internet-service-provider      String      是否必填:否      (过滤条件)按照实例公网IP所属的运营商进行过滤。
tag-key      String      是否必填:否      (过滤条件)按照标签键进行过滤。
tag:tag-key      String      是否必填:否      (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
instance-family      String      是否必填:否      (过滤条件)按照机型family过滤。
module-name      String      是否必填:否      (过滤条件)按照模块名称过滤,支持模糊匹配。
image-id      String      是否必填:否      (过滤条件)按照实例的镜像ID过滤。
vpc-id String      是否必填:否      (过滤条件)按照实例的vpc id过滤。
subnet-id String      是否必填:否      (过滤条件)按照实例的subnet id过滤。

若不传Filters参数则表示查询所有相关的实例信息。
单次请求的Filter.Values的上限为5。
     * @param Filters 过滤条件。
zone      String      是否必填:否     (过滤条件)按照可用区英文标识符过滤。
zone-name      String      是否必填:否     (过滤条件)按照可用区中文名过滤,支持模糊匹配。
module-id      String      是否必填:否     (过滤条件)按照模块ID过滤。
instance-id      String      是否必填:否      (过滤条件)按照实例ID过滤。
instance-name      String      是否必填:否      (过滤条件)按照实例名称过滤,支持模糊匹配。
ip-address      String      是否必填:否      (过滤条件)按照实例的内网/公网IP过滤。
instance-uuid   string 是否必填:否 (过滤条件)按照uuid过滤实例列表。
instance-state  string  是否必填:否 (过滤条件)按照实例状态更新实例列表。
internet-service-provider      String      是否必填:否      (过滤条件)按照实例公网IP所属的运营商进行过滤。
tag-key      String      是否必填:否      (过滤条件)按照标签键进行过滤。
tag:tag-key      String      是否必填:否      (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。
instance-family      String      是否必填:否      (过滤条件)按照机型family过滤。
module-name      String      是否必填:否      (过滤条件)按照模块名称过滤,支持模糊匹配。
image-id      String      是否必填:否      (过滤条件)按照实例的镜像ID过滤。
vpc-id String      是否必填:否      (过滤条件)按照实例的vpc id过滤。
subnet-id String      是否必填:否      (过滤条件)按照实例的subnet id过滤。

若不传Filters参数则表示查询所有相关的实例信息。
单次请求的Filter.Values的上限为5。
     */
    public void setFilters(Filter [] Filters) {
        this.Filters = Filters;
    }

    /**
     * Get 偏移量,默认为0。 
     * @return Offset 偏移量,默认为0。
     */
    public Long getOffset() {
        return this.Offset;
    }

    /**
     * Set 偏移量,默认为0。
     * @param Offset 偏移量,默认为0。
     */
    public void setOffset(Long Offset) {
        this.Offset = Offset;
    }

    /**
     * Get 返回数量,默认为20(如果查询结果数目大于等于20),最大值为100。 
     * @return Limit 返回数量,默认为20(如果查询结果数目大于等于20),最大值为100。
     */
    public Long getLimit() {
        return this.Limit;
    }

    /**
     * Set 返回数量,默认为20(如果查询结果数目大于等于20),最大值为100。
     * @param Limit 返回数量,默认为20(如果查询结果数目大于等于20),最大值为100。
     */
    public void setLimit(Long Limit) {
        this.Limit = Limit;
    }

    /**
     * Get 指定排序字段。目前支持的可选值如下
timestamp 按实例创建时间排序。
注意:目前仅支持按创建时间排序,后续可能会有扩展。
如果不传,默认按实例创建时间排序 
     * @return OrderByField 指定排序字段。目前支持的可选值如下
timestamp 按实例创建时间排序。
注意:目前仅支持按创建时间排序,后续可能会有扩展。
如果不传,默认按实例创建时间排序
     */
    public String getOrderByField() {
        return this.OrderByField;
    }

    /**
     * Set 指定排序字段。目前支持的可选值如下
timestamp 按实例创建时间排序。
注意:目前仅支持按创建时间排序,后续可能会有扩展。
如果不传,默认按实例创建时间排序
     * @param OrderByField 指定排序字段。目前支持的可选值如下
timestamp 按实例创建时间排序。
注意:目前仅支持按创建时间排序,后续可能会有扩展。
如果不传,默认按实例创建时间排序
     */
    public void setOrderByField(String OrderByField) {
        this.OrderByField = OrderByField;
    }

    /**
     * Get 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序 
     * @return OrderDirection 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
     */
    public Long getOrderDirection() {
        return this.OrderDirection;
    }

    /**
     * Set 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
     * @param OrderDirection 指定排序是降序还是升序。0表示降序; 1表示升序。如果不传默认为降序
     */
    public void setOrderDirection(Long OrderDirection) {
        this.OrderDirection = OrderDirection;
    }

    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.Filters != null) {
            this.Filters = new Filter[source.Filters.length];
            for (int i = 0; i < source.Filters.length; i++) {
                this.Filters[i] = new Filter(source.Filters[i]);
            }
        }
        if (source.Offset != null) {
            this.Offset = new Long(source.Offset);
        }
        if (source.Limit != null) {
            this.Limit = new Long(source.Limit);
        }
        if (source.OrderByField != null) {
            this.OrderByField = new String(source.OrderByField);
        }
        if (source.OrderDirection != null) {
            this.OrderDirection = new Long(source.OrderDirection);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamArrayObj(map, prefix + "Filters.", this.Filters);
        this.setParamSimple(map, prefix + "Offset", this.Offset);
        this.setParamSimple(map, prefix + "Limit", this.Limit);
        this.setParamSimple(map, prefix + "OrderByField", this.OrderByField);
        this.setParamSimple(map, prefix + "OrderDirection", this.OrderDirection);

    }
}





© 2015 - 2024 Weber Informatics LLC | Privacy Policy