/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. 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. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file 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.amazonaws.services.wafv2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetSampledRequestsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. *

*/ private String webAclArn; /** *

* The metric name assigned to the Rule or RuleGroup dimension for which you want a sample * of requests. *

*/ private String ruleMetricName; /** *

* Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional * application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an * Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. *

*

* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: *

* */ private String scope; /** *

* The start date and time and the end date and time of the range for which you want GetSampledRequests * to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format * includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF * sets it to three hours ago. *

*/ private TimeWindow timeWindow; /** *

* The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web * Services resource received during the time range. If your resource received fewer requests than the value of * MaxItems, GetSampledRequests returns information about all of them. *

*/ private Long maxItems; /** *

* The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. *

* * @param webAclArn * The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. */ public void setWebAclArn(String webAclArn) { this.webAclArn = webAclArn; } /** *

* The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. *

* * @return The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. */ public String getWebAclArn() { return this.webAclArn; } /** *

* The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. *

* * @param webAclArn * The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. * @return Returns a reference to this object so that method calls can be chained together. */ public GetSampledRequestsRequest withWebAclArn(String webAclArn) { setWebAclArn(webAclArn); return this; } /** *

* The metric name assigned to the Rule or RuleGroup dimension for which you want a sample * of requests. *

* * @param ruleMetricName * The metric name assigned to the Rule or RuleGroup dimension for which you want a * sample of requests. */ public void setRuleMetricName(String ruleMetricName) { this.ruleMetricName = ruleMetricName; } /** *

* The metric name assigned to the Rule or RuleGroup dimension for which you want a sample * of requests. *

* * @return The metric name assigned to the Rule or RuleGroup dimension for which you want * a sample of requests. */ public String getRuleMetricName() { return this.ruleMetricName; } /** *

* The metric name assigned to the Rule or RuleGroup dimension for which you want a sample * of requests. *

* * @param ruleMetricName * The metric name assigned to the Rule or RuleGroup dimension for which you want a * sample of requests. * @return Returns a reference to this object so that method calls can be chained together. */ public GetSampledRequestsRequest withRuleMetricName(String ruleMetricName) { setRuleMetricName(ruleMetricName); return this; } /** *

* Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional * application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an * Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. *

*

* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: *

* * * @param scope * Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional * application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL * API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access * instance.

*

* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: *

*