Class InvestigationAction

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

Represents an investigation action performed within a case. This structure captures the details of an automated or manual investigation, including its status, results, and user feedback.

See Also:

  • Method Details

    • investigationId

      public final String investigationId()

      The unique identifier for this investigation action. This ID is used to track and reference the specific investigation throughout its lifecycle.

      Returns:
      The unique identifier for this investigation action. This ID is used to track and reference the specific investigation throughout its lifecycle.

    • actionType

      public final ActionType actionType()

      The type of investigation action being performed. This categorizes the investigation method or approach used in the case.

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

      Returns:
      The type of investigation action being performed. This categorizes the investigation method or approach used in the case.
      See Also:

    • actionTypeAsString

      public final String actionTypeAsString()

      The type of investigation action being performed. This categorizes the investigation method or approach used in the case.

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

      Returns:
      The type of investigation action being performed. This categorizes the investigation method or approach used in the case.
      See Also:

    • title

      public final String title()

      Human-readable summary of the investigation focus. This provides a brief description of what the investigation is examining or analyzing.

      Returns:
      Human-readable summary of the investigation focus. This provides a brief description of what the investigation is examining or analyzing.

    • content

      public final String content()

      Detailed investigation results in rich markdown format. This field contains the comprehensive findings, analysis, and conclusions from the investigation.

      Returns:
      Detailed investigation results in rich markdown format. This field contains the comprehensive findings, analysis, and conclusions from the investigation.

    • status

      public final ExecutionStatus status()

      The current execution status of the investigation. This indicates whether the investigation is pending, in progress, completed, or failed.

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

      Returns:
      The current execution status of the investigation. This indicates whether the investigation is pending, in progress, completed, or failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current execution status of the investigation. This indicates whether the investigation is pending, in progress, completed, or failed.

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

      Returns:
      The current execution status of the investigation. This indicates whether the investigation is pending, in progress, completed, or failed.
      See Also:

    • lastUpdated

      public final Instant lastUpdated()

      ISO 8601 timestamp of the most recent status update. This indicates when the investigation was last modified or when its status last changed.

      Returns:
      ISO 8601 timestamp of the most recent status update. This indicates when the investigation was last modified or when its status last changed.

    • feedback

      public final InvestigationFeedback feedback()

      User feedback for this investigation result. This contains the user's assessment and comments about the quality and usefulness of the investigation findings.

      Returns:
      User feedback for this investigation result. This contains the user's assessment and comments about the quality and usefulness of the investigation findings.

    • toBuilder

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

    • builder

      public static InvestigationAction.Builder builder()

    • serializableBuilderClass

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