InsightRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatch.model.InsightRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InsightRule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InsightRule()

Constructors
Constructor and Description
`InsightRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InsightRule`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getApplyOnTransformedLogs()` Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled.
`String`	`getDefinition()` The definition of the rule, as a JSON object.
`Boolean`	`getManagedRule()` An optional built-in rule that Amazon Web Services manages.
`String`	`getName()` The name of the rule.
`String`	`getSchema()` For rules that you create, this is always `{"Name": "CloudWatchLogRule", "Version": 1}`.
`String`	`getState()` Indicates whether the rule is enabled or disabled.
`int`	`hashCode()`
`Boolean`	`isApplyOnTransformedLogs()` Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled.
`Boolean`	`isManagedRule()` An optional built-in rule that Amazon Web Services manages.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplyOnTransformedLogs(Boolean applyOnTransformedLogs)` Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled.
`void`	`setDefinition(String definition)` The definition of the rule, as a JSON object.
`void`	`setManagedRule(Boolean managedRule)` An optional built-in rule that Amazon Web Services manages.
`void`	`setName(String name)` The name of the rule.
`void`	`setSchema(String schema)` For rules that you create, this is always `{"Name": "CloudWatchLogRule", "Version": 1}`.
`void`	`setState(String state)` Indicates whether the rule is enabled or disabled.
`String`	`toString()` Returns a string representation of this object.
`InsightRule`	`withApplyOnTransformedLogs(Boolean applyOnTransformedLogs)` Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled.
`InsightRule`	`withDefinition(String definition)` The definition of the rule, as a JSON object.
`InsightRule`	`withManagedRule(Boolean managedRule)` An optional built-in rule that Amazon Web Services manages.
`InsightRule`	`withName(String name)` The name of the rule.
`InsightRule`	`withSchema(String schema)` For rules that you create, this is always `{"Name": "CloudWatchLogRule", "Version": 1}`.
`InsightRule`	`withState(String state)` Indicates whether the rule is enabled or disabled.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InsightRule
```
public InsightRule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
  - getName
```
public String getName()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - withName
```
public InsightRule withName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    Indicates whether the rule is enabled or disabled.
    
    Parameters:
    
    state - Indicates whether the rule is enabled or disabled.
  - getState
```
public String getState()
```
    Indicates whether the rule is enabled or disabled.
    
    Returns:
    
    Indicates whether the rule is enabled or disabled.
  - withState
```
public InsightRule withState(String state)
```
    Indicates whether the rule is enabled or disabled.
    
    Parameters:
    
    state - Indicates whether the rule is enabled or disabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSchema
```
public void setSchema(String schema)
```
    For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
    
    Parameters:
    
    schema - For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
  - getSchema
```
public String getSchema()
```
    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}
  - withSchema
```
public InsightRule withSchema(String schema)
```
    For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
    
    Parameters:
    
    schema - For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(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.
    
    Parameters:
    
    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.
  - getDefinition
```
public String getDefinition()
```
    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.
  - withDefinition
```
public InsightRule withDefinition(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setManagedRule
```
public void setManagedRule(Boolean managedRule)
```
    An optional built-in rule that Amazon Web Services manages.
    
    Parameters:
    
    managedRule - An optional built-in rule that Amazon Web Services manages.
  - getManagedRule
```
public Boolean getManagedRule()
```
    An optional built-in rule that Amazon Web Services manages.
    
    Returns:
    
    An optional built-in rule that Amazon Web Services manages.
  - withManagedRule
```
public InsightRule withManagedRule(Boolean managedRule)
```
    An optional built-in rule that Amazon Web Services manages.
    
    Parameters:
    
    managedRule - An optional built-in rule that Amazon Web Services manages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isManagedRule
```
public Boolean isManagedRule()
```
    An optional built-in rule that Amazon Web Services manages.
    
    Returns:
    
    An optional built-in rule that Amazon Web Services manages.
  - setApplyOnTransformedLogs
```
public void setApplyOnTransformedLogs(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.
    
    Parameters:
    
    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.
  - getApplyOnTransformedLogs
```
public Boolean getApplyOnTransformedLogs()
```
    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.
  - withApplyOnTransformedLogs
```
public InsightRule withApplyOnTransformedLogs(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isApplyOnTransformedLogs
```
public Boolean isApplyOnTransformedLogs()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public InsightRule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.797

Class InsightRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InsightRule

Method Detail

setName

getName

withName

setState

getState

withState

setSchema

getSchema

withSchema

setDefinition

getDefinition

withDefinition

setManagedRule

getManagedRule

withManagedRule

isManagedRule

setApplyOnTransformedLogs

getApplyOnTransformedLogs

withApplyOnTransformedLogs

isApplyOnTransformedLogs

toString

equals

hashCode

clone

marshall