java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.wafv2.model.Wafv2Request
    - - software.amazon.awssdk.services.wafv2.model.GetSampledRequestsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class GetSampledRequestsRequest
extends Wafv2Request
implements ToCopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetSampledRequestsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetSampledRequestsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Long`	`maxItems()`	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.
`String`	`ruleMetricName()`	The metric name assigned to the `Rule` or `RuleGroup` dimension for which you want a sample of requests.
`Scope`	`scope()`	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
`String`	`scopeAsString()`	Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetSampledRequestsRequest.Builder>`	`serializableBuilderClass()`
`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.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`webAclArn()`	The Amazon resource name (ARN) of the `WebACL` for which you want a sample of requests.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - webAclArn
```
public final String webAclArn()
```
    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.
  - ruleMetricName
```
public final String ruleMetricName()
```
    The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.
    
    Returns:
    
    The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests.
  - scope
```
public final Scope 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:
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().
    Returns:
    
    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:
    
    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
  - scopeAsString
```
public final String scopeAsString()
```
    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:
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().
    Returns:
    
    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:
    
    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
  - timeWindow
```
public final 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. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.
    
    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. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago.
  - maxItems
```
public final Long maxItems()
```
    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.
    
    Returns:
    
    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.
  - toBuilder
```
public GetSampledRequestsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetSampledRequestsRequest.Builder,GetSampledRequestsRequest>
    
    Specified by:
    
    toBuilder in class Wafv2Request
  - builder
```
public static GetSampledRequestsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetSampledRequestsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetSampledRequestsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

webAclArn

ruleMetricName

scope

scopeAsString

timeWindow

maxItems

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField