com.tencentcloudapi.teo.v20220901.models.DescribeClientRuleListRequest 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.teo.v20220901.models;

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

public class DescribeClientRuleListRequest extends AbstractModel{

    /**
    * The ID of the site to be queried.
    */
    @SerializedName("ZoneId")
    @Expose
    private String ZoneId;

    /**
    * The subdomain name to be queried.
    */
    @SerializedName("Domain")
    @Expose
    private String Domain;

    /**
    * Rule type. Values:
`acl`: Custom rules;
`rate`: Rate limiting rules.All rules will be queried if this field is not specified.
    */
    @SerializedName("RuleType")
    @Expose
    private String RuleType;

    /**
    * The rule ID.
    */
    @SerializedName("RuleId")
    @Expose
    private Long RuleId;

    /**
    * The client IP.
    */
    @SerializedName("SourceClientIp")
    @Expose
    private String SourceClientIp;

    /**
    * Limit on paginated queries. Default value: 20. Maximum value: 1000.
    */
    @SerializedName("Limit")
    @Expose
    private Long Limit;

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

    /**
    * Data storage region. Values:
`overseas`: Global (outside the Chinese mainland);
`mainland`: Chinese mainland.If this field is not specified, the data storage region will be determined based on the user’s location.
    */
    @SerializedName("Area")
    @Expose
    private String Area;

    /**
     * Get The ID of the site to be queried. 
     * @return ZoneId The ID of the site to be queried.
     */
    public String getZoneId() {
        return this.ZoneId;
    }

    /**
     * Set The ID of the site to be queried.
     * @param ZoneId The ID of the site to be queried.
     */
    public void setZoneId(String ZoneId) {
        this.ZoneId = ZoneId;
    }

    /**
     * Get The subdomain name to be queried. 
     * @return Domain The subdomain name to be queried.
     */
    public String getDomain() {
        return this.Domain;
    }

    /**
     * Set The subdomain name to be queried.
     * @param Domain The subdomain name to be queried.
     */
    public void setDomain(String Domain) {
        this.Domain = Domain;
    }

    /**
     * Get Rule type. Values:
`acl`: Custom rules;
`rate`: Rate limiting rules.All rules will be queried if this field is not specified. 
     * @return RuleType Rule type. Values:
`acl`: Custom rules;
`rate`: Rate limiting rules.All rules will be queried if this field is not specified.
     */
    public String getRuleType() {
        return this.RuleType;
    }

    /**
     * Set Rule type. Values:
`acl`: Custom rules;
`rate`: Rate limiting rules.All rules will be queried if this field is not specified.
     * @param RuleType Rule type. Values:
`acl`: Custom rules;
`rate`: Rate limiting rules.All rules will be queried if this field is not specified.
     */
    public void setRuleType(String RuleType) {
        this.RuleType = RuleType;
    }

    /**
     * Get The rule ID. 
     * @return RuleId The rule ID.
     */
    public Long getRuleId() {
        return this.RuleId;
    }

    /**
     * Set The rule ID.
     * @param RuleId The rule ID.
     */
    public void setRuleId(Long RuleId) {
        this.RuleId = RuleId;
    }

    /**
     * Get The client IP. 
     * @return SourceClientIp The client IP.
     */
    public String getSourceClientIp() {
        return this.SourceClientIp;
    }

    /**
     * Set The client IP.
     * @param SourceClientIp The client IP.
     */
    public void setSourceClientIp(String SourceClientIp) {
        this.SourceClientIp = SourceClientIp;
    }

    /**
     * Get Limit on paginated queries. Default value: 20. Maximum value: 1000. 
     * @return Limit Limit on paginated queries. Default value: 20. Maximum value: 1000.
     */
    public Long getLimit() {
        return this.Limit;
    }

    /**
     * Set Limit on paginated queries. Default value: 20. Maximum value: 1000.
     * @param Limit Limit on paginated queries. Default value: 20. Maximum value: 1000.
     */
    public void setLimit(Long Limit) {
        this.Limit = Limit;
    }

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

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

    /**
     * Get Data storage region. Values:
`overseas`: Global (outside the Chinese mainland);
`mainland`: Chinese mainland.If this field is not specified, the data storage region will be determined based on the user’s location. 
     * @return Area Data storage region. Values:
`overseas`: Global (outside the Chinese mainland);
`mainland`: Chinese mainland.If this field is not specified, the data storage region will be determined based on the user’s location.
     */
    public String getArea() {
        return this.Area;
    }

    /**
     * Set Data storage region. Values:
`overseas`: Global (outside the Chinese mainland);
`mainland`: Chinese mainland.If this field is not specified, the data storage region will be determined based on the user’s location.
     * @param Area Data storage region. Values:
`overseas`: Global (outside the Chinese mainland);
`mainland`: Chinese mainland.If this field is not specified, the data storage region will be determined based on the user’s location.
     */
    public void setArea(String Area) {
        this.Area = Area;
    }

    public DescribeClientRuleListRequest() {
    }

    /**
     * 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 DescribeClientRuleListRequest(DescribeClientRuleListRequest source) {
        if (source.ZoneId != null) {
            this.ZoneId = new String(source.ZoneId);
        }
        if (source.Domain != null) {
            this.Domain = new String(source.Domain);
        }
        if (source.RuleType != null) {
            this.RuleType = new String(source.RuleType);
        }
        if (source.RuleId != null) {
            this.RuleId = new Long(source.RuleId);
        }
        if (source.SourceClientIp != null) {
            this.SourceClientIp = new String(source.SourceClientIp);
        }
        if (source.Limit != null) {
            this.Limit = new Long(source.Limit);
        }
        if (source.Offset != null) {
            this.Offset = new Long(source.Offset);
        }
        if (source.Area != null) {
            this.Area = new String(source.Area);
        }
    }


    /**
     * Internal implementation, normal users should not use it.
     */
    public void toMap(HashMap map, String prefix) {
        this.setParamSimple(map, prefix + "ZoneId", this.ZoneId);
        this.setParamSimple(map, prefix + "Domain", this.Domain);
        this.setParamSimple(map, prefix + "RuleType", this.RuleType);
        this.setParamSimple(map, prefix + "RuleId", this.RuleId);
        this.setParamSimple(map, prefix + "SourceClientIp", this.SourceClientIp);
        this.setParamSimple(map, prefix + "Limit", this.Limit);
        this.setParamSimple(map, prefix + "Offset", this.Offset);
        this.setParamSimple(map, prefix + "Area", this.Area);

    }
}