com.amazonaws.services.cloudwatch.model

Class DescribeAlarmHistoryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAlarmHistoryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeAlarmHistoryRequest()

Method Summary

Modifier and Type	Method and Description
DescribeAlarmHistoryRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAlarmName() The name of the alarm.
List<String>	getAlarmTypes() Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
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.
String	getScanBy() Specified whether to return the newest or oldest alarm history first.
Date	getStartDate() The starting date to retrieve alarm history.
int	hashCode()
void	setAlarmName(String alarmName) The name of the alarm.
void	setAlarmTypes(Collection<String> alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
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	setScanBy(ScanBy scanBy) Specified whether to return the newest or oldest alarm history first.
void	setScanBy(String scanBy) Specified whether to return the newest or oldest alarm history first.
void	setStartDate(Date startDate) The starting date to retrieve alarm history.
String	toString() Returns a string representation of this object.
DescribeAlarmHistoryRequest	withAlarmName(String alarmName) The name of the alarm.
DescribeAlarmHistoryRequest	withAlarmTypes(AlarmType... alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
DescribeAlarmHistoryRequest	withAlarmTypes(Collection<String> alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
DescribeAlarmHistoryRequest	withAlarmTypes(String... alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
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	withScanBy(ScanBy scanBy) Specified whether to return the newest or oldest alarm history first.
DescribeAlarmHistoryRequest	withScanBy(String scanBy) Specified whether to return the newest or oldest alarm history first.
DescribeAlarmHistoryRequest	withStartDate(Date startDate) The starting date to retrieve alarm history.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeAlarmHistoryRequest

public DescribeAlarmHistoryRequest()

Method Detail

setAlarmName

public void setAlarmName(String alarmName)

The name of the alarm.

Parameters:

alarmName - The name of the alarm.

getAlarmName

public String getAlarmName()

The name of the alarm.

Returns:

The name of the alarm.

withAlarmName

public DescribeAlarmHistoryRequest withAlarmName(String alarmName)

The name of the alarm.

Parameters:

alarmName - The name of the alarm.

Returns:

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

getAlarmTypes

public List<String> getAlarmTypes()

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.

Returns:

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 Also:

AlarmType

setAlarmTypes

public void setAlarmTypes(Collection<String> 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.

Parameters:

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 Also:

AlarmType

withAlarmTypes

public DescribeAlarmHistoryRequest withAlarmTypes(String... 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 setAlarmTypes(java.util.Collection) or withAlarmTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

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

See Also:

AlarmType

withAlarmTypes

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

Parameters:

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.

Returns:

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

See Also:

AlarmType

withAlarmTypes

public DescribeAlarmHistoryRequest withAlarmTypes(AlarmType... 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.

Parameters:

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.

Returns:

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

See Also:

AlarmType

setHistoryItemType

public void setHistoryItemType(String historyItemType)

The type of alarm histories to retrieve.

Parameters:

historyItemType - The type of alarm histories to retrieve.

See Also:

HistoryItemType

getHistoryItemType

public String getHistoryItemType()

The type of alarm histories to retrieve.

Returns:

The type of alarm histories to retrieve.

See Also:

HistoryItemType

withHistoryItemType

public DescribeAlarmHistoryRequest withHistoryItemType(String historyItemType)

The type of alarm histories to retrieve.

Parameters:

historyItemType - The type of alarm histories to retrieve.

Returns:

Returns a reference to this 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.

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.

Parameters:

historyItemType - The type of alarm histories to retrieve.

Returns:

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

See Also:

HistoryItemType

setStartDate

public void setStartDate(Date startDate)

The starting date to retrieve alarm history.

Parameters:

startDate - The starting date to retrieve alarm history.

getStartDate

public Date getStartDate()

The starting date to retrieve alarm history.

Returns:

The starting date to retrieve alarm history.

withStartDate

public DescribeAlarmHistoryRequest withStartDate(Date startDate)

The starting date to retrieve alarm history.

Parameters:

startDate - The starting date to retrieve alarm history.

Returns:

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

setEndDate

public void setEndDate(Date endDate)

The ending date to retrieve alarm history.

Parameters:

endDate - The ending date to retrieve alarm history.

getEndDate

public Date getEndDate()

The ending date to retrieve alarm history.

Returns:

The ending date to retrieve alarm history.

withEndDate

public DescribeAlarmHistoryRequest withEndDate(Date endDate)

The ending date to retrieve alarm history.

Parameters:

endDate - The ending date to retrieve alarm history.

Returns:

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

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of alarm history records to retrieve.

Parameters:

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

getMaxRecords

public Integer getMaxRecords()

The maximum number of alarm history records to retrieve.

Returns:

The maximum number of alarm history records to retrieve.

withMaxRecords

public DescribeAlarmHistoryRequest withMaxRecords(Integer maxRecords)

The maximum number of alarm history records to retrieve.

Parameters:

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

Returns:

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

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.

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.

withNextToken

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

Returns:

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

setScanBy

public void setScanBy(String 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.

Parameters:

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 Also:

ScanBy

getScanBy

public String getScanBy()

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.

Returns:

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 Also:

ScanBy

withScanBy

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

Parameters:

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.

Returns:

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

See Also:

ScanBy

setScanBy

public void setScanBy(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.

Parameters:

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 Also:

ScanBy

withScanBy

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

Parameters:

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.

Returns:

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

See Also:

ScanBy

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeAlarmHistoryRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()