AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::GetSampledRequestsRequest Class Reference

#include <GetSampledRequestsRequest.h>

+ Inheritance diagram for Aws::WAFV2::Model::GetSampledRequestsRequest:

Public Member Functions

 GetSampledRequestsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetWebAclArn () const
 
bool WebAclArnHasBeenSet () const
 
void SetWebAclArn (const Aws::String &value)
 
void SetWebAclArn (Aws::String &&value)
 
void SetWebAclArn (const char *value)
 
GetSampledRequestsRequestWithWebAclArn (const Aws::String &value)
 
GetSampledRequestsRequestWithWebAclArn (Aws::String &&value)
 
GetSampledRequestsRequestWithWebAclArn (const char *value)
 
const Aws::StringGetRuleMetricName () const
 
bool RuleMetricNameHasBeenSet () const
 
void SetRuleMetricName (const Aws::String &value)
 
void SetRuleMetricName (Aws::String &&value)
 
void SetRuleMetricName (const char *value)
 
GetSampledRequestsRequestWithRuleMetricName (const Aws::String &value)
 
GetSampledRequestsRequestWithRuleMetricName (Aws::String &&value)
 
GetSampledRequestsRequestWithRuleMetricName (const char *value)
 
const ScopeGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const Scope &value)
 
void SetScope (Scope &&value)
 
GetSampledRequestsRequestWithScope (const Scope &value)
 
GetSampledRequestsRequestWithScope (Scope &&value)
 
const TimeWindowGetTimeWindow () const
 
bool TimeWindowHasBeenSet () const
 
void SetTimeWindow (const TimeWindow &value)
 
void SetTimeWindow (TimeWindow &&value)
 
GetSampledRequestsRequestWithTimeWindow (const TimeWindow &value)
 
GetSampledRequestsRequestWithTimeWindow (TimeWindow &&value)
 
long long GetMaxItems () const
 
bool MaxItemsHasBeenSet () const
 
void SetMaxItems (long long value)
 
GetSampledRequestsRequestWithMaxItems (long long value)
 
- Public Member Functions inherited from Aws::WAFV2::WAFV2Request
virtual ~WAFV2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file GetSampledRequestsRequest.h.

Constructor & Destructor Documentation

◆ GetSampledRequestsRequest()

Aws::WAFV2::Model::GetSampledRequestsRequest::GetSampledRequestsRequest ( )

Member Function Documentation

◆ GetMaxItems()

long long Aws::WAFV2::Model::GetSampledRequestsRequest::GetMaxItems ( ) const
inline

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.

Definition at line 271 of file GetSampledRequestsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WAFV2::Model::GetSampledRequestsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WAFV2::WAFV2Request.

◆ GetRuleMetricName()

const Aws::String& Aws::WAFV2::Model::GetSampledRequestsRequest::GetRuleMetricName ( ) const
inline

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

Definition at line 92 of file GetSampledRequestsRequest.h.

◆ GetScope()

const Scope& Aws::WAFV2::Model::GetSampledRequestsRequest::GetScope ( ) const
inline

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.

Definition at line 146 of file GetSampledRequestsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::WAFV2::Model::GetSampledRequestsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file GetSampledRequestsRequest.h.

◆ GetTimeWindow()

const TimeWindow& Aws::WAFV2::Model::GetSampledRequestsRequest::GetTimeWindow ( ) const
inline

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.

Definition at line 212 of file GetSampledRequestsRequest.h.

◆ GetWebAclArn()

const Aws::String& Aws::WAFV2::Model::GetSampledRequestsRequest::GetWebAclArn ( ) const
inline

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

Definition at line 43 of file GetSampledRequestsRequest.h.

◆ MaxItemsHasBeenSet()

bool Aws::WAFV2::Model::GetSampledRequestsRequest::MaxItemsHasBeenSet ( ) const
inline

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.

Definition at line 279 of file GetSampledRequestsRequest.h.

◆ RuleMetricNameHasBeenSet()

bool Aws::WAFV2::Model::GetSampledRequestsRequest::RuleMetricNameHasBeenSet ( ) const
inline

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

Definition at line 98 of file GetSampledRequestsRequest.h.

◆ ScopeHasBeenSet()

bool Aws::WAFV2::Model::GetSampledRequestsRequest::ScopeHasBeenSet ( ) const
inline

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.

Definition at line 157 of file GetSampledRequestsRequest.h.

◆ SerializePayload()

Aws::String Aws::WAFV2::Model::GetSampledRequestsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxItems()

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetMaxItems ( long long  value)
inline

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.

Definition at line 287 of file GetSampledRequestsRequest.h.

◆ SetRuleMetricName() [1/3]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetRuleMetricName ( const Aws::String value)
inline

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

Definition at line 104 of file GetSampledRequestsRequest.h.

◆ SetRuleMetricName() [2/3]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetRuleMetricName ( Aws::String &&  value)
inline

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

Definition at line 110 of file GetSampledRequestsRequest.h.

◆ SetRuleMetricName() [3/3]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetRuleMetricName ( const char *  value)
inline

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

Definition at line 116 of file GetSampledRequestsRequest.h.

◆ SetScope() [1/2]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetScope ( const Scope value)
inline

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.

Definition at line 168 of file GetSampledRequestsRequest.h.

◆ SetScope() [2/2]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetScope ( Scope &&  value)
inline

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.

Definition at line 179 of file GetSampledRequestsRequest.h.

◆ SetTimeWindow() [1/2]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetTimeWindow ( const TimeWindow value)
inline

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.

Definition at line 232 of file GetSampledRequestsRequest.h.

◆ SetTimeWindow() [2/2]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetTimeWindow ( TimeWindow &&  value)
inline

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.

Definition at line 242 of file GetSampledRequestsRequest.h.

◆ SetWebAclArn() [1/3]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetWebAclArn ( const Aws::String value)
inline

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

Definition at line 55 of file GetSampledRequestsRequest.h.

◆ SetWebAclArn() [2/3]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetWebAclArn ( Aws::String &&  value)
inline

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

Definition at line 61 of file GetSampledRequestsRequest.h.

◆ SetWebAclArn() [3/3]

void Aws::WAFV2::Model::GetSampledRequestsRequest::SetWebAclArn ( const char *  value)
inline

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

Definition at line 67 of file GetSampledRequestsRequest.h.

◆ TimeWindowHasBeenSet()

bool Aws::WAFV2::Model::GetSampledRequestsRequest::TimeWindowHasBeenSet ( ) const
inline

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.

Definition at line 222 of file GetSampledRequestsRequest.h.

◆ WebAclArnHasBeenSet()

bool Aws::WAFV2::Model::GetSampledRequestsRequest::WebAclArnHasBeenSet ( ) const
inline

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

Definition at line 49 of file GetSampledRequestsRequest.h.

◆ WithMaxItems()

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithMaxItems ( long long  value)
inline

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.

Definition at line 295 of file GetSampledRequestsRequest.h.

◆ WithRuleMetricName() [1/3]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithRuleMetricName ( const Aws::String value)
inline

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

Definition at line 122 of file GetSampledRequestsRequest.h.

◆ WithRuleMetricName() [2/3]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithRuleMetricName ( Aws::String &&  value)
inline

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

Definition at line 128 of file GetSampledRequestsRequest.h.

◆ WithRuleMetricName() [3/3]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithRuleMetricName ( const char *  value)
inline

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

Definition at line 134 of file GetSampledRequestsRequest.h.

◆ WithScope() [1/2]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithScope ( const Scope value)
inline

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.

Definition at line 190 of file GetSampledRequestsRequest.h.

◆ WithScope() [2/2]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithScope ( Scope &&  value)
inline

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.

Definition at line 201 of file GetSampledRequestsRequest.h.

◆ WithTimeWindow() [1/2]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithTimeWindow ( const TimeWindow value)
inline

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.

Definition at line 252 of file GetSampledRequestsRequest.h.

◆ WithTimeWindow() [2/2]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithTimeWindow ( TimeWindow &&  value)
inline

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.

Definition at line 262 of file GetSampledRequestsRequest.h.

◆ WithWebAclArn() [1/3]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithWebAclArn ( const Aws::String value)
inline

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

Definition at line 73 of file GetSampledRequestsRequest.h.

◆ WithWebAclArn() [2/3]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithWebAclArn ( Aws::String &&  value)
inline

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

Definition at line 79 of file GetSampledRequestsRequest.h.

◆ WithWebAclArn() [3/3]

GetSampledRequestsRequest& Aws::WAFV2::Model::GetSampledRequestsRequest::WithWebAclArn ( const char *  value)
inline

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

Definition at line 85 of file GetSampledRequestsRequest.h.


The documentation for this class was generated from the following file: