com.amazonaws.services.wafv2.model

Class GetSampledRequestsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.wafv2.model.GetSampledRequestsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSampledRequestsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetSampledRequestsRequest()

Method Summary

Modifier and Type	Method and Description
GetSampledRequestsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getMaxItems() The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range.
String	getRuleMetricName() The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.
String	getScope() Specifies whether this is for an AWS CloudFront distribution or for a regional application.
TimeWindow	getTimeWindow() 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.
String	getWebAclArn() The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
int	hashCode()
void	setMaxItems(Long maxItems) The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range.
void	setRuleMetricName(String ruleMetricName) The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.
void	setScope(String scope) Specifies whether this is for an AWS CloudFront distribution or for a regional application.
void	setTimeWindow(TimeWindow timeWindow) 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.
void	setWebAclArn(String webAclArn) The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
String	toString() Returns a string representation of this object.
GetSampledRequestsRequest	withMaxItems(Long maxItems) The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range.
GetSampledRequestsRequest	withRuleMetricName(String ruleMetricName) The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.
GetSampledRequestsRequest	withScope(Scope scope) Specifies whether this is for an AWS CloudFront distribution or for a regional application.
GetSampledRequestsRequest	withScope(String scope) Specifies whether this is for an AWS CloudFront distribution or for a regional application.
GetSampledRequestsRequest	withTimeWindow(TimeWindow timeWindow) 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.
GetSampledRequestsRequest	withWebAclArn(String webAclArn) The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSampledRequestsRequest

public GetSampledRequestsRequest()

Method Detail

setWebAclArn

public void setWebAclArn(String webAclArn)

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

Parameters:

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

getWebAclArn

public String getWebAclArn()

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

Returns:

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

withWebAclArn

public GetSampledRequestsRequest withWebAclArn(String webAclArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRuleMetricName

public void setRuleMetricName(String ruleMetricName)

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

Parameters:

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

getRuleMetricName

public String getRuleMetricName()

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

Returns:

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

withRuleMetricName

public GetSampledRequestsRequest withRuleMetricName(String ruleMetricName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setScope

public void setScope(String scope)

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

See Also:

Scope

getScope

public String getScope()

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

See Also:

Scope

withScope

public GetSampledRequestsRequest withScope(String scope)

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Scope

withScope

public GetSampledRequestsRequest withScope(Scope scope)

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Parameters:

scope - Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

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

• CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

• API and SDKs - For all calls, use the Region endpoint us-east-1.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Scope

setTimeWindow

public void setTimeWindow(TimeWindow timeWindow)

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.

Parameters:

timeWindow - 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.

getTimeWindow

public TimeWindow getTimeWindow()

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.

Returns:

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.

withTimeWindow

public GetSampledRequestsRequest withTimeWindow(TimeWindow timeWindow)

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.

Parameters:

timeWindow - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxItems

public void setMaxItems(Long maxItems)

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

Parameters:

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

getMaxItems

public Long getMaxItems()

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

Returns:

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

withMaxItems

public GetSampledRequestsRequest withMaxItems(Long maxItems)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetSampledRequestsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()