com.tencentcloudapi.mongodb.v20190725.models.DescribeDBInstancesRequest 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.mongodb.v20190725.models;

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

public class DescribeDBInstancesRequest extends AbstractModel {

    /**
    * List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.
    */
    @SerializedName("InstanceIds")
    @Expose
    private String [] InstanceIds;

    /**
    * Instance type. Valid values: `0`: All instances. 
`1`: Regular instances. 
`2`: Temp instances. 
`3`: Read-only instances. 
`-1`: Regular instances, read-only instances, disaster recovery instances.
    */
    @SerializedName("InstanceType")
    @Expose
    private Long InstanceType;

    /**
    * Cluster type. Valid values: `0`: Replica set instances. 
`1`: Sharded cluster instances. 
`-1`: All instances.
    */
    @SerializedName("ClusterType")
    @Expose
    private Long ClusterType;

    /**
    * Instance status. Valid values: `0`: To be initialized. 
`1`: In process. 
`2`: Valid. 
`-2`: Isolated (for monthly subscribed instances). 
`-3`: Isolated (for pay-as-you-go instances).
    */
    @SerializedName("Status")
    @Expose
    private Long [] Status;

    /**
    * VPC ID. This parameter can be left empty for the classic network.
    */
    @SerializedName("VpcId")
    @Expose
    private String VpcId;

    /**
    * Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.
    */
    @SerializedName("SubnetId")
    @Expose
    private String SubnetId;

    /**
    * Billing type. Valid value: 0 (pay-as-you-go)
    */
    @SerializedName("PayMode")
    @Expose
    private Long PayMode;

    /**
    * Number of results returned per request. Default value: `20`. Value range: [1,100].
    */
    @SerializedName("Limit")
    @Expose
    private Long Limit;

    /**
    * Offset. Default value: `0`.
    */
    @SerializedName("Offset")
    @Expose
    private Long Offset;

    /**
    * Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.
    */
    @SerializedName("OrderBy")
    @Expose
    private String OrderBy;

    /**
    * Sorting method of the return result set. Valid values: `ASC`, `DESC`.
    */
    @SerializedName("OrderByType")
    @Expose
    private String OrderByType;

    /**
    * Project ID
    */
    @SerializedName("ProjectIds")
    @Expose
    private Long [] ProjectIds;

    /**
    * Search keyword, which can be instance ID, instance name, or complete IP.
    */
    @SerializedName("SearchKey")
    @Expose
    private String SearchKey;

    /**
    * Tag information
    */
    @SerializedName("Tags")
    @Expose
    private TagInfo [] Tags;

    /**
     * Get List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page. 
     * @return InstanceIds List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.
     */
    public String [] getInstanceIds() {
        return this.InstanceIds;
    }

    /**
     * Set List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.
     * @param InstanceIds List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB console page.
     */
    public void setInstanceIds(String [] InstanceIds) {
        this.InstanceIds = InstanceIds;
    }

    /**
     * Get Instance type. Valid values: `0`: All instances. 
`1`: Regular instances. 
`2`: Temp instances. 
`3`: Read-only instances. 
`-1`: Regular instances, read-only instances, disaster recovery instances. 
     * @return InstanceType Instance type. Valid values: `0`: All instances. 
`1`: Regular instances. 
`2`: Temp instances. 
`3`: Read-only instances. 
`-1`: Regular instances, read-only instances, disaster recovery instances.
     */
    public Long getInstanceType() {
        return this.InstanceType;
    }

    /**
     * Set Instance type. Valid values: `0`: All instances. 
`1`: Regular instances. 
`2`: Temp instances. 
`3`: Read-only instances. 
`-1`: Regular instances, read-only instances, disaster recovery instances.
     * @param InstanceType Instance type. Valid values: `0`: All instances. 
`1`: Regular instances. 
`2`: Temp instances. 
`3`: Read-only instances. 
`-1`: Regular instances, read-only instances, disaster recovery instances.
     */
    public void setInstanceType(Long InstanceType) {
        this.InstanceType = InstanceType;
    }

    /**
     * Get Cluster type. Valid values: `0`: Replica set instances. 
`1`: Sharded cluster instances. 
`-1`: All instances. 
     * @return ClusterType Cluster type. Valid values: `0`: Replica set instances. 
`1`: Sharded cluster instances. 
`-1`: All instances.
     */
    public Long getClusterType() {
        return this.ClusterType;
    }

