Class GetLogAnomalyDetectorResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsResponse
software.amazon.awssdk.services.cloudwatchlogs.model.GetLogAnomalyDetectorResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetLogAnomalyDetectorResponse.Builder,GetLogAnomalyDetectorResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetLogAnomalyDetectorResponse extends CloudWatchLogsResponse implements ToCopyableBuilder<GetLogAnomalyDetectorResponse.Builder,GetLogAnomalyDetectorResponse>

  • Method Details

    • detectorName

      public final String detectorName()

      The name of the log anomaly detector

      Returns:
      The name of the log 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()

      An array of structures, where each structure contains the ARN of a log group associated with this anomaly detector.

      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:
      An array of structures, where each structure contains the ARN of a log group associated with this anomaly detector.

    • evaluationFrequency

      public final EvaluationFrequency evaluationFrequency()

      Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.

      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. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.
      See Also:

    • evaluationFrequencyAsString

      public final String evaluationFrequencyAsString()

      Specifies how often the anomaly detector runs and look for anomalies. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.

      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. Set this value according to the frequency that the log group receives new logs. For example, if the log group receives new log events every 10 minutes, then setting evaluationFrequency to FIFTEEN_MIN might be appropriate.
      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 whether the anomaly detector is currently active. To change its status, 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 whether the anomaly detector is currently active. To change its status, use the enabled parameter in the UpdateLogAnomalyDetector operation.
      See Also:

    • anomalyDetectorStatusAsString

      public final String anomalyDetectorStatusAsString()

      Specifies whether the anomaly detector is currently active. To change its status, 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 whether the anomaly detector is currently active. To change its status, use the enabled parameter in the UpdateLogAnomalyDetector operation.
      See Also:

    • kmsKeyId

      public final String kmsKeyId()

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

      Returns:
      The ARN 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 GetLogAnomalyDetectorResponse.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<GetLogAnomalyDetectorResponse.Builder,GetLogAnomalyDetectorResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetLogAnomalyDetectorResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetLogAnomalyDetectorResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

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