com.amazonaws.services.cloudwatch.model

Class DescribeAlarmHistoryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeAlarmHistoryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the 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 Also:

AmazonCloudWatch.describeAlarmHistory(DescribeAlarmHistoryRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAlarmHistoryRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeAlarmHistoryRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAlarmName() The name of the alarm.
Date	getEndDate() The ending date to retrieve alarm history.
String	getHistoryItemType() The type of alarm histories to retrieve.
Integer	getMaxRecords() The maximum number of alarm history records to retrieve.
String	getNextToken() The token returned by a previous call to indicate that there is more data available.
Date	getStartDate() The starting date to retrieve alarm history.
int	hashCode()
void	setAlarmName(String alarmName) The name of the alarm.
void	setEndDate(Date endDate) The ending date to retrieve alarm history.
void	setHistoryItemType(HistoryItemType historyItemType) The type of alarm histories to retrieve.
void	setHistoryItemType(String historyItemType) The type of alarm histories to retrieve.
void	setMaxRecords(Integer maxRecords) The maximum number of alarm history records to retrieve.
void	setNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
void	setStartDate(Date startDate) The starting date to retrieve alarm history.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeAlarmHistoryRequest	withAlarmName(String alarmName) The name of the alarm.
DescribeAlarmHistoryRequest	withEndDate(Date endDate) The ending date to retrieve alarm history.
DescribeAlarmHistoryRequest	withHistoryItemType(HistoryItemType historyItemType) The type of alarm histories to retrieve.
DescribeAlarmHistoryRequest	withHistoryItemType(String historyItemType) The type of alarm histories to retrieve.
DescribeAlarmHistoryRequest	withMaxRecords(Integer maxRecords) The maximum number of alarm history records to retrieve.
DescribeAlarmHistoryRequest	withNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
DescribeAlarmHistoryRequest	withStartDate(Date startDate) The starting date to retrieve alarm history.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAlarmHistoryRequest

public DescribeAlarmHistoryRequest()

Method Detail

getAlarmName

public String getAlarmName()

The name of the alarm.

Constraints:
Length: 1 - 255

Returns:

The name of the alarm.

setAlarmName

public void setAlarmName(String alarmName)

The name of the alarm.

Constraints:
Length: 1 - 255

Parameters:

alarmName - The name of the alarm.

withAlarmName

public DescribeAlarmHistoryRequest withAlarmName(String alarmName)

The name of the alarm.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

alarmName - The name of the alarm.

Returns:

A reference to this updated object so that method calls can be chained together.

getHistoryItemType

public String getHistoryItemType()

The type of alarm histories to retrieve.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

Returns:

The type of alarm histories to retrieve.

See Also:

HistoryItemType

setHistoryItemType

public void setHistoryItemType(String historyItemType)

The type of alarm histories to retrieve.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

Parameters:

historyItemType - The type of alarm histories to retrieve.

See Also:

HistoryItemType

withHistoryItemType

public DescribeAlarmHistoryRequest withHistoryItemType(String 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

Parameters:

historyItemType - The type of alarm histories to retrieve.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

HistoryItemType

setHistoryItemType

public void setHistoryItemType(HistoryItemType historyItemType)

The type of alarm histories to retrieve.

Constraints:
Allowed Values: ConfigurationUpdate, StateUpdate, Action

Parameters:

historyItemType - The type of alarm histories to retrieve.

See Also:

HistoryItemType

withHistoryItemType

public DescribeAlarmHistoryRequest withHistoryItemType(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

Parameters:

historyItemType - The type of alarm histories to retrieve.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

HistoryItemType

getStartDate

public Date getStartDate()

The starting date to retrieve alarm history.

Returns:

The starting date to retrieve alarm history.

setStartDate

public void setStartDate(Date startDate)

The starting date to retrieve alarm history.

Parameters:

startDate - The starting date to retrieve alarm history.

withStartDate

public DescribeAlarmHistoryRequest withStartDate(Date startDate)

The starting date to retrieve alarm history.

Returns a reference to this object so that method calls can be chained together.

Parameters:

startDate - The starting date to retrieve alarm history.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndDate

public Date getEndDate()

The ending date to retrieve alarm history.

Returns:

The ending date to retrieve alarm history.

setEndDate

public void setEndDate(Date endDate)

The ending date to retrieve alarm history.

Parameters:

endDate - The ending date to retrieve alarm history.

withEndDate

public DescribeAlarmHistoryRequest withEndDate(Date endDate)

The ending date to retrieve alarm history.

Returns a reference to this object so that method calls can be chained together.

Parameters:

endDate - The ending date to retrieve alarm history.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

The maximum number of alarm history records to retrieve.

Constraints:
Range: 1 - 100

Returns:

The maximum number of alarm history records to retrieve.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of alarm history records to retrieve.

Constraints:
Range: 1 - 100

Parameters:

maxRecords - The maximum number of alarm history records to retrieve.

withMaxRecords

public DescribeAlarmHistoryRequest withMaxRecords(Integer 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

Parameters:

maxRecords - The maximum number of alarm history records to retrieve.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The token returned by a previous call to indicate that there is more data available.

Returns:

The token returned by a previous call to indicate that there is more data available.

setNextToken

public void setNextToken(String nextToken)

The token returned by a previous call to indicate that there is more data available.

Parameters:

nextToken - The token returned by a previous call to indicate that there is more data available.

withNextToken

public DescribeAlarmHistoryRequest withNextToken(String 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.

Parameters:

nextToken - The token returned by a previous call to indicate that there is more data available.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeAlarmHistoryRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()