Package software.amazon.awssdk.services.cloudwatchlogs.model

Class AnomalyDetector

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

Contains information about one anomaly detector in the account.

See Also:

  • Method Details

    • anomalyDetectorArn

      public final String anomalyDetectorArn()

      The ARN of the anomaly detector.

      Returns:
      The ARN of the anomaly detector.

    • detectorName

      public final String detectorName()

      The name of the anomaly detector.

      Returns:
      The name of the anomaly detector.

    • hasLogGroupArnList

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

    • logGroupArnList

      public final List<String> logGroupArnList()

      A list of the ARNs of the log groups that this anomaly detector watches.

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

      Returns:
      A list of the ARNs of the log groups that this anomaly detector watches.

    • evaluationFrequency

      public final EvaluationFrequency evaluationFrequency()

      Specifies how often the anomaly detector runs and look for anomalies.

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

      Returns:
      Specifies how often the anomaly detector runs and look for anomalies.
      See Also:

    • evaluationFrequencyAsString

      public final String evaluationFrequencyAsString()

      Specifies how often the anomaly detector runs and look for anomalies.

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

      Returns:
      Specifies how often the anomaly detector runs and look for anomalies.
      See Also:

    • filterPattern

      public final String filterPattern()
      Returns the value of the FilterPattern property for this object.
      Returns:
      The value of the FilterPattern property for this object.

    • anomalyDetectorStatus

      public final AnomalyDetectorStatus anomalyDetectorStatus()

      Specifies the current status of the anomaly detector. To pause an anomaly detector, use the enabled parameter in the UpdateLogAnomalyDetector operation.

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

      Returns:
      Specifies the current status of the anomaly detector. To pause an anomaly detector, use the enabled parameter in the UpdateLogAnomalyDetector operation.
      See Also:

    • anomalyDetectorStatusAsString

      public final String anomalyDetectorStatusAsString()

      Specifies the current status of the anomaly detector. To pause an anomaly detector, use the enabled parameter in the UpdateLogAnomalyDetector operation.

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

      Returns:
      Specifies the current status of the anomaly detector. To pause an anomaly detector, use the enabled parameter in the UpdateLogAnomalyDetector operation.
      See Also:

    • kmsKeyId

      public final String kmsKeyId()

      The ID of the KMS key assigned to this anomaly detector, if any.

      Returns:
      The ID of the KMS key assigned to this anomaly detector, if any.

    • creationTimeStamp

      public final Long creationTimeStamp()

      The date and time when this anomaly detector was created.

      Returns:
      The date and time when this anomaly detector was created.

    • lastModifiedTimeStamp

      public final Long lastModifiedTimeStamp()

      The date and time when this anomaly detector was most recently modified.

      Returns:
      The date and time when this anomaly detector was most recently modified.

    • anomalyVisibilityTime

      public final Long anomalyVisibilityTime()

      The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

      Returns:
      The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined and the anomaly detector model will treat new occurrences of similar event as normal.

    • toBuilder

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

    • builder

      public static AnomalyDetector.Builder builder()

    • serializableBuilderClass

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