Class CountermeasureAction

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

Contains an action that you can take to respond to a threat.

See Also:

  • Method Details

    • title

      public final String title()

      A short title for the action.

      Returns:
      A short title for the action.

    • description

      public final String description()

      A description of the action.

      Returns:
      A description of the action.

    • priority

      public final ActionPriority priority()

      The priority of the action. Possible values are IMMEDIATE, SHORT_TERM, and STRATEGIC.

      If the service returns an enum value that is not available in the current SDK version, priority will return ActionPriority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priorityAsString().

      Returns:
      The priority of the action. Possible values are IMMEDIATE, SHORT_TERM, and STRATEGIC.
      See Also:

    • priorityAsString

      public final String priorityAsString()

      The priority of the action. Possible values are IMMEDIATE, SHORT_TERM, and STRATEGIC.

      If the service returns an enum value that is not available in the current SDK version, priority will return ActionPriority.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from priorityAsString().

      Returns:
      The priority of the action. Possible values are IMMEDIATE, SHORT_TERM, and STRATEGIC.
      See Also:

    • defenseTechnique

      public final String defenseTechnique()

      The defensive technique that the action applies.

      Returns:
      The defensive technique that the action applies.

    • hasMitigates

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

    • mitigates

      public final List<String> mitigates()

      The MITRE ATT&CK technique IDs that the action mitigates, such as T1059.004.

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

      Returns:
      The MITRE ATT&CK technique IDs that the action mitigates, such as T1059.004.

    • hasCliCommands

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

    • cliCommands

      public final List<String> cliCommands()

      CLI commands that you can run to carry out the action.

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

      Returns:
      CLI commands that you can run to carry out the action.

    • dispositionId

      public final Integer dispositionId()

      The numeric identifier of the action's disposition.

      Returns:
      The numeric identifier of the action's disposition.

    • disposition

      public final Disposition disposition()

      The outcome of the action. Possible values are Isolated, Blocked, Deleted, Access Revoked, and Logged.

      If the service returns an enum value that is not available in the current SDK version, disposition will return Disposition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dispositionAsString().

      Returns:
      The outcome of the action. Possible values are Isolated, Blocked, Deleted, Access Revoked, and Logged.
      See Also:

    • dispositionAsString

      public final String dispositionAsString()

      The outcome of the action. Possible values are Isolated, Blocked, Deleted, Access Revoked, and Logged.

      If the service returns an enum value that is not available in the current SDK version, disposition will return Disposition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dispositionAsString().

      Returns:
      The outcome of the action. Possible values are Isolated, Blocked, Deleted, Access Revoked, and Logged.
      See Also:

    • hasAffectedResources

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

    • affectedResources

      public final List<AffectedResource> affectedResources()

      The resources that the action applies to.

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

      Returns:
      The resources that the action applies to.

    • toBuilder

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

    • builder

      public static CountermeasureAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CountermeasureAction.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.