com.amazonaws.services.dax.model.DescribeEventsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dax Show documentation
/*
* Copyright 2018-2023 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.dax.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeEventsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the event source for which events will be returned. If not specified, then all sources are
* included in the response.
*
*/
private String sourceName;
/**
*
* The event source to retrieve events for. If no value is specified, all events are returned.
*
*/
private String sourceType;
/**
*
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*
*/
private java.util.Date startTime;
/**
*
* The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*
*/
private java.util.Date endTime;
/**
*
* The number of minutes' worth of events to retrieve.
*
*/
private Integer duration;
/**
*
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
*
* The value for MaxResults must be between 20 and 100.
*
*/
private Integer maxResults;
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action. If
* this parameter is specified, the response includes only results beyond the token, up to the value specified by
* MaxResults.
*
*/
private String nextToken;
/**
*
* The identifier of the event source for which events will be returned. If not specified, then all sources are
* included in the response.
*
*
* @param sourceName
* The identifier of the event source for which events will be returned. If not specified, then all sources
* are included in the response.
*/
public void setSourceName(String sourceName) {
this.sourceName = sourceName;
}
/**
*
* The identifier of the event source for which events will be returned. If not specified, then all sources are
* included in the response.
*
*
* @return The identifier of the event source for which events will be returned. If not specified, then all sources
* are included in the response.
*/
public String getSourceName() {
return this.sourceName;
}
/**
*
* The identifier of the event source for which events will be returned. If not specified, then all sources are
* included in the response.
*
*
* @param sourceName
* The identifier of the event source for which events will be returned. If not specified, then all sources
* are included in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withSourceName(String sourceName) {
setSourceName(sourceName);
return this;
}
/**
*
* The event source to retrieve events for. If no value is specified, all events are returned.
*
*
* @param sourceType
* The event source to retrieve events for. If no value is specified, all events are returned.
* @see SourceType
*/
public void setSourceType(String sourceType) {
this.sourceType = sourceType;
}
/**
*
* The event source to retrieve events for. If no value is specified, all events are returned.
*
*
* @return The event source to retrieve events for. If no value is specified, all events are returned.
* @see SourceType
*/
public String getSourceType() {
return this.sourceType;
}
/**
*
* The event source to retrieve events for. If no value is specified, all events are returned.
*
*
* @param sourceType
* The event source to retrieve events for. If no value is specified, all events are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceType
*/
public DescribeEventsRequest withSourceType(String sourceType) {
setSourceType(sourceType);
return this;
}
/**
*
* The event source to retrieve events for. If no value is specified, all events are returned.
*
*
* @param sourceType
* The event source to retrieve events for. If no value is specified, all events are returned.
* @see SourceType
*/
public void setSourceType(SourceType sourceType) {
withSourceType(sourceType);
}
/**
*
* The event source to retrieve events for. If no value is specified, all events are returned.
*
*
* @param sourceType
* The event source to retrieve events for. If no value is specified, all events are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceType
*/
public DescribeEventsRequest withSourceType(SourceType sourceType) {
this.sourceType = sourceType.toString();
return this;
}
/**
*
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*
*
* @param startTime
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*
*
* @return The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
*
*
* @param startTime
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*
*
* @param endTime
* The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*
*
* @return The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end of the time interval for which to retrieve events, specified in ISO 8601 format.
*
*
* @param endTime
* The end of the time interval for which to retrieve events, specified in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The number of minutes' worth of events to retrieve.
*
*
* @param duration
* The number of minutes' worth of events to retrieve.
*/
public void setDuration(Integer duration) {
this.duration = duration;
}
/**
*
* The number of minutes' worth of events to retrieve.
*
*
* @return The number of minutes' worth of events to retrieve.
*/
public Integer getDuration() {
return this.duration;
}
/**
*
* The number of minutes' worth of events to retrieve.
*
*
* @param duration
* The number of minutes' worth of events to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withDuration(Integer duration) {
setDuration(duration);
return this;
}
/**
*
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
*
* The value for MaxResults must be between 20 and 100.
*
*
* @param maxResults
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
* The value for MaxResults must be between 20 and 100.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
*
* The value for MaxResults must be between 20 and 100.
*
*
* @return The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
* The value for MaxResults must be between 20 and 100.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
*
* The value for MaxResults must be between 20 and 100.
*
*
* @param maxResults
* The maximum number of results to include in the response. If more results exist than the specified
* MaxResults value, a token is included in the response so that the remaining results can be
* retrieved.
*
* The value for MaxResults must be between 20 and 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action. If
* this parameter is specified, the response includes only results beyond the token, up to the value specified by
* MaxResults.
*
*
* @param nextToken
* An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response includes only results beyond the token, up to the
* value specified by MaxResults.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action. If
* this parameter is specified, the response includes only results beyond the token, up to the value specified by
* MaxResults.
*
*
* @return An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response includes only results beyond the token, up to the
* value specified by MaxResults.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* An optional token returned from a prior request. Use this token for pagination of results from this action. If
* this parameter is specified, the response includes only results beyond the token, up to the value specified by
* MaxResults.
*
*
* @param nextToken
* An optional token returned from a prior request. Use this token for pagination of results from this
* action. If this parameter is specified, the response includes only results beyond the token, up to the
* value specified by MaxResults.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getSourceName() != null)
sb.append("SourceName: ").append(getSourceName()).append(",");
if (getSourceType() != null)
sb.append("SourceType: ").append(getSourceType()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getDuration() != null)
sb.append("Duration: ").append(getDuration()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeEventsRequest == false)
return false;
DescribeEventsRequest other = (DescribeEventsRequest) obj;
if (other.getSourceName() == null ^ this.getSourceName() == null)
return false;
if (other.getSourceName() != null && other.getSourceName().equals(this.getSourceName()) == false)
return false;
if (other.getSourceType() == null ^ this.getSourceType() == null)
return false;
if (other.getSourceType() != null && other.getSourceType().equals(this.getSourceType()) == false)
return false;
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;
if (other.getDuration() == null ^ this.getDuration() == null)
return false;
if (other.getDuration() != null && other.getDuration().equals(this.getDuration()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceName() == null) ? 0 : getSourceName().hashCode());
hashCode = prime * hashCode + ((getSourceType() == null) ? 0 : getSourceType().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getDuration() == null) ? 0 : getDuration().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeEventsRequest clone() {
return (DescribeEventsRequest) super.clone();
}
}