Class InvestigationSummary

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

Contains summary information about a GuardDuty investigation.

See Also:

  • Method Details

    • investigationId

      public final String investigationId()

      The unique identifier of the investigation.

      Returns:
      The unique identifier of the investigation.

    • status

      public final InvestigationStatus status()

      The current status of the investigation.

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

      Returns:
      The current status of the investigation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the investigation.

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

      Returns:
      The current status of the investigation.
      See Also:

    • triggerPrompt

      public final String triggerPrompt()

      The natural-language prompt that initiated this investigation.

      Returns:
      The natural-language prompt that initiated this investigation.

    • riskLevel

      public final RiskLevel riskLevel()

      The assessed risk level of the investigated threat.

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

      Returns:
      The assessed risk level of the investigated threat.
      See Also:

    • riskLevelAsString

      public final String riskLevelAsString()

      The assessed risk level of the investigated threat.

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

      Returns:
      The assessed risk level of the investigated threat.
      See Also:

    • confidence

      public final Confidence confidence()

      The confidence level of the investigation's assessment.

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

      Returns:
      The confidence level of the investigation's assessment.
      See Also:

    • confidenceAsString

      public final String confidenceAsString()

      The confidence level of the investigation's assessment.

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

      Returns:
      The confidence level of the investigation's assessment.
      See Also:

    • title

      public final String title()

      A short title summarizing the investigation.

      Returns:
      A short title summarizing the investigation.

    • accountId

      public final String accountId()

      The Amazon Web Services account ID associated with the investigation.

      Returns:
      The Amazon Web Services account ID associated with the investigation.

    • startTime

      public final Instant startTime()

      The timestamp at which the investigation started.

      Returns:
      The timestamp at which the investigation started.

    • endTime

      public final Instant endTime()

      The timestamp at which the investigation completed.

      Returns:
      The timestamp at which the investigation completed.

    • toBuilder

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

    • builder

      public static InvestigationSummary.Builder builder()

    • serializableBuilderClass

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