com.aliyun.sdk.service.waf_openapi20211001.models.DescribeUserApiRequestRequest Maven / Gradle / Ivy

Go to download
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sdk.service.waf_openapi20211001.models;

import darabonba.core.RequestModel;
import darabonba.core.TeaModel;
import com.aliyun.sdk.gateway.pop.models.*;

/**
 * 
 * {@link DescribeUserApiRequestRequest} extends {@link RequestModel}
 *
 * DescribeUserApiRequestRequest
 */
public class DescribeUserApiRequestRequest extends Request {
    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("ApiFormat")
    private String apiFormat;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("ApiId")
    @com.aliyun.core.annotation.Validation(required = true)
    private String apiId;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("ClusterId")
    private String clusterId;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("Domain")
    private String domain;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("InstanceId")
    @com.aliyun.core.annotation.Validation(required = true)
    private String instanceId;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("RegionId")
    private String regionId;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("ResourceManagerResourceGroupId")
    private String resourceManagerResourceGroupId;

    @com.aliyun.core.annotation.Query
    @com.aliyun.core.annotation.NameInMap("Type")
    private String type;

    private DescribeUserApiRequestRequest(Builder builder) {
        super(builder);
        this.apiFormat = builder.apiFormat;
        this.apiId = builder.apiId;
        this.clusterId = builder.clusterId;
        this.domain = builder.domain;
        this.instanceId = builder.instanceId;
        this.regionId = builder.regionId;
        this.resourceManagerResourceGroupId = builder.resourceManagerResourceGroupId;
        this.type = builder.type;
    }

    public static Builder builder() {
        return new Builder();
    }

    public static DescribeUserApiRequestRequest create() {
        return builder().build();
    }

    @Override
    public Builder toBuilder() {
        return new Builder(this);
    }

    /**
     * @return apiFormat
     */
    public String getApiFormat() {
        return this.apiFormat;
    }

    /**
     * @return apiId
     */
    public String getApiId() {
        return this.apiId;
    }

    /**
     * @return clusterId
     */
    public String getClusterId() {
        return this.clusterId;
    }

    /**
     * @return domain
     */
    public String getDomain() {
        return this.domain;
    }

    /**
     * @return instanceId
     */
    public String getInstanceId() {
        return this.instanceId;
    }

    /**
     * @return regionId
     */
    public String getRegionId() {
        return this.regionId;
    }

    /**
     * @return resourceManagerResourceGroupId
     */
    public String getResourceManagerResourceGroupId() {
        return this.resourceManagerResourceGroupId;
    }

    /**
     * @return type
     */
    public String getType() {
        return this.type;
    }

    public static final class Builder extends Request.Builder {
        private String apiFormat; 
        private String apiId; 
        private String clusterId; 
        private String domain; 
        private String instanceId; 
        private String regionId; 
        private String resourceManagerResourceGroupId; 
        private String type; 

        private Builder() {
            super();
        } 

        private Builder(DescribeUserApiRequestRequest request) {
            super(request);
            this.apiFormat = request.apiFormat;
            this.apiId = request.apiId;
            this.clusterId = request.clusterId;
            this.domain = request.domain;
            this.instanceId = request.instanceId;
            this.regionId = request.regionId;
            this.resourceManagerResourceGroupId = request.resourceManagerResourceGroupId;
            this.type = request.type;
        } 

        /**
         * The API.
         * 
         * Notice: This parameter is deprecated, please use ApiId to query.
         * 
         * 
         * example:
         * /api/v1/know
         */
        public Builder apiFormat(String apiFormat) {
            this.putQueryParameter("ApiFormat", apiFormat);
            this.apiFormat = apiFormat;
            return this;
        }

        /**
         * The ID of the API.
         * This parameter is required.
         * 
         * example:
         * 3799f0695c0d687f3295d132fe49bc14
         */
        public Builder apiId(String apiId) {
            this.putQueryParameter("ApiId", apiId);
            this.apiId = apiId;
            return this;
        }

        /**
         * The ID of the hybrid cloud cluster.
         * 
         * For hybrid cloud scenarios only, you can call the DescribeHybridCloudClusters operation to query the hybrid cloud clusters.
         * 
         * 
         * example:
         * 428
         */
        public Builder clusterId(String clusterId) {
            this.putQueryParameter("ClusterId", clusterId);
            this.clusterId = clusterId;
            return this;
        }

        /**
         * The domain name or IP address of the API.
         * 
         * Notice: This parameter is deprecated, please use ApiId to query.
         * 
         * 
         * example:
         * c.***.com
         */
        public Builder domain(String domain) {
            this.putQueryParameter("Domain", domain);
            this.domain = domain;
            return this;
        }

        /**
         * The ID of the Web Application Firewall (WAF) instance.
         * 
         *  You can call the DescribeInstance operation to query the ID of the WAF instance.
         * 
         * This parameter is required.
         * 
         * example:
         * waf_v3prepaid_public_cn-zxu38***
         */
        public Builder instanceId(String instanceId) {
            this.putQueryParameter("InstanceId", instanceId);
            this.instanceId = instanceId;
            return this;
        }

        /**
         * The region in which the WAF instance is deployed. Valid values:
         * 
         * cn-hangzhou: Chinese mainland
         * ap-southeast-1: outside the Chinese mainland
         * 
         * 
         * example:
         * cn-hangzhou
         */
        public Builder regionId(String regionId) {
            this.putQueryParameter("RegionId", regionId);
            this.regionId = regionId;
            return this;
        }

        /**
         * The ID of the Alibaba Cloud resource group.
         * 
         * example:
         * rg-acfm***q
         */
        public Builder resourceManagerResourceGroupId(String resourceManagerResourceGroupId) {
            this.putQueryParameter("ResourceManagerResourceGroupId", resourceManagerResourceGroupId);
            this.resourceManagerResourceGroupId = resourceManagerResourceGroupId;
            return this;
        }

        /**
         * The type of the statistics. Valid values:
         * 
         * api_ip: total traffic
         * api_cross_border_ip: cross-border traffic
         * api_bot_ip: bot traffic
         * remote_region: geographical location
         * client_id: client type
         * http_referer: Referer
         * api_cnt: total number of calls
         * bot_cnt: number of bot calls
         * cross_border_cnt: number of cross-border requests
         * api_freq: call frequency
         * 
         * 
         * example:
         * api_ip
         */
        public Builder type(String type) {
            this.putQueryParameter("Type", type);
            this.type = type;
            return this;
        }

        @Override
        public DescribeUserApiRequestRequest build() {
            return new DescribeUserApiRequestRequest(this);
        } 

    } 

}