com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudwatch 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.cloudwatch.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 DescribeAlarmHistoryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the alarm.
*
*/
private String alarmName;
/**
*
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter, only metric alarms are returned.
*
*/
private com.amazonaws.internal.SdkInternalList alarmTypes;
/**
*
* The type of alarm histories to retrieve.
*
*/
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.
*
*/
private Integer maxRecords;
/**
*
* The token returned by a previous call to indicate that there is more data available.
*
*/
private String nextToken;
/**
*
* Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
* have the newest event history returned first, and specify TimestampAscending to have the oldest
* history returned first.
*
*/
private String scanBy;
/**
*
* The name of the alarm.
*
*
* @param alarmName
* The name of the alarm.
*/
public void setAlarmName(String alarmName) {
this.alarmName = alarmName;
}
/**
*
* The name of the alarm.
*
*
* @return The name of the alarm.
*/
public String getAlarmName() {
return this.alarmName;
}
/**
*
* The name of the alarm.
*
*
* @param alarmName
* The name of the alarm.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmHistoryRequest withAlarmName(String alarmName) {
setAlarmName(alarmName);
return this;
}
/**
*
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter, only metric alarms are returned.
*
*
* @return Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
* If you omit this parameter, only metric alarms are returned.
* @see AlarmType
*/
public java.util.List getAlarmTypes() {
if (alarmTypes == null) {
alarmTypes = new com.amazonaws.internal.SdkInternalList();
}
return alarmTypes;
}
/**
*
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter, only metric alarms are returned.
*
*
* @param alarmTypes
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
* If you omit this parameter, only metric alarms are returned.
* @see AlarmType
*/
public void setAlarmTypes(java.util.Collection alarmTypes) {
if (alarmTypes == null) {
this.alarmTypes = null;
return;
}
this.alarmTypes = new com.amazonaws.internal.SdkInternalList(alarmTypes);
}
/**
*
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter, only metric alarms are returned.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAlarmTypes(java.util.Collection)} or {@link #withAlarmTypes(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param alarmTypes
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
* If you omit this parameter, only metric alarms are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlarmType
*/
public DescribeAlarmHistoryRequest withAlarmTypes(String... alarmTypes) {
if (this.alarmTypes == null) {
setAlarmTypes(new com.amazonaws.internal.SdkInternalList(alarmTypes.length));
}
for (String ele : alarmTypes) {
this.alarmTypes.add(ele);
}
return this;
}
/**
*
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter, only metric alarms are returned.
*
*
* @param alarmTypes
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
* If you omit this parameter, only metric alarms are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlarmType
*/
public DescribeAlarmHistoryRequest withAlarmTypes(java.util.Collection alarmTypes) {
setAlarmTypes(alarmTypes);
return this;
}
/**
*
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you
* omit this parameter, only metric alarms are returned.
*
*
* @param alarmTypes
* Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
* If you omit this parameter, only metric alarms are returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlarmType
*/
public DescribeAlarmHistoryRequest withAlarmTypes(AlarmType... alarmTypes) {
com.amazonaws.internal.SdkInternalList alarmTypesCopy = new com.amazonaws.internal.SdkInternalList(alarmTypes.length);
for (AlarmType value : alarmTypes) {
alarmTypesCopy.add(value.toString());
}
if (getAlarmTypes() == null) {
setAlarmTypes(alarmTypesCopy);
} else {
getAlarmTypes().addAll(alarmTypesCopy);
}
return this;
}
/**
*
* The type of alarm histories to retrieve.
*
*
* @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.
*
*
* @return The type of alarm histories to retrieve.
* @see HistoryItemType
*/
public String getHistoryItemType() {
return this.historyItemType;
}
/**
*
* The type of alarm histories to retrieve.
*
*
* @param historyItemType
* The type of alarm histories to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
* @see HistoryItemType
*/
public DescribeAlarmHistoryRequest withHistoryItemType(String historyItemType) {
setHistoryItemType(historyItemType);
return this;
}
/**
*
* The type of alarm histories to retrieve.
*
*
* @param historyItemType
* The type of alarm histories to retrieve.
* @see HistoryItemType
*/
public void setHistoryItemType(HistoryItemType historyItemType) {
withHistoryItemType(historyItemType);
}
/**
*
* The type of alarm histories to retrieve.
*
*
* @param historyItemType
* The type of alarm histories to retrieve.
* @return Returns a reference to this 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.
*
*
* @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.
*
*
* @return The starting date to retrieve alarm history.
*/
public java.util.Date getStartDate() {
return this.startDate;
}
/**
*
* The starting date to retrieve alarm history.
*
*
* @param startDate
* The starting date to retrieve alarm history.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmHistoryRequest withStartDate(java.util.Date startDate) {
setStartDate(startDate);
return this;
}
/**
*
* 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.
*
*
* @return The ending date to retrieve alarm history.
*/
public java.util.Date getEndDate() {
return this.endDate;
}
/**
*
* The ending date to retrieve alarm history.
*
*
* @param endDate
* The ending date to retrieve alarm history.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmHistoryRequest withEndDate(java.util.Date endDate) {
setEndDate(endDate);
return this;
}
/**
*
* The maximum number of alarm history records to retrieve.
*
*
* @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.
*
*
* @return The maximum number of alarm history records to retrieve.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
*
* The maximum number of alarm history records to retrieve.
*
*
* @param maxRecords
* The maximum number of alarm history records to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmHistoryRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* 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.
*
*
* @return The token returned by a previous call to indicate that there is more data available.
*/
public String getNextToken() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmHistoryRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
* have the newest event history returned first, and specify TimestampAscending to have the oldest
* history returned first.
*
*
* @param scanBy
* Specified whether to return the newest or oldest alarm history first. Specify
* TimestampDescending to have the newest event history returned first, and specify
* TimestampAscending to have the oldest history returned first.
* @see ScanBy
*/
public void setScanBy(String scanBy) {
this.scanBy = scanBy;
}
/**
*
* Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
* have the newest event history returned first, and specify TimestampAscending to have the oldest
* history returned first.
*
*
* @return Specified whether to return the newest or oldest alarm history first. Specify
* TimestampDescending to have the newest event history returned first, and specify
* TimestampAscending to have the oldest history returned first.
* @see ScanBy
*/
public String getScanBy() {
return this.scanBy;
}
/**
*
* Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
* have the newest event history returned first, and specify TimestampAscending to have the oldest
* history returned first.
*
*
* @param scanBy
* Specified whether to return the newest or oldest alarm history first. Specify
* TimestampDescending to have the newest event history returned first, and specify
* TimestampAscending to have the oldest history returned first.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScanBy
*/
public DescribeAlarmHistoryRequest withScanBy(String scanBy) {
setScanBy(scanBy);
return this;
}
/**
*
* Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
* have the newest event history returned first, and specify TimestampAscending to have the oldest
* history returned first.
*
*
* @param scanBy
* Specified whether to return the newest or oldest alarm history first. Specify
* TimestampDescending to have the newest event history returned first, and specify
* TimestampAscending to have the oldest history returned first.
* @see ScanBy
*/
public void setScanBy(ScanBy scanBy) {
withScanBy(scanBy);
}
/**
*
* Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to
* have the newest event history returned first, and specify TimestampAscending to have the oldest
* history returned first.
*
*
* @param scanBy
* Specified whether to return the newest or oldest alarm history first. Specify
* TimestampDescending to have the newest event history returned first, and specify
* TimestampAscending to have the oldest history returned first.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScanBy
*/
public DescribeAlarmHistoryRequest withScanBy(ScanBy scanBy) {
this.scanBy = scanBy.toString();
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 (getAlarmName() != null)
sb.append("AlarmName: ").append(getAlarmName()).append(",");
if (getAlarmTypes() != null)
sb.append("AlarmTypes: ").append(getAlarmTypes()).append(",");
if (getHistoryItemType() != null)
sb.append("HistoryItemType: ").append(getHistoryItemType()).append(",");
if (getStartDate() != null)
sb.append("StartDate: ").append(getStartDate()).append(",");
if (getEndDate() != null)
sb.append("EndDate: ").append(getEndDate()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getScanBy() != null)
sb.append("ScanBy: ").append(getScanBy());
sb.append("}");
return sb.toString();
}
@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.getAlarmTypes() == null ^ this.getAlarmTypes() == null)
return false;
if (other.getAlarmTypes() != null && other.getAlarmTypes().equals(this.getAlarmTypes()) == 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;
if (other.getScanBy() == null ^ this.getScanBy() == null)
return false;
if (other.getScanBy() != null && other.getScanBy().equals(this.getScanBy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAlarmName() == null) ? 0 : getAlarmName().hashCode());
hashCode = prime * hashCode + ((getAlarmTypes() == null) ? 0 : getAlarmTypes().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());
hashCode = prime * hashCode + ((getScanBy() == null) ? 0 : getScanBy().hashCode());
return hashCode;
}
@Override
public DescribeAlarmHistoryRequest clone() {
return (DescribeAlarmHistoryRequest) super.clone();
}
}