com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.cloudwatch.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.cloudwatch.AmazonCloudWatch#describeAlarmHistory(DescribeAlarmHistoryRequest) DescribeAlarmHistory operation}.
*
* Retrieves history for the specified alarm. Filter alarms by date
* range or item type. If an alarm name is not specified, Amazon
* CloudWatch returns histories for all of the owner's alarms.
*
*
* NOTE: Amazon CloudWatch retains the history of an alarm for two
* weeks, whether or not you delete the alarm.
*
*
* @see com.amazonaws.services.cloudwatch.AmazonCloudWatch#describeAlarmHistory(DescribeAlarmHistoryRequest)
*/
public class DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the alarm.
*
* Constraints:
* Length: 1 - 255
*/
private String alarmName;
/**
* The type of alarm histories to retrieve.
*
* Constraints:
* Allowed Values: ConfigurationUpdate, StateUpdate, Action
*/
private String historyItemType;
/**
* The starting date to retrieve alarm history.
*/
private java.util.Date startDate;
/**
* The ending date to retrieve alarm history.
*/
private java.util.Date endDate;
/**
* The maximum number of alarm history records to retrieve.
*
* Constraints:
* Range: 1 - 100
*/
private Integer maxRecords;
/**
* The token returned by a previous call to indicate that there is more
* data available.
*/
private String nextToken;
/**
* The name of the alarm.
*
* Constraints:
* Length: 1 - 255
*
* @return The name of the alarm.
*/
public String getAlarmName() {
return alarmName;
}
/**
* The name of the alarm.
*
* Constraints:
* Length: 1 - 255
*
* @param alarmName The name of the alarm.
*/
public void setAlarmName(String alarmName) {
this.alarmName = alarmName;
}
/**
* The name of the alarm.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
*
* @param alarmName The name of the alarm.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmHistoryRequest withAlarmName(String alarmName) {
this.alarmName = alarmName;
return this;
}
/**
* The type of alarm histories to retrieve.
*
* Constraints:
* Allowed Values: ConfigurationUpdate, StateUpdate, Action
*
* @return The type of alarm histories to retrieve.
*
* @see HistoryItemType
*/
public String getHistoryItemType() {
return historyItemType;
}
/**
* The type of alarm histories to retrieve.
*
* Constraints:
* Allowed Values: ConfigurationUpdate, StateUpdate, Action
*
* @param historyItemType The type of alarm histories to retrieve.
*
* @see HistoryItemType
*/
public void setHistoryItemType(String historyItemType) {
this.historyItemType = historyItemType;
}
/**
* The type of alarm histories to retrieve.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: ConfigurationUpdate, StateUpdate, Action
*
* @param historyItemType The type of alarm histories to retrieve.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see HistoryItemType
*/
public DescribeAlarmHistoryRequest withHistoryItemType(String historyItemType) {
this.historyItemType = historyItemType;
return this;
}
/**
* The type of alarm histories to retrieve.
*
* Constraints:
* Allowed Values: ConfigurationUpdate, StateUpdate, Action
*
* @param historyItemType The type of alarm histories to retrieve.
*
* @see HistoryItemType
*/
public void setHistoryItemType(HistoryItemType historyItemType) {
this.historyItemType = historyItemType.toString();
}
/**
* The type of alarm histories to retrieve.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: ConfigurationUpdate, StateUpdate, Action
*
* @param historyItemType The type of alarm histories to retrieve.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see HistoryItemType
*/
public DescribeAlarmHistoryRequest withHistoryItemType(HistoryItemType historyItemType) {
this.historyItemType = historyItemType.toString();
return this;
}
/**
* The starting date to retrieve alarm history.
*
* @return The starting date to retrieve alarm history.
*/
public java.util.Date getStartDate() {
return startDate;
}
/**
* The starting date to retrieve alarm history.
*
* @param startDate The starting date to retrieve alarm history.
*/
public void setStartDate(java.util.Date startDate) {
this.startDate = startDate;
}
/**
* The starting date to retrieve alarm history.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param startDate The starting date to retrieve alarm history.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmHistoryRequest withStartDate(java.util.Date startDate) {
this.startDate = startDate;
return this;
}
/**
* The ending date to retrieve alarm history.
*
* @return The ending date to retrieve alarm history.
*/
public java.util.Date getEndDate() {
return endDate;
}
/**
* The ending date to retrieve alarm history.
*
* @param endDate The ending date to retrieve alarm history.
*/
public void setEndDate(java.util.Date endDate) {
this.endDate = endDate;
}
/**
* The ending date to retrieve alarm history.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param endDate The ending date to retrieve alarm history.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmHistoryRequest withEndDate(java.util.Date endDate) {
this.endDate = endDate;
return this;
}
/**
* The maximum number of alarm history records to retrieve.
*
* Constraints:
* Range: 1 - 100
*
* @return The maximum number of alarm history records to retrieve.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of alarm history records to retrieve.
*
* Constraints:
* Range: 1 - 100
*
* @param maxRecords The maximum number of alarm history records to retrieve.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of alarm history records to retrieve.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 100
*
* @param maxRecords The maximum number of alarm history records to retrieve.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmHistoryRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* @return The token returned by a previous call to indicate that there is more
* data available.
*/
public String getNextToken() {
return nextToken;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* @param nextToken The token returned by a previous call to indicate that there is more
* data available.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The token returned by a previous call to indicate that there is more
* data available.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmHistoryRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
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 (getAlarmName() != null) sb.append("AlarmName: " + getAlarmName() + ",");
if (getHistoryItemType() != null) sb.append("HistoryItemType: " + getHistoryItemType() + ",");
if (getStartDate() != null) sb.append("StartDate: " + getStartDate() + ",");
if (getEndDate() != null) sb.append("EndDate: " + getEndDate() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAlarmName() == null) ? 0 : getAlarmName().hashCode());
hashCode = prime * hashCode + ((getHistoryItemType() == null) ? 0 : getHistoryItemType().hashCode());
hashCode = prime * hashCode + ((getStartDate() == null) ? 0 : getStartDate().hashCode());
hashCode = prime * hashCode + ((getEndDate() == null) ? 0 : getEndDate().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeAlarmHistoryRequest == false) return false;
DescribeAlarmHistoryRequest other = (DescribeAlarmHistoryRequest)obj;
if (other.getAlarmName() == null ^ this.getAlarmName() == null) return false;
if (other.getAlarmName() != null && other.getAlarmName().equals(this.getAlarmName()) == false) return false;
if (other.getHistoryItemType() == null ^ this.getHistoryItemType() == null) return false;
if (other.getHistoryItemType() != null && other.getHistoryItemType().equals(this.getHistoryItemType()) == false) return false;
if (other.getStartDate() == null ^ this.getStartDate() == null) return false;
if (other.getStartDate() != null && other.getStartDate().equals(this.getStartDate()) == false) return false;
if (other.getEndDate() == null ^ this.getEndDate() == null) return false;
if (other.getEndDate() != null && other.getEndDate().equals(this.getEndDate()) == 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.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false;
return true;
}
}