com.amazonaws.services.waf.model.GetSampledRequestsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-waf Show documentation
The AWS Java SDK for AWS WAF Service module holds the client classes that are used for communicating with AWS WAF Service
There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2010-2016 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.waf.model;

import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 */
public class GetSampledRequestsRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {

    /**
     * 
     * The WebACLId of the WebACL for which you want
     * GetSampledRequests to return a sample of requests.
     * 
     */
    private String webAclId;
    /**
     * 
     * RuleId is one of two values:
     * 
     * 
     * The RuleId of the Rule for which you want
     * GetSampledRequests to return a sample of requests.
     * Default_Action, which causes
     * GetSampledRequests to return a sample of the requests that
     * didn't match any of the rules in the specified WebACL.
     * 
     */
    private String ruleId;
    /**
     * 
     * 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.
     * Specify the date and time in Unix time format (in seconds). You can
     * specify any time range in the previous three hours.
     * 
     */
    private TimeWindow timeWindow;
    /**
     * 
     * 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.
     * 
     */
    private Long maxItems;

    /**
     * 
     * The WebACLId of the WebACL for which you want
     * GetSampledRequests to return a sample of requests.
     * 
     * 
     * @param webAclId
     *        The WebACLId of the WebACL for which you
     *        want GetSampledRequests to return a sample of
     *        requests.
     */

    public void setWebAclId(String webAclId) {
        this.webAclId = webAclId;
    }

    /**
     * 
     * The WebACLId of the WebACL for which you want
     * GetSampledRequests to return a sample of requests.
     * 
     * 
     * @return The WebACLId of the WebACL for which
     *         you want GetSampledRequests to return a sample of
     *         requests.
     */

    public String getWebAclId() {
        return this.webAclId;
    }

    /**
     * 
     * The WebACLId of the WebACL for which you want
     * GetSampledRequests to return a sample of requests.
     * 
     * 
     * @param webAclId
     *        The WebACLId of the WebACL for which you
     *        want GetSampledRequests to return a sample of
     *        requests.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public GetSampledRequestsRequest withWebAclId(String webAclId) {
        setWebAclId(webAclId);
        return this;
    }

    /**
     * 
     * RuleId is one of two values:
     * 
     * 
     * The RuleId of the Rule for which you want
     * GetSampledRequests to return a sample of requests.
     * Default_Action, which causes
     * GetSampledRequests to return a sample of the requests that
     * didn't match any of the rules in the specified WebACL.
     * 
     * 
     * @param ruleId
     *        RuleId is one of two values:
     *        
     *        The RuleId of the Rule for which you
     *        want GetSampledRequests to return a sample of
     *        requests.
     *        Default_Action, which causes
     *        GetSampledRequests to return a sample of the requests
     *        that didn't match any of the rules in the specified
     *        WebACL.
     */

    public void setRuleId(String ruleId) {
        this.ruleId = ruleId;
    }

    /**
     * 
     * RuleId is one of two values:
     * 
     * 
     * The RuleId of the Rule for which you want
     * GetSampledRequests to return a sample of requests.
     * Default_Action, which causes
     * GetSampledRequests to return a sample of the requests that
     * didn't match any of the rules in the specified WebACL.
     * 
     * 
     * @return RuleId is one of two values:
     *         
     *         The RuleId of the Rule for which
     *         you want GetSampledRequests to return a sample of
     *         requests.
     *         Default_Action, which causes
     *         GetSampledRequests to return a sample of the
     *         requests that didn't match any of the rules in the specified
     *         WebACL.
     */

    public String getRuleId() {
        return this.ruleId;
    }

    /**
     * 
     * RuleId is one of two values:
     * 
     * 
     * The RuleId of the Rule for which you want
     * GetSampledRequests to return a sample of requests.
     * Default_Action, which causes
     * GetSampledRequests to return a sample of the requests that
     * didn't match any of the rules in the specified WebACL.
     * 
     * 
     * @param ruleId
     *        RuleId is one of two values:
     *        
     *        The RuleId of the Rule for which you
     *        want GetSampledRequests to return a sample of
     *        requests.
     *        Default_Action, which causes
     *        GetSampledRequests to return a sample of the requests
     *        that didn't match any of the rules in the specified
     *        WebACL.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public GetSampledRequestsRequest withRuleId(String ruleId) {
        setRuleId(ruleId);
        return this;
    }

    /**
     * 
     * 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.
     * Specify the date and time in Unix time format (in seconds). You can
     * specify any time range in the previous three hours.
     * 
     * 
     * @param 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. Specify the date and time in Unix time format (in
     *        seconds). You can specify any time range in the previous three
     *        hours.
     */

    public void setTimeWindow(TimeWindow timeWindow) {
        this.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.
     * Specify the date and time in Unix time format (in seconds). You can
     * specify any time range in the previous three hours.
     * 
     * 
     * @return 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. Specify the date and time in Unix time format
     *         (in seconds). You can specify any time range in the previous
     *         three hours.
     */

    public TimeWindow getTimeWindow() {
        return this.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.
     * Specify the date and time in Unix time format (in seconds). You can
     * specify any time range in the previous three hours.
     * 
     * 
     * @param 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. Specify the date and time in Unix time format (in
     *        seconds). You can specify any time range in the previous three
     *        hours.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public GetSampledRequestsRequest withTimeWindow(TimeWindow timeWindow) {
        setTimeWindow(timeWindow);
        return this;
    }

    /**
     * 
     * 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.
     * 
     * 
     * @param 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.
     */

    public void setMaxItems(Long maxItems) {
        this.maxItems = 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.
     * 
     * 
     * @return 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.
     */

    public Long getMaxItems() {
        return this.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.
     * 
     * 
     * @param 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.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public GetSampledRequestsRequest withMaxItems(Long maxItems) {
        setMaxItems(maxItems);
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getWebAclId() != null)
            sb.append("WebAclId: " + getWebAclId() + ",");
        if (getRuleId() != null)
            sb.append("RuleId: " + getRuleId() + ",");
        if (getTimeWindow() != null)
            sb.append("TimeWindow: " + getTimeWindow() + ",");
        if (getMaxItems() != null)
            sb.append("MaxItems: " + getMaxItems());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof GetSampledRequestsRequest == false)
            return false;
        GetSampledRequestsRequest other = (GetSampledRequestsRequest) obj;
        if (other.getWebAclId() == null ^ this.getWebAclId() == null)
            return false;
        if (other.getWebAclId() != null
                && other.getWebAclId().equals(this.getWebAclId()) == false)
            return false;
        if (other.getRuleId() == null ^ this.getRuleId() == null)
            return false;
        if (other.getRuleId() != null
                && other.getRuleId().equals(this.getRuleId()) == false)
            return false;
        if (other.getTimeWindow() == null ^ this.getTimeWindow() == null)
            return false;
        if (other.getTimeWindow() != null
                && other.getTimeWindow().equals(this.getTimeWindow()) == false)
            return false;
        if (other.getMaxItems() == null ^ this.getMaxItems() == null)
            return false;
        if (other.getMaxItems() != null
                && other.getMaxItems().equals(this.getMaxItems()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode
                + ((getWebAclId() == null) ? 0 : getWebAclId().hashCode());
        hashCode = prime * hashCode
                + ((getRuleId() == null) ? 0 : getRuleId().hashCode());
        hashCode = prime * hashCode
                + ((getTimeWindow() == null) ? 0 : getTimeWindow().hashCode());
        hashCode = prime * hashCode
                + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
        return hashCode;
    }

    @Override
    public GetSampledRequestsRequest clone() {
        return (GetSampledRequestsRequest) super.clone();
    }
}