    /**
     * Set Cluster type. Valid values: `0`: Replica set instances. 
`1`: Sharded cluster instances. 
`-1`: All instances.
     * @param ClusterType Cluster type. Valid values: `0`: Replica set instances. 
`1`: Sharded cluster instances. 
`-1`: All instances.
     */
    public void setClusterType(Long ClusterType) {
        this.ClusterType = ClusterType;
    }

    /**
     * Get Instance status. Valid values: `0`: To be initialized. 
`1`: In process. 
`2`: Valid. 
`-2`: Isolated (for monthly subscribed instances). 
`-3`: Isolated (for pay-as-you-go instances). 
     * @return Status Instance status. Valid values: `0`: To be initialized. 
`1`: In process. 
`2`: Valid. 
`-2`: Isolated (for monthly subscribed instances). 
`-3`: Isolated (for pay-as-you-go instances).
     */
    public Long [] getStatus() {
        return this.Status;
    }

    /**
     * Set Instance status. Valid values: `0`: To be initialized. 
`1`: In process. 
`2`: Valid. 
`-2`: Isolated (for monthly subscribed instances). 
`-3`: Isolated (for pay-as-you-go instances).
     * @param Status Instance status. Valid values: `0`: To be initialized. 
`1`: In process. 
`2`: Valid. 
`-2`: Isolated (for monthly subscribed instances). 
`-3`: Isolated (for pay-as-you-go instances).
     */
    public void setStatus(Long [] Status) {
        this.Status = Status;
    }

    /**
     * Get VPC ID. This parameter can be left empty for the classic network. 
     * @return VpcId VPC ID. This parameter can be left empty for the classic network.
     */
    public String getVpcId() {
        return this.VpcId;
    }

    /**
     * Set VPC ID. This parameter can be left empty for the classic network.
     * @param VpcId VPC ID. This parameter can be left empty for the classic network.
     */
    public void setVpcId(String VpcId) {
        this.VpcId = VpcId;
    }

    /**
     * Get Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set. 
     * @return SubnetId Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.
     */
    public String getSubnetId() {
        return this.SubnetId;
    }

    /**
     * Set Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.
     * @param SubnetId Subnet ID of VPC. This parameter can be left empty for the classic network. If it is passed in as an input parameter, the corresponding VpcId must be set.
     */
    public void setSubnetId(String SubnetId) {
        this.SubnetId = SubnetId;
    }

    /**
     * Get Billing type. Valid value: 0 (pay-as-you-go) 
     * @return PayMode Billing type. Valid value: 0 (pay-as-you-go)
     */
    public Long getPayMode() {
        return this.PayMode;
    }

    /**
     * Set Billing type. Valid value: 0 (pay-as-you-go)
     * @param PayMode Billing type. Valid value: 0 (pay-as-you-go)
     */
    public void setPayMode(Long PayMode) {
        this.PayMode = PayMode;
    }

    /**
     * Get Number of results returned per request. Default value: `20`. Value range: [1,100]. 
     * @return Limit Number of results returned per request. Default value: `20`. Value range: [1,100].
     */
    public Long getLimit() {
        return this.Limit;
    }

    /**
     * Set Number of results returned per request. Default value: `20`. Value range: [1,100].
     * @param Limit Number of results returned per request. Default value: `20`. Value range: [1,100].
     */
    public void setLimit(Long Limit) {
        this.Limit = Limit;
    }

    /**
     * Get Offset. Default value: `0`. 
     * @return Offset Offset. Default value: `0`.
     */
    public Long getOffset() {
        return this.Offset;
    }

    /**
     * Set Offset. Default value: `0`.
     * @param Offset Offset. Default value: `0`.
     */
    public void setOffset(Long Offset) {
        this.Offset = Offset;
    }

    /**
     * Get Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default. 
     * @return OrderBy Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.
     */
    public String getOrderBy() {
        return this.OrderBy;
    }

    /**
     * Set Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.
     * @param OrderBy Sort by field of the returned result set. Valid values: `ProjectId`, `InstanceName`, `CreateTime`. The return results are sorted in ascending order by default.
     */
    public void setOrderBy(String OrderBy) {
        this.OrderBy = OrderBy;
    }

    /**
     * Get Sorting method of the return result set. Valid values: `ASC`, `DESC`. 
     * @return OrderByType Sorting method of the return result set. Valid values: `ASC`, `DESC`.
     */
    public String getOrderByType() {
        return this.OrderByType;
    }

