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

Class DescribeAlarmsRequest

    • Method Detail

      • hasAlarmNames

        public final boolean hasAlarmNames()
        For responses, this returns true if the service returned a value for the AlarmNames 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.

      • alarmNames

        public final List<String> alarmNames()

        The names of the alarms to retrieve information about.

        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 hasAlarmNames() method.

        Returns:
        The names of the alarms to retrieve information about.

      • alarmNamePrefix

        public final String alarmNamePrefix()

        An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

        If this parameter is specified, you cannot specify AlarmNames.

        Returns:
        An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.

        If this parameter is specified, you cannot specify AlarmNames.

      • 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, even if composite alarms exist in the account.

        For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

        If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

        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, even if composite alarms exist in the account.

        For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

        If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

      • 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, even if composite alarms exist in the account.

        For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

        If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

        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, even if composite alarms exist in the account.

        For example, if you omit this parameter or specify MetricAlarms, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.

        If you specify CompositeAlarms, the operation returns only a list of composite alarms, and does not return any metric alarms.

      • childrenOfAlarmName

        public final String childrenOfAlarmName()

        If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.

        If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

        Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

        Returns:
        If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned.

        If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

        Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

      • parentsOfAlarmName

        public final String parentsOfAlarmName()

        If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned.

        If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

        Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

        Returns:
        If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned.

        If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error.

        Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.

      • stateValue

        public final StateValue stateValue()

        Specify this parameter to receive information only about alarms that are currently in the state that you specify.

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

        Returns:
        Specify this parameter to receive information only about alarms that are currently in the state that you specify.
        See Also:
        StateValue

      • stateValueAsString

        public final String stateValueAsString()

        Specify this parameter to receive information only about alarms that are currently in the state that you specify.

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

        Returns:
        Specify this parameter to receive information only about alarms that are currently in the state that you specify.
        See Also:
        StateValue

      • actionPrefix

        public final String actionPrefix()

        Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

        Returns:
        Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.

      • maxRecords

        public final Integer maxRecords()

        The maximum number of alarm descriptions to retrieve.

        Returns:
        The maximum number of alarm descriptions 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.

      • 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