Class TimeWindow

java.lang.Object
com.amazonaws.services.waf.model.TimeWindow
All Implemented Interfaces:
Serializable, Cloneable

public class TimeWindow extends Object implements Serializable, Cloneable

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
     
    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received.
    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received.
    int
     
    void
    setEndTime(Date endTime)
    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received.
    void
    setStartTime(Date startTime)
    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received.
    Returns a string representation of this object; useful for testing and debugging.
    withEndTime(Date endTime)
    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received.
    withStartTime(Date startTime)
    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received.

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • TimeWindow

      public TimeWindow()
  • Method Details

    • setStartTime

      public void setStartTime(Date startTime)

      The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

      Parameters:
      startTime - The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.
    • getStartTime

      public Date getStartTime()

      The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

      Returns:
      The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.
    • withStartTime

      public TimeWindow withStartTime(Date startTime)

      The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

      Parameters:
      startTime - The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. 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.
    • setEndTime

      public void setEndTime(Date endTime)

      The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

      Parameters:
      endTime - The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.
    • getEndTime

      public Date getEndTime()

      The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

      Returns:
      The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.
    • withEndTime

      public TimeWindow withEndTime(Date endTime)

      The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

      Parameters:
      endTime - The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. 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.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public TimeWindow clone()
      Overrides:
      clone in class Object