Class AnalysisRecord

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

Contains an assessment that GuardDuty derived from the data during an investigation, such as a threat assessment, a comparison against normal behavior, or a process lineage. The record contains at most one of the payload members, the one that corresponds to AnalysisType. Indicators can accompany any analysis type.

See Also:

  • Method Details

    • analysisType

      public final AnalysisType analysisType()

      The kind of analysis. The value identifies the payload member that can be set: REPUTATION, THREAT_ASSESSMENT, and RDS_THREAT_ASSESSMENT (ThreatAssessment); KUBERNETES_POLICY_VIOLATION (KubernetesPolicyViolation); S3_EXPOSURE, S3_ACTOR_CONTEXT, and S3_PEN_TEST (S3Analysis); PROCESS_LINEAGE (Processes); and TREND and BASELINE ( AccountAnalysis).

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

      Returns:
      The kind of analysis. The value identifies the payload member that can be set: REPUTATION, THREAT_ASSESSMENT, and RDS_THREAT_ASSESSMENT (ThreatAssessment); KUBERNETES_POLICY_VIOLATION (KubernetesPolicyViolation); S3_EXPOSURE, S3_ACTOR_CONTEXT, and S3_PEN_TEST ( S3Analysis); PROCESS_LINEAGE (Processes); and TREND and BASELINE (AccountAnalysis).
      See Also:

    • analysisTypeAsString

      public final String analysisTypeAsString()

      The kind of analysis. The value identifies the payload member that can be set: REPUTATION, THREAT_ASSESSMENT, and RDS_THREAT_ASSESSMENT (ThreatAssessment); KUBERNETES_POLICY_VIOLATION (KubernetesPolicyViolation); S3_EXPOSURE, S3_ACTOR_CONTEXT, and S3_PEN_TEST (S3Analysis); PROCESS_LINEAGE (Processes); and TREND and BASELINE ( AccountAnalysis).

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

      Returns:
      The kind of analysis. The value identifies the payload member that can be set: REPUTATION, THREAT_ASSESSMENT, and RDS_THREAT_ASSESSMENT (ThreatAssessment); KUBERNETES_POLICY_VIOLATION (KubernetesPolicyViolation); S3_EXPOSURE, S3_ACTOR_CONTEXT, and S3_PEN_TEST ( S3Analysis); PROCESS_LINEAGE (Processes); and TREND and BASELINE (AccountAnalysis).
      See Also:

    • threatAssessment

      public final InvestigationThreatAssessment threatAssessment()

      A threat assessment. Set when AnalysisType is REPUTATION, THREAT_ASSESSMENT, or RDS_THREAT_ASSESSMENT.

      Returns:
      A threat assessment. Set when AnalysisType is REPUTATION, THREAT_ASSESSMENT, or RDS_THREAT_ASSESSMENT.

    • kubernetesPolicyViolation

      public final KubernetesPolicyViolation kubernetesPolicyViolation()

      An assessment of a Kubernetes policy violation. Set when AnalysisType is KUBERNETES_POLICY_VIOLATION.

      Returns:
      An assessment of a Kubernetes policy violation. Set when AnalysisType is KUBERNETES_POLICY_VIOLATION.

    • s3Analysis

      public final S3Analysis s3Analysis()

      An analysis of Amazon S3 activity or exposure. Set when AnalysisType is S3_EXPOSURE, S3_ACTOR_CONTEXT, or S3_PEN_TEST.

      Returns:
      An analysis of Amazon S3 activity or exposure. Set when AnalysisType is S3_EXPOSURE, S3_ACTOR_CONTEXT, or S3_PEN_TEST.

    • hasProcesses

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

    • processes

      public final List<Process> processes()

      The processes in a process lineage. Set when AnalysisType is PROCESS_LINEAGE.

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

      Returns:
      The processes in a process lineage. Set when AnalysisType is PROCESS_LINEAGE.

    • accountAnalysis

      public final InvestigationAccountAnalysis accountAnalysis()

      An analysis of the findings in an account over time. Set when AnalysisType is TREND or BASELINE.

      Returns:
      An analysis of the findings in an account over time. Set when AnalysisType is TREND or BASELINE.

    • hasIndicators

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

    • indicators

      public final List<InvestigationIndicator> indicators()

      The threat indicators associated with the analysis, such as an IP address, a domain, or a file hash.

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

      Returns:
      The threat indicators associated with the analysis, such as an IP address, a domain, or a file hash.

    • toBuilder

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

    • builder

      public static AnalysisRecord.Builder builder()

    • serializableBuilderClass

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