SampledHTTPRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.wafv2.model.SampledHTTPRequest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SampledHTTPRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SampledHTTPRequest()

Constructors
Constructor and Description
`SampledHTTPRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SampledHTTPRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAction()` The action that WAF applied to the request.
`CaptchaResponse`	`getCaptchaResponse()` The `CAPTCHA` response for the request.
`ChallengeResponse`	`getChallengeResponse()` The `Challenge` response for the request.
`List<Label>`	`getLabels()` Labels applied to the web request by matching rules.
`String`	`getOverriddenAction()` Used only for rule group rules that have a rule action override in place in the web ACL.
`HTTPRequest`	`getRequest()` A complex type that contains detailed information about the request.
`List<HTTPHeader>`	`getRequestHeadersInserted()` Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
`Integer`	`getResponseCodeSent()` The response code that was sent for the request.
`String`	`getRuleNameWithinRuleGroup()` The name of the `Rule` that the request matched.
`Date`	`getTimestamp()` The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
`Long`	`getWeight()` A value that indicates how one result in the response relates proportionally to other results in the response.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction(String action)` The action that WAF applied to the request.
`void`	`setCaptchaResponse(CaptchaResponse captchaResponse)` The `CAPTCHA` response for the request.
`void`	`setChallengeResponse(ChallengeResponse challengeResponse)` The `Challenge` response for the request.
`void`	`setLabels(Collection<Label> labels)` Labels applied to the web request by matching rules.
`void`	`setOverriddenAction(String overriddenAction)` Used only for rule group rules that have a rule action override in place in the web ACL.
`void`	`setRequest(HTTPRequest request)` A complex type that contains detailed information about the request.
`void`	`setRequestHeadersInserted(Collection<HTTPHeader> requestHeadersInserted)` Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
`void`	`setResponseCodeSent(Integer responseCodeSent)` The response code that was sent for the request.
`void`	`setRuleNameWithinRuleGroup(String ruleNameWithinRuleGroup)` The name of the `Rule` that the request matched.
`void`	`setTimestamp(Date timestamp)` The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
`void`	`setWeight(Long weight)` A value that indicates how one result in the response relates proportionally to other results in the response.
`String`	`toString()` Returns a string representation of this object.
`SampledHTTPRequest`	`withAction(String action)` The action that WAF applied to the request.
`SampledHTTPRequest`	`withCaptchaResponse(CaptchaResponse captchaResponse)` The `CAPTCHA` response for the request.
`SampledHTTPRequest`	`withChallengeResponse(ChallengeResponse challengeResponse)` The `Challenge` response for the request.
`SampledHTTPRequest`	`withLabels(Collection<Label> labels)` Labels applied to the web request by matching rules.
`SampledHTTPRequest`	`withLabels(Label... labels)` Labels applied to the web request by matching rules.
`SampledHTTPRequest`	`withOverriddenAction(String overriddenAction)` Used only for rule group rules that have a rule action override in place in the web ACL.
`SampledHTTPRequest`	`withRequest(HTTPRequest request)` A complex type that contains detailed information about the request.
`SampledHTTPRequest`	`withRequestHeadersInserted(Collection<HTTPHeader> requestHeadersInserted)` Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
`SampledHTTPRequest`	`withRequestHeadersInserted(HTTPHeader... requestHeadersInserted)` Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
`SampledHTTPRequest`	`withResponseCodeSent(Integer responseCodeSent)` The response code that was sent for the request.
`SampledHTTPRequest`	`withRuleNameWithinRuleGroup(String ruleNameWithinRuleGroup)` The name of the `Rule` that the request matched.
`SampledHTTPRequest`	`withTimestamp(Date timestamp)` The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
`SampledHTTPRequest`	`withWeight(Long weight)` A value that indicates how one result in the response relates proportionally to other results in the response.

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

- Constructor Detail
  - SampledHTTPRequest
```
public SampledHTTPRequest()
```
- Method Detail
  - setRequest
```
public void setRequest(HTTPRequest request)
```
    A complex type that contains detailed information about the request.
    
    Parameters:
    
    request - A complex type that contains detailed information about the request.
  - getRequest
```
public HTTPRequest getRequest()
```
    A complex type that contains detailed information about the request.
    
    Returns:
    
    A complex type that contains detailed information about the request.
  - withRequest
```
public SampledHTTPRequest withRequest(HTTPRequest request)
```
    A complex type that contains detailed information about the request.
    
    Parameters:
    
    request - A complex type that contains detailed information about the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWeight
```
public void setWeight(Long weight)
```
    A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
    
    Parameters:
    
    weight - A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
  - getWeight
```
public Long getWeight()
```
    A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
    
    Returns:
    
    A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
  - withWeight
```
public SampledHTTPRequest withWeight(Long weight)
```
    A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
    
    Parameters:
    
    weight - A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimestamp
```
public void setTimestamp(Date timestamp)
```
    The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
    
    Parameters:
    
    timestamp - The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
  - getTimestamp
```
public Date getTimestamp()
```
    The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
    
    Returns:
    
    The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
  - withTimestamp
```
public SampledHTTPRequest withTimestamp(Date timestamp)
```
    The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
    
    Parameters:
    
    timestamp - The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(String action)
```
    The action that WAF applied to the request.
    
    Parameters:
    
    action - The action that WAF applied to the request.
  - getAction
```
public String getAction()
```
    The action that WAF applied to the request.
    
    Returns:
    
    The action that WAF applied to the request.
  - withAction
