com.aliyun.sdk.service.waf_openapi20211001.models.DescribeApisecApiResourcesRequest Maven / Gradle / Ivy
// 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 DescribeApisecApiResourcesRequest} extends {@link RequestModel}
*
* DescribeApisecApiResourcesRequest
*/
public class DescribeApisecApiResourcesRequest 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")
private String apiId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ApiMethod")
private String apiMethod;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ApiStatus")
private String apiStatus;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ApiTag")
private String apiTag;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ApiType")
private String apiType;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("AuthFlag")
private String authFlag;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ClusterId")
private String clusterId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("EndTime")
private String endTime;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Follow")
private Long follow;
@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("MatchedHost")
private String matchedHost;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("Note")
private String note;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("OrderKey")
private String orderKey;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("OrderWay")
private String orderWay;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("PageNumber")
private Long pageNumber;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("PageSize")
@com.aliyun.core.annotation.Validation(maximum = 200, minimum = 1)
private Long pageSize;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("RegionId")
private String regionId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("RequestSensitiveType")
private String requestSensitiveType;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("ResourceManagerResourceGroupId")
private String resourceManagerResourceGroupId;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("SensitiveLevel")
private String sensitiveLevel;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("SensitiveType")
private String sensitiveType;
@com.aliyun.core.annotation.Query
@com.aliyun.core.annotation.NameInMap("StartTime")
private String startTime;
private DescribeApisecApiResourcesRequest(Builder builder) {
super(builder);
this.apiFormat = builder.apiFormat;
this.apiId = builder.apiId;
this.apiMethod = builder.apiMethod;
this.apiStatus = builder.apiStatus;
this.apiTag = builder.apiTag;
this.apiType = builder.apiType;
this.authFlag = builder.authFlag;
this.clusterId = builder.clusterId;
this.endTime = builder.endTime;
this.follow = builder.follow;
this.instanceId = builder.instanceId;
this.matchedHost = builder.matchedHost;
this.note = builder.note;
this.orderKey = builder.orderKey;
this.orderWay = builder.orderWay;
this.pageNumber = builder.pageNumber;
this.pageSize = builder.pageSize;
this.regionId = builder.regionId;
this.requestSensitiveType = builder.requestSensitiveType;
this.resourceManagerResourceGroupId = builder.resourceManagerResourceGroupId;
this.sensitiveLevel = builder.sensitiveLevel;
this.sensitiveType = builder.sensitiveType;
this.startTime = builder.startTime;
}
public static Builder builder() {
return new Builder();
}
public static DescribeApisecApiResourcesRequest 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 apiMethod
*/
public String getApiMethod() {
return this.apiMethod;
}
/**
* @return apiStatus
*/
public String getApiStatus() {
return this.apiStatus;
}
/**
* @return apiTag
*/
public String getApiTag() {
return this.apiTag;
}
/**
* @return apiType
*/
public String getApiType() {
return this.apiType;
}
/**
* @return authFlag
*/
public String getAuthFlag() {
return this.authFlag;
}
/**
* @return clusterId
*/
public String getClusterId() {
return this.clusterId;
}
/**
* @return endTime
*/
public String getEndTime() {
return this.endTime;
}
/**
* @return follow
*/
public Long getFollow() {
return this.follow;
}
/**
* @return instanceId
*/
public String getInstanceId() {
return this.instanceId;
}
/**
* @return matchedHost
*/
public String getMatchedHost() {
return this.matchedHost;
}
/**
* @return note
*/
public String getNote() {
return this.note;
}
/**
* @return orderKey
*/
public String getOrderKey() {
return this.orderKey;
}
/**
* @return orderWay
*/
public String getOrderWay() {
return this.orderWay;
}
/**
* @return pageNumber
*/
public Long getPageNumber() {
return this.pageNumber;
}
/**
* @return pageSize
*/
public Long getPageSize() {
return this.pageSize;
}
/**
* @return regionId
*/
public String getRegionId() {
return this.regionId;
}
/**
* @return requestSensitiveType
*/
public String getRequestSensitiveType() {
return this.requestSensitiveType;
}
/**
* @return resourceManagerResourceGroupId
*/
public String getResourceManagerResourceGroupId() {
return this.resourceManagerResourceGroupId;
}
/**
* @return sensitiveLevel
*/
public String getSensitiveLevel() {
return this.sensitiveLevel;
}
/**
* @return sensitiveType
*/
public String getSensitiveType() {
return this.sensitiveType;
}
/**
* @return startTime
*/
public String getStartTime() {
return this.startTime;
}
public static final class Builder extends Request.Builder {
private String apiFormat;
private String apiId;
private String apiMethod;
private String apiStatus;
private String apiTag;
private String apiType;
private String authFlag;
private String clusterId;
private String endTime;
private Long follow;
private String instanceId;
private String matchedHost;
private String note;
private String orderKey;
private String orderWay;
private Long pageNumber;
private Long pageSize;
private String regionId;
private String requestSensitiveType;
private String resourceManagerResourceGroupId;
private String sensitiveLevel;
private String sensitiveType;
private String startTime;
private Builder() {
super();
}
private Builder(DescribeApisecApiResourcesRequest request) {
super(request);
this.apiFormat = request.apiFormat;
this.apiId = request.apiId;
this.apiMethod = request.apiMethod;
this.apiStatus = request.apiStatus;
this.apiTag = request.apiTag;
this.apiType = request.apiType;
this.authFlag = request.authFlag;
this.clusterId = request.clusterId;
this.endTime = request.endTime;
this.follow = request.follow;
this.instanceId = request.instanceId;
this.matchedHost = request.matchedHost;
this.note = request.note;
this.orderKey = request.orderKey;
this.orderWay = request.orderWay;
this.pageNumber = request.pageNumber;
this.pageSize = request.pageSize;
this.regionId = request.regionId;
this.requestSensitiveType = request.requestSensitiveType;
this.resourceManagerResourceGroupId = request.resourceManagerResourceGroupId;
this.sensitiveLevel = request.sensitiveLevel;
this.sensitiveType = request.sensitiveType;
this.startTime = request.startTime;
}
/**
* The API.
*
* example:
* /auth/login
*/
public Builder apiFormat(String apiFormat) {
this.putQueryParameter("ApiFormat", apiFormat);
this.apiFormat = apiFormat;
return this;
}
/**
* The ID of the API.
*
* example:
* 867ade***24ee6e205b8da82b8f84
*/
public Builder apiId(String apiId) {
this.putQueryParameter("ApiId", apiId);
this.apiId = apiId;
return this;
}
/**
* The request method of the API. Valid values:
*
* - GET
* - POST
* - HEAD
* - PUT
* - DELETE
* - CONNECT
* - PATCH
* - OPTIONS
*
*
* example:
* POST
*/
public Builder apiMethod(String apiMethod) {
this.putQueryParameter("ApiMethod", apiMethod);
this.apiMethod = apiMethod;
return this;
}
/**
* The API status. Valid values:
*
* - NewbornInterface: The API is newly added.
* - OfflineInterface: The API is inactive.
* - normal: The API is normal.
*
*
* example:
* OfflineInterface
*/
public Builder apiStatus(String apiStatus) {
this.putQueryParameter("ApiStatus", apiStatus);
this.apiStatus = apiStatus;
return this;
}
/**
* The business purpose of the API.
*
* You can call the DescribeApisecRules operation to query the business purpose of the API.
*
*
* example:
* SendMail
*/
public Builder apiTag(String apiTag) {
this.putQueryParameter("ApiTag", apiTag);
this.apiTag = apiTag;
return this;
}
/**
* The service object. Valid values:
*
* - PublicAPI: public services
* - ThirdpartAPI: cooperation with third-party partners
* - InternalAPI: internal office
*
*
* example:
* innerAPI
*/
public Builder apiType(String apiType) {
this.putQueryParameter("ApiType", apiType);
this.apiType = apiType;
return this;
}
/**
* Specifies whether authentication is required. Valid values:
*
* - 0: Authentication is required.
* - 1: Authentication is not required.
*
*
* example:
* 0
*/
public Builder authFlag(String authFlag) {
this.putQueryParameter("AuthFlag", authFlag);
this.authFlag = authFlag;
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:
* 740
*/
public Builder clusterId(String clusterId) {
this.putQueryParameter("ClusterId", clusterId);
this.clusterId = clusterId;
return this;
}
/**
* The end of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
*
* example:
* 1683388800
*/
public Builder endTime(String endTime) {
this.putQueryParameter("EndTime", endTime);
this.endTime = endTime;
return this;
}
/**
* Specifies whether to follow the API. Valid values:
*
* - 1: follows the API.
* - 0: does not follow the API.
*
*
* example:
* 0
*/
public Builder follow(Long follow) {
this.putQueryParameter("Follow", follow);
this.follow = follow;
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_v2_public_cn-u***gr20j
*/
public Builder instanceId(String instanceId) {
this.putQueryParameter("InstanceId", instanceId);
this.instanceId = instanceId;
return this;
}
/**
* The domain name or IP address of the API.
*
* example:
* a.aliyun.com
*/
public Builder matchedHost(String matchedHost) {
this.putQueryParameter("MatchedHost", matchedHost);
this.matchedHost = matchedHost;
return this;
}
/**
* The remarks.
*
* example:
* API for logon
*/
public Builder note(String note) {
this.putQueryParameter("Note", note);
this.note = note;
return this;
}
/**
* The name of the sorting field. Valid values:
*
* - allCnt: the total number of calls to the API in the previous 30 days
* - botCnt: the number of bot-initiated requests in the previous 30 days
* - crossBorderCnt: the number of cross-border requests in the previous 30 days
* - abnormalNum: the number of API-related risks
* - eventNum: the number of API-related security events
* - farthestTs: the time when the API was first detected
* - lastestTs: the time of the most recent access to the API
*
*
* example:
* allCnt
*/
public Builder orderKey(String orderKey) {
this.putQueryParameter("OrderKey", orderKey);
this.orderKey = orderKey;
return this;
}
/**
* The sorting method. Valid values:
*
* - desc (default): descending order
* - asc: ascending order
*
*
* example:
* desc
*/
public Builder orderWay(String orderWay) {
this.putQueryParameter("OrderWay", orderWay);
this.orderWay = orderWay;
return this;
}
/**
* The page number. Default value: 1.
*
* example:
* 1
*/
public Builder pageNumber(Long pageNumber) {
this.putQueryParameter("PageNumber", pageNumber);
this.pageNumber = pageNumber;
return this;
}
/**
* The number of entries per page. Default value: 10.
*
* example:
* 10
*/
public Builder pageSize(Long pageSize) {
this.putQueryParameter("PageSize", pageSize);
this.pageSize = pageSize;
return this;
}
/**
* The region in which the Web Application Firewall (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 sensitive data type in the request.
*
* You can call the DescribeApisecRules operation to query the supported sensitive data types.
*
*
* example:
* 1004,1005
*/
public Builder requestSensitiveType(String requestSensitiveType) {
this.putQueryParameter("RequestSensitiveType", requestSensitiveType);
this.requestSensitiveType = requestSensitiveType;
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 sensitivity level of the API. Valid values:
*
* - L1: high sensitivity
* - L2: moderate sensitivity
* - L3: low sensitivity
* - N: non-sensitivity
*
*
* example:
* L3
*/
public Builder sensitiveLevel(String sensitiveLevel) {
this.putQueryParameter("SensitiveLevel", sensitiveLevel);
this.sensitiveLevel = sensitiveLevel;
return this;
}
/**
* The sensitive data type in the response.
*
* You can call the DescribeApisecRules operation to query the supported sensitive data types.
*
*
* example:
* 1004
*/
public Builder sensitiveType(String sensitiveType) {
this.putQueryParameter("SensitiveType", sensitiveType);
this.sensitiveType = sensitiveType;
return this;
}
/**
* The beginning of the time range to query. This value is a UNIX timestamp in UTC. Unit: seconds.
*
* example:
* 1681833600
*/
public Builder startTime(String startTime) {
this.putQueryParameter("StartTime", startTime);
this.startTime = startTime;
return this;
}
@Override
public DescribeApisecApiResourcesRequest build() {
return new DescribeApisecApiResourcesRequest(this);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy