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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InsightRule.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	applyOnTransformedLogs()	Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled.
static InsightRule.Builder	builder()
String	definition()	The definition of the rule, as a JSON object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	managedRule()	An optional built-in rule that Amazon Web Services manages.
String	name()	The name of the rule.
String	schema()	For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InsightRule.Builder>	serializableBuilderClass()
String	state()	Indicates whether the rule is enabled or disabled.
InsightRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<InsightRule.Builder,InsightRule>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo