Class InsightRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic InsightRule.Builder
builder()
final String
The definition of the rule, as a JSON object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Boolean
An optional built-in rule that Amazon Web Services manages.final String
name()
The name of the rule.final String
schema()
For rules that you create, this is always{"Name": "CloudWatchLogRule", "Version": 1}
.static Class
<? extends InsightRule.Builder> final String
state()
Indicates whether the rule is enabled or disabled.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the rule.
- Returns:
- The name of the rule.
-
state
Indicates whether the rule is enabled or disabled.
- Returns:
- Indicates whether the rule is enabled or disabled.
-
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
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
An optional built-in rule that Amazon Web Services manages.
- Returns:
- An optional built-in rule that Amazon Web Services manages.
-
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 interfaceToCopyableBuilder<InsightRule.Builder,
InsightRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-