Class LogAlarm

java.lang.Object
software.amazon.awssdk.services.cloudwatch.model.LogAlarm
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LogAlarm.Builder,LogAlarm>
@Generated("software.amazon.awssdk:codegen") public final class LogAlarm extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LogAlarm.Builder,LogAlarm>

The details about a log alarm.

See Also:

  • Method Details

    • alarmName

      public final String alarmName()

      The name of the alarm.

      Returns:
      The name of the alarm.

    • alarmArn

      public final String alarmArn()

      The Amazon Resource Name (ARN) of the alarm.

      Returns:
      The Amazon Resource Name (ARN) of the alarm.

    • alarmDescription

      public final String alarmDescription()

      The description of the alarm.

      Returns:
      The description of the alarm.

    • alarmConfigurationUpdatedTimestamp

      public final Instant alarmConfigurationUpdatedTimestamp()

      The time stamp of the last update to the alarm configuration.

      Returns:
      The time stamp of the last update to the alarm configuration.

    • actionsEnabled

      public final Boolean actionsEnabled()

      Indicates whether actions should be executed during any changes to the alarm state.

      Returns:
      Indicates whether actions should be executed during any changes to the alarm state.

    • hasOkActions

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

    • okActions

      public final List<String> okActions()

      The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

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

      Returns:
      The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

    • hasAlarmActions

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

    • alarmActions

      public final List<String> alarmActions()

      The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

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

      Returns:
      The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

    • hasInsufficientDataActions

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

    • insufficientDataActions

      public final List<String> insufficientDataActions()

      The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

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

      Returns:
      The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

    • stateValue

      public final StateValue stateValue()

      The state value for the alarm.

      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:
      The state value for the alarm.
      See Also:

    • stateValueAsString

      public final String stateValueAsString()

      The state value for the alarm.

      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:
      The state value for the alarm.
      See Also:

    • stateReason

      public final String stateReason()

      An explanation for the alarm state, in text format.

      Returns:
      An explanation for the alarm state, in text format.

    • stateReasonData

      public final String stateReasonData()

      An explanation for the alarm state, in JSON format.

      Returns:
      An explanation for the alarm state, in JSON format.

    • stateUpdatedTimestamp

      public final Instant stateUpdatedTimestamp()

      The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

      Returns:
      The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.

    • scheduledQueryConfiguration

      public final ScheduledQueryConfiguration scheduledQueryConfiguration()

      The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

      Returns:
      The configuration of the underlying CloudWatch Logs scheduled query, including the query string, log groups, schedule, aggregation expression, and the ARN of the managed scheduled query.

    • queryResultsToEvaluate

      public final Integer queryResultsToEvaluate()

      The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

      Returns:
      The number of most recent scheduled query results that the alarm evaluates against the threshold (the N in M-of-N evaluation).

    • queryResultsToAlarm

      public final Integer queryResultsToAlarm()

      The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

      Returns:
      The number of query results, out of the most recent QueryResultsToEvaluate results, that must breach the threshold to trigger the alarm to transition to ALARM (the M in M-of-N evaluation).

    • threshold

      public final Double threshold()

      The value to compare with the aggregated query result.

      Returns:
      The value to compare with the aggregated query result.

    • comparisonOperator

      public final ComparisonOperator comparisonOperator()

      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.

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

      Returns:
      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.
      See Also:

    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()

      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.

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

      Returns:
      The arithmetic operation to use when comparing the aggregated query result and the threshold. The aggregated query result is used as the first operand.
      See Also:

    • treatMissingData

      public final String treatMissingData()

      How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.

      Returns:
      How this alarm handles missing data points. Valid values are breaching, notBreaching, ignore, and missing.

    • stateTransitionedTimestamp

      public final Instant stateTransitionedTimestamp()

      The date and time that the alarm's StateValue most recently changed.

      Returns:
      The date and time that the alarm's StateValue most recently changed.

    • evaluationState

      public final EvaluationState evaluationState()

      If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

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

      Returns:
      If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

      See Also:

    • evaluationStateAsString

      public final String evaluationStateAsString()

      If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

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

      Returns:
      If the value of this field is EVALUATION_ERROR, it indicates configuration errors in the alarm setup that require review and correction. Refer to the StateReason field of the alarm for more details.

      If the value of this field is EVALUATION_FAILURE, it indicates temporary CloudWatch issues. We recommend manual monitoring until the issue is resolved.

      If the value of this field is PARTIAL_DATA, it indicates that the query returned the maximum 500 contributor groups but more matched. The alarm evaluates the available contributors, but results might be incomplete.

      See Also:

    • actionLogLineCount

      public final Integer actionLogLineCount()

      The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.

      Returns:
      The number of log lines from the most recent scheduled query execution that are included in alarm action notifications. Valid range is 0 through 50. A value of 0 means no log lines are included.

    • actionLogLineRoleArn

      public final String actionLogLineRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to retrieve log events for inclusion in alarm action notifications. Set when ActionLogLineCount is greater than 0.

    • toBuilder

      public LogAlarm.Builder 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<LogAlarm.Builder,LogAlarm>
      Returns:
      a builder for type T

    • builder

      public static LogAlarm.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LogAlarm.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)
      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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.