java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AutomationRulesMetadata

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutomationRulesMetadata.Builder,AutomationRulesMetadata>
```
@Generated("software.amazon.awssdk:codegen")
public final class AutomationRulesMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutomationRulesMetadata.Builder,AutomationRulesMetadata>
```
Metadata for automation rules in the calling account. The response includes rules with a RuleStatus of ENABLED and DISABLED.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AutomationRulesMetadata.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AutomationRulesMetadata.Builder`	`builder()`
`Instant`	`createdAt()`	A timestamp that indicates when the rule was created.
`String`	`createdBy()`	The principal that created a rule.
`String`	`description()`	A description of the rule.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`isTerminal()`	Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria.
`String`	`ruleArn()`	The Amazon Resource Name (ARN) for the rule.
`String`	`ruleName()`	The name of the rule.
`Integer`	`ruleOrder()`	An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
`RuleStatus`	`ruleStatus()`	Whether the rule is active after it is created.
`String`	`ruleStatusAsString()`	Whether the rule is active after it is created.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutomationRulesMetadata.Builder>`	`serializableBuilderClass()`
`AutomationRulesMetadata.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`updatedAt()`	A timestamp that indicates when the rule was most recently updated.

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
  - ruleArn
```
public final String ruleArn()
```
    The Amazon Resource Name (ARN) for the rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the rule.
  - ruleStatus
```
public final RuleStatus ruleStatus()
```
    Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
    
    If the service returns an enum value that is not available in the current SDK version, ruleStatus will return RuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleStatusAsString().
    
    Returns:
    
    Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
    
    See Also:
    
    RuleStatus
  - ruleStatusAsString
```
public final String ruleStatusAsString()
```
    Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
    
    If the service returns an enum value that is not available in the current SDK version, ruleStatus will return RuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleStatusAsString().
    
    Returns:
    
    Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
    
    See Also:
    
    RuleStatus
  - ruleOrder
```
public final Integer ruleOrder()
```
    An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
    
    Returns:
    
    An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
  - ruleName
```
public final String ruleName()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - description
```
public final String description()
```
    A description of the rule.
    
    Returns:
    
    A description of the rule.
  - isTerminal
```
public final Boolean isTerminal()
```
    Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
    
    Returns:
    
    Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
  - createdAt
```
public final Instant createdAt()
```
    A timestamp that indicates when the rule was created.
    
    For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
    
    Returns:
    
    A timestamp that indicates when the rule was created.
    
    For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
  - updatedAt
```
public final Instant updatedAt()
```
    A timestamp that indicates when the rule was most recently updated.
    
    For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
    
    Returns:
    
    A timestamp that indicates when the rule was most recently updated.
    
    For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
  - createdBy
```
public final String createdBy()
```
    The principal that created a rule.
    
    Returns:
    
    The principal that created a rule.
  - toBuilder
```
public AutomationRulesMetadata.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutomationRulesMetadata.Builder,AutomationRulesMetadata>
  - builder
```
public static AutomationRulesMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutomationRulesMetadata.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

Class AutomationRulesMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

ruleArn

ruleStatus

ruleStatusAsString

ruleOrder

ruleName

description

isTerminal

createdAt

updatedAt

createdBy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField