Class UpdateAutomationRulesRequestItem

java.lang.Object
software.amazon.awssdk.services.securityhub.model.UpdateAutomationRulesRequestItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UpdateAutomationRulesRequestItem.Builder,UpdateAutomationRulesRequestItem>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAutomationRulesRequestItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UpdateAutomationRulesRequestItem.Builder,UpdateAutomationRulesRequestItem>

Specifies the parameters to update in an existing automation rule.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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.

    • description

      public final String description()

      A description of the rule.

      Returns:
      A description of the rule.

    • ruleName

      public final String ruleName()

      The name of the rule.

      Returns:
      The name 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.

    • criteria

      public final AutomationRulesFindingFilters criteria()

      A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.

      Returns:
      A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.

    • hasActions

      public final boolean hasActions()
      For responses, this returns true if the service returned a value for the Actions 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.

    • actions

      public final List<AutomationRulesAction> actions()

      One or more actions to update finding fields if a finding matches the conditions specified in Criteria.

      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 hasActions() method.

      Returns:
      One or more actions to update finding fields if a finding matches the conditions specified in Criteria.

    • toBuilder

      public UpdateAutomationRulesRequestItem.Builder 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 interface ToCopyableBuilder<UpdateAutomationRulesRequestItem.Builder,UpdateAutomationRulesRequestItem>
      Returns:
      a builder for type T

    • builder

      public static UpdateAutomationRulesRequestItem.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateAutomationRulesRequestItem.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.