Class 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>
  • Method Details

    • 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:
    • 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:
    • 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:
    • 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:
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeAlarmHistoryRequest.Builder,DescribeAlarmHistoryRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T
    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.