    /**
     * Set Sorting method of the return result set. Valid values: `ASC`, `DESC`.
     * @param OrderByType Sorting method of the return result set. Valid values: `ASC`, `DESC`.
     */
    public void setOrderByType(String OrderByType) {
        this.OrderByType = OrderByType;
    }

    /**
     * Get Project ID 
     * @return ProjectIds Project ID
     */
    public Long [] getProjectIds() {
        return this.ProjectIds;
    }

    /**
     * Set Project ID
     * @param ProjectIds Project ID
     */
    public void setProjectIds(Long [] ProjectIds) {
        this.ProjectIds = ProjectIds;
    }

    /**
     * Get Search keyword, which can be instance ID, instance name, or complete IP. 
     * @return SearchKey Search keyword, which can be instance ID, instance name, or complete IP.
     */
    public String getSearchKey() {
        return this.SearchKey;
    }

    /**
     * Set Search keyword, which can be instance ID, instance name, or complete IP.
     * @param SearchKey Search keyword, which can be instance ID, instance name, or complete IP.
     */
    public void setSearchKey(String SearchKey) {
        this.SearchKey = SearchKey;
    }

    /**
     * Get Tag information 
     * @return Tags Tag information
     */
    public TagInfo [] getTags() {
        return this.Tags;
    }

    /**
     * Set Tag information
     * @param Tags Tag information
     */
    public void setTags(TagInfo [] Tags) {
        this.Tags = Tags;
    }

    public DescribeDBInstancesRequest() {
    }

    /**
     * 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 DescribeDBInstancesRequest(DescribeDBInstancesRequest source) {
        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.InstanceType != null) {
            this.InstanceType = new Long(source.InstanceType);
        }
        if (source.ClusterType != null) {
            this.ClusterType = new Long(source.ClusterType);
        }
        if (source.Status != null) {
            this.Status = new Long[source.Status.length];
            for (int i = 0; i < source.Status.length; i++) {
                this.Status[i] = new Long(source.Status[i]);
            }
        }
        if (source.VpcId != null) {
            this.VpcId = new String(source.VpcId);
        }
        if (source.SubnetId != null) {
            this.SubnetId = new String(source.SubnetId);
        }
        if (source.PayMode != null) {
            this.PayMode = new Long(source.PayMode);
        }
        if (source.Limit != null) {
            this.Limit = new Long(source.Limit);
        }
        if (source.Offset != null) {
            this.Offset = new Long(source.Offset);
        }
        if (source.OrderBy != null) {
            this.OrderBy = new String(source.OrderBy);
        }
        if (source.OrderByType != null) {
            this.OrderByType = new String(source.OrderByType);
        }
        if (source.ProjectIds != null) {
            this.ProjectIds = new Long[source.ProjectIds.length];
            for (int i = 0; i < source.ProjectIds.length; i++) {
                this.ProjectIds[i] = new Long(source.ProjectIds[i]);
            }
        }
        if (source.SearchKey != null) {
            this.SearchKey = new String(source.SearchKey);
        }
        if (source.Tags != null) {
            this.Tags = new TagInfo[source.Tags.length];
            for (int i = 0; i < source.Tags.length; i++) {
                this.Tags[i] = new TagInfo(source.Tags[i]);
            }
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamArraySimple(map, prefix + "InstanceIds.", this.InstanceIds);
        this.setParamSimple(map, prefix + "InstanceType", this.InstanceType);
        this.setParamSimple(map, prefix + "ClusterType", this.ClusterType);
        this.setParamArraySimple(map, prefix + "Status.", this.Status);
        this.setParamSimple(map, prefix + "VpcId", this.VpcId);
        this.setParamSimple(map, prefix + "SubnetId", this.SubnetId);
        this.setParamSimple(map, prefix + "PayMode", this.PayMode);
        this.setParamSimple(map, prefix + "Limit", this.Limit);
        this.setParamSimple(map, prefix + "Offset", this.Offset);
        this.setParamSimple(map, prefix + "OrderBy", this.OrderBy);
        this.setParamSimple(map, prefix + "OrderByType", this.OrderByType);
        this.setParamArraySimple(map, prefix + "ProjectIds.", this.ProjectIds);
        this.setParamSimple(map, prefix + "SearchKey", this.SearchKey);
        this.setParamArrayObj(map, prefix + "Tags.", this.Tags);

    }
}