com.amazonaws.services.wafv2.model.TimeWindow Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2019-2024 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.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* In a GetSampledRequests request, the StartTime and EndTime objects specify the time
* range for which you want WAF to return a sample of web 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.
*
*
* In a GetSampledRequests response, the StartTime and EndTime objects specify the time
* range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among
* the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your
* resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that
* case, EndTime is the time that WAF received the 5,000th request.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TimeWindow implements Serializable, Cloneable, StructuredPojo {
/**
*
* The beginning of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
*
*/
private java.util.Date startTime;
/**
*
* The end of the time range from which you want GetSampledRequests to return a sample of the requests
* that your Amazon Web Services resource received. 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.
*
*/
private java.util.Date endTime;
/**
*
* The beginning of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
*
*
* @param startTime
* The beginning of the time range from which you want GetSampledRequests to return a sample of
* the requests that your Amazon Web Services resource received. 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.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The beginning of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
*
*
* @return The beginning of the time range from which you want GetSampledRequests to return a sample of
* the requests that your Amazon Web Services resource received. 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.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The beginning of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
*
*
* @param startTime
* The beginning of the time range from which you want GetSampledRequests to return a sample of
* the requests that your Amazon Web Services resource received. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TimeWindow withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The end of the time range from which you want GetSampledRequests to return a sample of the requests
* that your Amazon Web Services resource received. 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.
*
*
* @param endTime
* The end of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end of the time range from which you want GetSampledRequests to return a sample of the requests
* that your Amazon Web Services resource received. 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.
*
*
* @return The end of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end of the time range from which you want GetSampledRequests to return a sample of the requests
* that your Amazon Web Services resource received. 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.
*
*
* @param endTime
* The end of the time range from which you want GetSampledRequests to return a sample of the
* requests that your Amazon Web Services resource received. 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TimeWindow withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TimeWindow == false)
return false;
TimeWindow other = (TimeWindow) obj;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
return hashCode;
}
@Override
public TimeWindow clone() {
try {
return (TimeWindow) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.wafv2.model.transform.TimeWindowMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}