Class 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:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      TimeWindow()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TimeWindow clone()  
      boolean equals​(Object obj)  
      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.
      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.
      int hashCode()  
      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.
      String toString()
      Returns a string representation of this object; useful for testing and debugging.
      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.
      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.
    • Constructor Detail

      • TimeWindow

        public TimeWindow()
    • Method Detail

      • 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:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object