Package software.amazon.awssdk.services.cloudwatch.model

Class DescribeAlarmHistoryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest

software.amazon.awssdk.services.cloudwatch.model.DescribeAlarmHistoryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeAlarmHistoryRequest
extends CloudWatchRequest
implements ToCopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeAlarmHistoryRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alarmName()	The name of the alarm.
List<AlarmType>	alarmTypes()	Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
List<String>	alarmTypesAsStrings()	Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.
static DescribeAlarmHistoryRequest.Builder	builder()
Instant	endDate()	The ending date to retrieve alarm history.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAlarmTypes()	For responses, this returns true if the service returned a value for the AlarmTypes property.
int	hashCode()
HistoryItemType	historyItemType()	The type of alarm histories to retrieve.
String	historyItemTypeAsString()	The type of alarm histories to retrieve.
Integer	maxRecords()	The maximum number of alarm history records to retrieve.
String	nextToken()	The token returned by a previous call to indicate that there is more data available.
ScanBy	scanBy()	Specified whether to return the newest or oldest alarm history first.
String	scanByAsString()	Specified whether to return the newest or oldest alarm history first.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAlarmHistoryRequest.Builder>	serializableBuilderClass()
Instant	startDate()	The starting date to retrieve alarm history.
DescribeAlarmHistoryRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

alarmName

public final String alarmName()

The name of the alarm.

Returns:

The name of the alarm.

alarmTypes

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlarmTypes() method.

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.

hasAlarmTypes

public final boolean hasAlarmTypes()

For responses, this returns true if the service returned a value for the AlarmTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

alarmTypesAsStrings

public final List<String> alarmTypesAsStrings()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlarmTypes() method.

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.

historyItemType

public final HistoryItemType historyItemType()

The type of alarm histories to retrieve.

If the service returns an enum value that is not available in the current SDK version, historyItemType will return HistoryItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from historyItemTypeAsString().

Returns:

The type of alarm histories to retrieve.

See Also:

HistoryItemType

historyItemTypeAsString

public final String historyItemTypeAsString()

The type of alarm histories to retrieve.

If the service returns an enum value that is not available in the current SDK version, historyItemType will return HistoryItemType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from historyItemTypeAsString().

Returns:

The type of alarm histories to retrieve.

See Also:

HistoryItemType

startDate

public final Instant startDate()

The starting date to retrieve alarm history.

Returns:

The starting date to retrieve alarm history.

endDate

public final Instant endDate()

The ending date to retrieve alarm history.

Returns:

The ending date to retrieve alarm history.

maxRecords

public final Integer maxRecords()

The maximum number of alarm history records to retrieve.

Returns:

The maximum number of alarm history records to retrieve.

nextToken

public final String nextToken()

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.

scanBy

public final 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.

If the service returns an enum value that is not available in the current SDK version, scanBy will return ScanBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scanByAsString().

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

scanByAsString

public final String scanByAsString()

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.

If the service returns an enum value that is not available in the current SDK version, scanBy will return ScanBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scanByAsString().

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

toBuilder

public DescribeAlarmHistoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>

Specified by:

toBuilder in class CloudWatchRequest

builder

public static DescribeAlarmHistoryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAlarmHistoryRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo