Class InsightRule

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

This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the rule.

      Returns:
      The name of the rule.

    • state

      public final String state()

      Indicates whether the rule is enabled or disabled.

      Returns:
      Indicates whether the rule is enabled or disabled.

    • schema

      public final String schema()

      For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

      Returns:
      For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}

    • definition

      public final String definition()

      The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.

      Returns:
      The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.

    • managedRule

      public final Boolean managedRule()

      An optional built-in rule that Amazon Web Services manages.

      Returns:
      An optional built-in rule that Amazon Web Services manages.

    • applyOnTransformedLogs

      public final Boolean applyOnTransformedLogs()

      Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.

      Returns:
      Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.

    • toBuilder

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

    • builder

      public static InsightRule.Builder builder()

    • serializableBuilderClass

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