Class GetInvestigationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.detective.model.DetectiveResponse
software.amazon.awssdk.services.detective.model.GetInvestigationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetInvestigationResponse.Builder,GetInvestigationResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetInvestigationResponse extends DetectiveResponse implements ToCopyableBuilder<GetInvestigationResponse.Builder,GetInvestigationResponse>

  • Method Details

    • graphArn

      public final String graphArn()

      The Amazon Resource Name (ARN) of the behavior graph.

      Returns:
      The Amazon Resource Name (ARN) of the behavior graph.

    • investigationId

      public final String investigationId()

      The investigation ID of the investigation report.

      Returns:
      The investigation ID of the investigation report.

    • entityArn

      public final String entityArn()

      The unique Amazon Resource Name (ARN). Detective supports IAM user ARNs and IAM role ARNs.

      Returns:
      The unique Amazon Resource Name (ARN). Detective supports IAM user ARNs and IAM role ARNs.

    • entityType

      public final EntityType entityType()

      Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.

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

      Returns:
      Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.
      See Also:

    • entityTypeAsString

      public final String entityTypeAsString()

      Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.

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

      Returns:
      Type of entity. For example, Amazon Web Services accounts, such as an IAM user and/or IAM role.
      See Also:

    • createdTime

      public final Instant createdTime()

      The creation time of the investigation report in UTC time stamp format.

      Returns:
      The creation time of the investigation report in UTC time stamp format.

    • scopeStartTime

      public final Instant scopeStartTime()

      The start date and time used to set the scope time within which you want to generate the investigation report. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      Returns:
      The start date and time used to set the scope time within which you want to generate the investigation report. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

    • scopeEndTime

      public final Instant scopeEndTime()

      The data and time when the investigation began. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

      Returns:
      The data and time when the investigation began. The value is an UTC ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.

    • status

      public final Status status()

      The status based on the completion status of the investigation.

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

      Returns:
      The status based on the completion status of the investigation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status based on the completion status of the investigation.

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

      Returns:
      The status based on the completion status of the investigation.
      See Also:

    • severity

      public final Severity severity()

      The severity assigned is based on the likelihood and impact of the indicators of compromise discovered in the investigation.

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

      Returns:
      The severity assigned is based on the likelihood and impact of the indicators of compromise discovered in the investigation.
      See Also:

    • severityAsString

      public final String severityAsString()

      The severity assigned is based on the likelihood and impact of the indicators of compromise discovered in the investigation.

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

      Returns:
      The severity assigned is based on the likelihood and impact of the indicators of compromise discovered in the investigation.
      See Also:

    • state

      public final State state()

      The current state of the investigation. An archived investigation indicates that you have completed reviewing the investigation.

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

      Returns:
      The current state of the investigation. An archived investigation indicates that you have completed reviewing the investigation.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the investigation. An archived investigation indicates that you have completed reviewing the investigation.

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

      Returns:
      The current state of the investigation. An archived investigation indicates that you have completed reviewing the investigation.
      See Also:

    • toBuilder

      public GetInvestigationResponse.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<GetInvestigationResponse.Builder,GetInvestigationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetInvestigationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetInvestigationResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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