com.tencentcloudapi.mongodb.v20180408.models.DescribeDBInstancesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-mongodb Show documentation
Show all versions of tencentcloud-sdk-java-mongodb Show documentation
Tencent Cloud Open API SDK for Java
/*
* 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.v20180408.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class DescribeDBInstancesRequest extends AbstractModel{
/**
* 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
*/
@SerializedName("InstanceIds")
@Expose
private String [] InstanceIds;
/**
* 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
*/
@SerializedName("InstanceType")
@Expose
private Long InstanceType;
/**
* 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
*/
@SerializedName("ClusterType")
@Expose
private Long ClusterType;
/**
* 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
*/
@SerializedName("Status")
@Expose
private Long [] Status;
/**
* 私有网络的ID，基础网络则不传该参数
*/
@SerializedName("VpcId")
@Expose
private String VpcId;
/**
* 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
*/
@SerializedName("SubnetId")
@Expose
private String SubnetId;
/**
* 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
*/
@SerializedName("PayMode")
@Expose
private Long PayMode;
/**
* 单次请求返回的数量，最小值为1，最大值为100，默认值为20
*/
@SerializedName("Limit")
@Expose
private Long Limit;
/**
* 偏移量，默认值为0
*/
@SerializedName("Offset")
@Expose
private Long Offset;
/**
* 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
*/
@SerializedName("OrderBy")
@Expose
private String OrderBy;
/**
* 返回结果集排序方式，目前支持："ASC"或者"DESC"
*/
@SerializedName("OrderByType")
@Expose
private String OrderByType;
/**
* Get 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
* @return InstanceIds 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
*/
public String [] getInstanceIds() {
return this.InstanceIds;
}
/**
* Set 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
* @param InstanceIds 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
*/
public void setInstanceIds(String [] InstanceIds) {
this.InstanceIds = InstanceIds;
}
/**
* Get 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
* @return InstanceType 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
*/
public Long getInstanceType() {
return this.InstanceType;
}
/**
* Set 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
* @param InstanceType 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例
*/
public void setInstanceType(Long InstanceType) {
this.InstanceType = InstanceType;
}
/**
* Get 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
* @return ClusterType 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
*/
public Long getClusterType() {
return this.ClusterType;
}
/**
* Set 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
* @param ClusterType 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例
*/
public void setClusterType(Long ClusterType) {
this.ClusterType = ClusterType;
}
/**
* Get 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
* @return Status 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
*/
public Long [] getStatus() {
return this.Status;
}
/**
* Set 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
* @param Status 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期
*/
public void setStatus(Long [] Status) {
this.Status = Status;
}
/**
* Get 私有网络的ID，基础网络则不传该参数
* @return VpcId 私有网络的ID，基础网络则不传该参数
*/
public String getVpcId() {
return this.VpcId;
}
/**
* Set 私有网络的ID，基础网络则不传该参数
* @param VpcId 私有网络的ID，基础网络则不传该参数
*/
public void setVpcId(String VpcId) {
this.VpcId = VpcId;
}
/**
* Get 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
* @return SubnetId 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
*/
public String getSubnetId() {
return this.SubnetId;
}
/**
* Set 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
* @param SubnetId 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId
*/
public void setSubnetId(String SubnetId) {
this.SubnetId = SubnetId;
}
/**
* Get 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
* @return PayMode 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
*/
public Long getPayMode() {
return this.PayMode;
}
/**
* Set 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
* @param PayMode 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月
*/
public void setPayMode(Long PayMode) {
this.PayMode = PayMode;
}
/**
* Get 单次请求返回的数量，最小值为1，最大值为100，默认值为20
* @return Limit 单次请求返回的数量，最小值为1，最大值为100，默认值为20
*/
public Long getLimit() {
return this.Limit;
}
/**
* Set 单次请求返回的数量，最小值为1，最大值为100，默认值为20
* @param Limit 单次请求返回的数量，最小值为1，最大值为100，默认值为20
*/
public void setLimit(Long Limit) {
this.Limit = Limit;
}
/**
* 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 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
* @return OrderBy 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
*/
public String getOrderBy() {
return this.OrderBy;
}
/**
* Set 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
* @param OrderBy 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序
*/
public void setOrderBy(String OrderBy) {
this.OrderBy = OrderBy;
}
/**
* Get 返回结果集排序方式，目前支持："ASC"或者"DESC"
* @return OrderByType 返回结果集排序方式，目前支持："ASC"或者"DESC"
*/
public String getOrderByType() {
return this.OrderByType;
}
/**
* Set 返回结果集排序方式，目前支持："ASC"或者"DESC"
* @param OrderByType 返回结果集排序方式，目前支持："ASC"或者"DESC"
*/
public void setOrderByType(String OrderByType) {
this.OrderByType = OrderByType;
}
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);
}
}
/**
* 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);
}
}