@Generated(value="software.amazon.awssdk:codegen") public final class DescribeAlarmHistoryRequest extends CloudWatchRequest implements ToCopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeAlarmHistoryRequest.Builder |
Modifier and Type | Method and 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.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String alarmName()
The name of the alarm.
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.
public final boolean hasAlarmTypes()
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.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.
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()
.
HistoryItemType
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()
.
HistoryItemType
public final Instant startDate()
The starting date to retrieve alarm history.
public final Instant endDate()
The ending date to retrieve alarm history.
public final Integer maxRecords()
The maximum number of alarm history records to retrieve.
public final String nextToken()
The token returned by a previous call to indicate that there is more data available.
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()
.
TimestampDescending
to have the newest event history returned first, and specify
TimestampAscending
to have the oldest history returned first.ScanBy
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()
.
TimestampDescending
to have the newest event history returned first, and specify
TimestampAscending
to have the oldest history returned first.ScanBy
public DescribeAlarmHistoryRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>
toBuilder
in class CloudWatchRequest
public static DescribeAlarmHistoryRequest.Builder builder()
public static Class<? extends DescribeAlarmHistoryRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2021. All rights reserved.