/* * 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.docdb.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *
* Represents the input to DescribeEvents. *
* * @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 are returned. If not specified, then all sources are included * in the response. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** 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. *
** Example: 2009-07-08T18:00Z *
*/ private java.util.Date startTime; /** ** The end of the time interval for which to retrieve events, specified in ISO 8601 format. *
** Example: 2009-07-08T18:00Z *
*/ private java.util.Date endTime; /** ** The number of minutes to retrieve events for. *
** Default: 60 *
*/ private Integer duration; /** ** A list of event categories that trigger notifications for an event notification subscription. *
*/ private java.util.List* This parameter is not currently supported. *
*/ private java.util.List
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords
value, a pagination token (marker) is included in the response so that the remaining
* results can be retrieved.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
*/ private Integer maxRecords; /** *
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
* The identifier of the event source for which events are returned. If not specified, then all sources are included * in the response. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** The identifier of the event source for which events are returned. If not specified, then all sources are included * in the response. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be
* provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** The identifier of the event source for which events are returned. If not specified, then all sources are included * in the response. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** Constraints: *
*
* If SourceIdentifier
is provided, SourceType
must also be provided.
*
* If the source type is DBInstance
, a DBInstanceIdentifier
must be provided.
*
* If the source type is DBSecurityGroup
, a DBSecurityGroupName
must be provided.
*
* If the source type is DBParameterGroup
, a DBParameterGroupName
must be provided.
*
* If the source type is DBSnapshot
, a DBSnapshotIdentifier
must be provided.
*
* Cannot end with a hyphen or contain two consecutive hyphens. *
** 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. * @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. *
** Example: 2009-07-08T18:00Z *
* * @param startTime * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. ** Example: 2009-07-08T18:00Z */ 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. *
** Example: 2009-07-08T18:00Z *
* * @return The beginning of the time interval to retrieve events for, specified in ISO 8601 format. ** Example: 2009-07-08T18:00Z */ public java.util.Date getStartTime() { return this.startTime; } /** *
* The beginning of the time interval to retrieve events for, specified in ISO 8601 format. *
** Example: 2009-07-08T18:00Z *
* * @param startTime * The beginning of the time interval to retrieve events for, specified in ISO 8601 format. ** Example: 2009-07-08T18:00Z * @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. *
** Example: 2009-07-08T18:00Z *
* * @param endTime * The end of the time interval for which to retrieve events, specified in ISO 8601 format. ** Example: 2009-07-08T18:00Z */ 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. *
** Example: 2009-07-08T18:00Z *
* * @return The end of the time interval for which to retrieve events, specified in ISO 8601 format. ** Example: 2009-07-08T18:00Z */ public java.util.Date getEndTime() { return this.endTime; } /** *
* The end of the time interval for which to retrieve events, specified in ISO 8601 format. *
** Example: 2009-07-08T18:00Z *
* * @param endTime * The end of the time interval for which to retrieve events, specified in ISO 8601 format. ** Example: 2009-07-08T18:00Z * @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 to retrieve events for. *
** Default: 60 *
* * @param duration * The number of minutes to retrieve events for. ** Default: 60 */ public void setDuration(Integer duration) { this.duration = duration; } /** *
* The number of minutes to retrieve events for. *
** Default: 60 *
* * @return The number of minutes to retrieve events for. ** Default: 60 */ public Integer getDuration() { return this.duration; } /** *
* The number of minutes to retrieve events for. *
** Default: 60 *
* * @param duration * The number of minutes to retrieve events for. ** Default: 60 * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEventsRequest withDuration(Integer duration) { setDuration(duration); return this; } /** *
* A list of event categories that trigger notifications for an event notification subscription. *
* * @return A list of event categories that trigger notifications for an event notification subscription. */ public java.util.List* A list of event categories that trigger notifications for an event notification subscription. *
* * @param eventCategories * A list of event categories that trigger notifications for an event notification subscription. */ public void setEventCategories(java.util.Collection* A list of event categories that trigger notifications for an event notification subscription. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setEventCategories(java.util.Collection)} or {@link #withEventCategories(java.util.Collection)} if you * want to override the existing values. *
* * @param eventCategories * A list of event categories that trigger notifications for an event notification subscription. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEventsRequest withEventCategories(String... eventCategories) { if (this.eventCategories == null) { setEventCategories(new java.util.ArrayList* A list of event categories that trigger notifications for an event notification subscription. *
* * @param eventCategories * A list of event categories that trigger notifications for an event notification subscription. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEventsRequest withEventCategories(java.util.Collection* This parameter is not currently supported. *
* * @return This parameter is not currently supported. */ public java.util.List* This parameter is not currently supported. *
* * @param filters * This parameter is not currently supported. */ public void setFilters(java.util.Collection* This parameter is not currently supported. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *
* * @param filters * This parameter is not currently supported. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEventsRequest withFilters(Filter... filters) { if (this.filters == null) { setFilters(new java.util.ArrayList* This parameter is not currently supported. *
* * @param filters * This parameter is not currently supported. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEventsRequest withFilters(java.util.Collection
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords
value, a pagination token (marker) is included in the response so that the remaining
* results can be retrieved.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
* * @param maxRecords * The maximum number of records to include in the response. If more records exist than the specified *MaxRecords
value, a pagination token (marker) is included in the response so that the
* remaining results can be retrieved.
* * Default: 100 *
** Constraints: Minimum 20, maximum 100. */ public void setMaxRecords(Integer maxRecords) { this.maxRecords = maxRecords; } /** *
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords
value, a pagination token (marker) is included in the response so that the remaining
* results can be retrieved.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
* * @return The maximum number of records to include in the response. If more records exist than the specified *MaxRecords
value, a pagination token (marker) is included in the response so that the
* remaining results can be retrieved.
* * Default: 100 *
** Constraints: Minimum 20, maximum 100. */ public Integer getMaxRecords() { return this.maxRecords; } /** *
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords
value, a pagination token (marker) is included in the response so that the remaining
* results can be retrieved.
*
* Default: 100 *
** Constraints: Minimum 20, maximum 100. *
* * @param maxRecords * The maximum number of records to include in the response. If more records exist than the specified *MaxRecords
value, a pagination token (marker) is included in the response so that the
* remaining results can be retrieved.
* * Default: 100 *
** Constraints: Minimum 20, maximum 100. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeEventsRequest withMaxRecords(Integer maxRecords) { setMaxRecords(maxRecords); return this; } /** *
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
MaxRecords
.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
MaxRecords
.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords
.
*
MaxRecords
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeEventsRequest withMarker(String marker) {
setMarker(marker);
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 (getSourceIdentifier() != null)
sb.append("SourceIdentifier: ").append(getSourceIdentifier()).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 (getEventCategories() != null)
sb.append("EventCategories: ").append(getEventCategories()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker());
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.getSourceIdentifier() == null ^ this.getSourceIdentifier() == null)
return false;
if (other.getSourceIdentifier() != null && other.getSourceIdentifier().equals(this.getSourceIdentifier()) == 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.getEventCategories() == null ^ this.getEventCategories() == null)
return false;
if (other.getEventCategories() != null && other.getEventCategories().equals(this.getEventCategories()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSourceIdentifier() == null) ? 0 : getSourceIdentifier().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 + ((getEventCategories() == null) ? 0 : getEventCategories().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public DescribeEventsRequest clone() {
return (DescribeEventsRequest) super.clone();
}
}