com.amazonaws.services.elasticache.model.DescribeEventsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticache Show documentation
/*
* Copyright 2010-2015 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.elasticache.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticache.AmazonElastiCache#describeEvents(DescribeEventsRequest) DescribeEvents operation}.
*
* The DescribeEvents action returns events related to cache
* clusters, cache security groups, and cache parameter groups. You can
* obtain events specific to a particular cache cluster, cache security
* group, or cache parameter group by providing the name as a parameter.
*
*
* By default, only the events occurring within the last hour are
* returned; however, you can retrieve up to 14 days' worth of events if
* necessary.
*
*
* @see com.amazonaws.services.elasticache.AmazonElastiCache#describeEvents(DescribeEventsRequest)
*/
public class DescribeEventsRequest extends 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 sourceIdentifier;
/**
* The event source to retrieve events for. If no value is specified, all
* events are returned. Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* Constraints:
* Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
*/
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 records to include in the response. If more
* records exist than the specified MaxRecords value, a
* 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 marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
private String marker;
/**
* Default constructor for a new DescribeEventsRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeEventsRequest() {}
/**
* 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 getSourceIdentifier() {
return sourceIdentifier;
}
/**
* The identifier of the event source for which events will be returned.
* If not specified, then all sources are included in the response.
*
* @param sourceIdentifier 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 setSourceIdentifier(String sourceIdentifier) {
this.sourceIdentifier = sourceIdentifier;
}
/**
* The identifier of the event source for which events will be returned.
* If not specified, then all sources are included in the response.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param sourceIdentifier The identifier of the event source for which events will be returned.
* If not specified, then all sources are included in the response.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeEventsRequest withSourceIdentifier(String sourceIdentifier) {
this.sourceIdentifier = sourceIdentifier;
return this;
}
/**
* The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* Constraints:
* Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
*
* @return The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* @see SourceType
*/
public String getSourceType() {
return sourceType;
}
/**
* The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* Constraints:
* Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
*
* @param sourceType The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* @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.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
*
* @param sourceType The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see SourceType
*/
public DescribeEventsRequest withSourceType(String sourceType) {
this.sourceType = sourceType;
return this;
}
/**
* The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* Constraints:
* Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
*
* @param sourceType The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* @see SourceType
*/
public void setSourceType(SourceType sourceType) {
this.sourceType = sourceType.toString();
}
/**
* The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group
*
* @param sourceType The event source to retrieve events for. If no value is specified, all
* events are returned.
Valid values are: cache-cluster |
* cache-parameter-group | cache-security-group
* | cache-subnet-group
*
* @return A reference to this updated 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.
*
* @return The beginning of the time interval to retrieve events for, specified
* in ISO 8601 format.
*/
public java.util.Date getStartTime() {
return 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.
*/
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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param startTime The beginning of the time interval to retrieve events for, specified
* in ISO 8601 format.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeEventsRequest withStartTime(java.util.Date startTime) {
this.startTime = startTime;
return this;
}
/**
* 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 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.
*/
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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param endTime The end of the time interval for which to retrieve events, specified
* in ISO 8601 format.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeEventsRequest withEndTime(java.util.Date endTime) {
this.endTime = endTime;
return this;
}
/**
* The number of minutes' worth of events to retrieve.
*
* @return The number of minutes' worth of events to retrieve.
*/
public Integer getDuration() {
return duration;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param duration The number of minutes' worth of events to retrieve.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeEventsRequest withDuration(Integer duration) {
this.duration = duration;
return this;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* 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
* 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 maxRecords;
}
/**
* The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* 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
* 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
* marker is included in the response so that the remaining results can
* be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxRecords The maximum number of records to include in the response. If more
* records exist than the specified MaxRecords value, a
* marker is included in the response so that the remaining results can
* be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeEventsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return An optional marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public String getMarker() {
return marker;
}
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @param marker An optional marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* An optional marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param marker An optional marker returned from a prior request. Use this marker for
* pagination of results from this action. If this parameter is
* specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeEventsRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getSourceIdentifier() + ",");
if (getSourceType() != null) sb.append("SourceType: " + getSourceType() + ",");
if (getStartTime() != null) sb.append("StartTime: " + getStartTime() + ",");
if (getEndTime() != null) sb.append("EndTime: " + getEndTime() + ",");
if (getDuration() != null) sb.append("Duration: " + getDuration() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() );
sb.append("}");
return sb.toString();
}
@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 + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@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.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 DescribeEventsRequest clone() {
return (DescribeEventsRequest) super.clone();
}
}