```
public SampledHTTPRequest withAction(String action)
```
    The action that WAF applied to the request.
    
    Parameters:
    
    action - The action that WAF applied to the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleNameWithinRuleGroup
```
public void setRuleNameWithinRuleGroup(String ruleNameWithinRuleGroup)
```
    The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
    
    Parameters:
    
    ruleNameWithinRuleGroup - The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
  - getRuleNameWithinRuleGroup
```
public String getRuleNameWithinRuleGroup()
```
    The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
    
    Returns:
    
    The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
  - withRuleNameWithinRuleGroup
```
public SampledHTTPRequest withRuleNameWithinRuleGroup(String ruleNameWithinRuleGroup)
```
    The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
    
    Parameters:
    
    ruleNameWithinRuleGroup - The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequestHeadersInserted
```
public List<HTTPHeader> getRequestHeadersInserted()
```
    Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
    
    Returns:
    
    Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
  - setRequestHeadersInserted
```
public void setRequestHeadersInserted(Collection<HTTPHeader> requestHeadersInserted)
```
    Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
    
    Parameters:
    
    requestHeadersInserted - Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
  - withRequestHeadersInserted
```
public SampledHTTPRequest withRequestHeadersInserted(HTTPHeader... requestHeadersInserted)
```
    Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
    
    NOTE: This method appends the values to the existing list (if any). Use setRequestHeadersInserted(java.util.Collection) or withRequestHeadersInserted(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    requestHeadersInserted - Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRequestHeadersInserted
```
public SampledHTTPRequest withRequestHeadersInserted(Collection<HTTPHeader> requestHeadersInserted)
```
    Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
    
    Parameters:
    
    requestHeadersInserted - Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResponseCodeSent
```
public void setResponseCodeSent(Integer responseCodeSent)
```
    The response code that was sent for the request.
    
    Parameters:
    
    responseCodeSent - The response code that was sent for the request.
  - getResponseCodeSent
```
public Integer getResponseCodeSent()
```
    The response code that was sent for the request.
    
    Returns:
    
    The response code that was sent for the request.
  - withResponseCodeSent
```
public SampledHTTPRequest withResponseCodeSent(Integer responseCodeSent)
```
    The response code that was sent for the request.
    
    Parameters:
    
    responseCodeSent - The response code that was sent for the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLabels
```
public List<Label> getLabels()
```
    Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
    
    Returns:
    
    Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
  - setLabels
```
public void setLabels(Collection<Label> labels)
```
    Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
    
    Parameters:
    
    labels - Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
  - withLabels
```
public SampledHTTPRequest withLabels(Label... labels)
```
    Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
    
    NOTE: This method appends the values to the existing list (if any). Use setLabels(java.util.Collection) or withLabels(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    labels - Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLabels
```
public SampledHTTPRequest withLabels(Collection<Label> labels)
```
    Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
    
    Parameters:
    
    labels - Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
    
    For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCaptchaResponse
```
public void setCaptchaResponse(CaptchaResponse captchaResponse)
```
    The CAPTCHA response for the request.
    
    Parameters:
    
    captchaResponse - The CAPTCHA response for the request.
  - getCaptchaResponse
```
public CaptchaResponse getCaptchaResponse()
```
    The CAPTCHA response for the request.
    
    Returns:
    
    The CAPTCHA response for the request.
  - withCaptchaResponse
```
public SampledHTTPRequest withCaptchaResponse(CaptchaResponse captchaResponse)
```
    The CAPTCHA response for the request.
    
    Parameters:
    
    captchaResponse - The CAPTCHA response for the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChallengeResponse
```
public void setChallengeResponse(ChallengeResponse challengeResponse)
```
    The Challenge response for the request.
    
    Parameters:
    
    challengeResponse - The Challenge response for the request.
  - getChallengeResponse
```
public ChallengeResponse getChallengeResponse()
```
    The Challenge response for the request.
    
    Returns:
    
    The Challenge response for the request.
  - withChallengeResponse
```
public SampledHTTPRequest withChallengeResponse(ChallengeResponse challengeResponse)
```
    The Challenge response for the request.
    
    Parameters:
    
    challengeResponse - The Challenge response for the request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverriddenAction
```
public void setOverriddenAction(String overriddenAction)
```
    Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
    
    Parameters:
    
    overriddenAction - Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
  - getOverriddenAction
```
public String getOverriddenAction()
```
    Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
    
    Returns:
    
    Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
  - withOverriddenAction
```
public SampledHTTPRequest withOverriddenAction(String overriddenAction)
```
    Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
    
    Parameters:
    
    overriddenAction - Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the Action value.
    
    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 SampledHTTPRequest clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class SampledHTTPRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SampledHTTPRequest

Method Detail

setRequest

getRequest

withRequest

setWeight

getWeight

withWeight

setTimestamp

getTimestamp

withTimestamp

setAction

getAction

withAction

setRuleNameWithinRuleGroup

getRuleNameWithinRuleGroup

withRuleNameWithinRuleGroup

getRequestHeadersInserted

setRequestHeadersInserted

withRequestHeadersInserted

withRequestHeadersInserted

setResponseCodeSent

getResponseCodeSent

withResponseCodeSent

getLabels

setLabels

withLabels

withLabels

setCaptchaResponse

getCaptchaResponse

withCaptchaResponse

setChallengeResponse

getChallengeResponse

withChallengeResponse

setOverriddenAction

getOverriddenAction

withOverriddenAction

toString

equals

hashCode

clone

marshall