java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
    - - software.amazon.awssdk.services.cloudwatch.model.PutInsightRuleRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutInsightRuleRequest.Builder,PutInsightRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutInsightRuleRequest
extends CloudWatchRequest
implements ToCopyableBuilder<PutInsightRuleRequest.Builder,PutInsightRuleRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutInsightRuleRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Boolean`	`applyOnTransformedLogs()`	Specify `true` to have this rule evalute log events after they have been transformed by Log transformation.
`static PutInsightRuleRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`ruleDefinition()`	The definition of the rule, as a JSON object.
`String`	`ruleName()`	A unique name for the rule.
`String`	`ruleState()`	The state of the rule.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutInsightRuleRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	A list of key-value pairs to associate with the Contributor Insights rule.
`PutInsightRuleRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - ruleName
```
public final String ruleName()
```
    A unique name for the rule.
    
    Returns:
    
    A unique name for the rule.
  - ruleState
```
public final String ruleState()
```
    The state of the rule. Valid values are ENABLED and DISABLED.
    
    Returns:
    
    The state of the rule. Valid values are ENABLED and DISABLED.
  - ruleDefinition
```
public final String ruleDefinition()
```
    The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
    
    Returns:
    
    The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
    
    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
    
    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.
    
    If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
    
    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 hasTags() method.
    
    Returns:
    
    A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule.
    
    Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values.
    
    To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission.
    
    If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this parameter are ignored. To change the tags of an existing rule, use TagResource.
  - applyOnTransformedLogs
```
public final Boolean applyOnTransformedLogs()
```
    Specify true to have this rule evalute log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.
    
    The default is false
    
    If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.
    
    Returns:
    
    Specify true to have this rule evalute log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don't have transformers will still have their original log events evaluated by Contributor Insights.
    
    The default is false
    
    If a log group has a transformer, and transformation fails for some log events, those log events won't be evaluated by Contributor Insights. For information about investigating log transformation failures, see Transformation metrics and errors.
  - toBuilder
```
public PutInsightRuleRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutInsightRuleRequest.Builder,PutInsightRuleRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchRequest
  - builder
```
public static PutInsightRuleRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutInsightRuleRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - 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

Class PutInsightRuleRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

ruleName

ruleState

ruleDefinition

hasTags

tags

applyOnTransformedLogs

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField