java.lang.Object
- software.amazon.awssdk.services.cloudwatch.model.AlarmHistoryItem

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AlarmHistoryItem.Builder,AlarmHistoryItem>

@Generated("software.amazon.awssdk:codegen")
public final class AlarmHistoryItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlarmHistoryItem.Builder,AlarmHistoryItem>

Represents the history of a specific alarm.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AlarmHistoryItem.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`alarmContributorAttributes()`	A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.
`String`	`alarmContributorId()`	The unique identifier of the alarm contributor associated with this history item, if applicable.
`String`	`alarmName()`	The descriptive name for the alarm.
`AlarmType`	`alarmType()`	The type of alarm, either metric alarm or composite alarm.
`String`	`alarmTypeAsString()`	The type of alarm, either metric alarm or composite alarm.
`static AlarmHistoryItem.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAlarmContributorAttributes()`	For responses, this returns true if the service returned a value for the AlarmContributorAttributes property.
`int`	`hashCode()`
`String`	`historyData()`	Data about the alarm, in JSON format.
`HistoryItemType`	`historyItemType()`	The type of alarm history item.
`String`	`historyItemTypeAsString()`	The type of alarm history item.
`String`	`historySummary()`	A summary of the alarm history, in text format.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AlarmHistoryItem.Builder>`	`serializableBuilderClass()`
`Instant`	`timestamp()`	The time stamp for the alarm history item.
`AlarmHistoryItem.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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 descriptive name for the alarm.
    
    Returns:
    
    The descriptive name for the alarm.
  - alarmContributorId
```
public final String alarmContributorId()
```
    The unique identifier of the alarm contributor associated with this history item, if applicable.
    
    Returns:
    
    The unique identifier of the alarm contributor associated with this history item, if applicable.
  - alarmType
```
public final AlarmType alarmType()
```
    The type of alarm, either metric alarm or composite alarm.
    
    If the service returns an enum value that is not available in the current SDK version, alarmType will return AlarmType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alarmTypeAsString().
    
    Returns:
    
    The type of alarm, either metric alarm or composite alarm.
    
    See Also:
    
    AlarmType
  - alarmTypeAsString
```
public final String alarmTypeAsString()
```
    The type of alarm, either metric alarm or composite alarm.
    
    If the service returns an enum value that is not available in the current SDK version, alarmType will return AlarmType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from alarmTypeAsString().
    
    Returns:
    
    The type of alarm, either metric alarm or composite alarm.
    
    See Also:
    
    AlarmType
  - timestamp
```
public final Instant timestamp()
```
    The time stamp for the alarm history item.
    
    Returns:
    
    The time stamp for the alarm history item.
  - historyItemType
```
public final HistoryItemType historyItemType()
```
    The type of alarm history item.
    
    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 history item.
    
    See Also:
    
    HistoryItemType
  - historyItemTypeAsString
```
public final String historyItemTypeAsString()
```
    The type of alarm history item.
    
    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 history item.
    
    See Also:
    
    HistoryItemType
  - historySummary
```
public final String historySummary()
```
    A summary of the alarm history, in text format.
    
    Returns:
    
    A summary of the alarm history, in text format.
  - historyData
```
public final String historyData()
```
    Data about the alarm, in JSON format.
    
    Returns:
    
    Data about the alarm, in JSON format.
  - hasAlarmContributorAttributes
```
public final boolean hasAlarmContributorAttributes()
```
    For responses, this returns true if the service returned a value for the AlarmContributorAttributes 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.
  - alarmContributorAttributes
```
public final Map<String,String> alarmContributorAttributes()
```
    A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.
    
    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 hasAlarmContributorAttributes() method.
    
    Returns:
    
    A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.
  - toBuilder
```
public AlarmHistoryItem.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AlarmHistoryItem.Builder,AlarmHistoryItem>
  - builder
```
public static AlarmHistoryItem.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AlarmHistoryItem.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AlarmHistoryItem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

alarmName

alarmContributorId

alarmType

alarmTypeAsString

timestamp

historyItemType

historyItemTypeAsString

historySummary

historyData

hasAlarmContributorAttributes

alarmContributorAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField