Class CreateInvestigationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.guardduty.model.GuardDutyRequest
software.amazon.awssdk.services.guardduty.model.CreateInvestigationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateInvestigationRequest.Builder,CreateInvestigationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateInvestigationRequest extends GuardDutyRequest implements ToCopyableBuilder<CreateInvestigationRequest.Builder,CreateInvestigationRequest>

  • Method Details

    • detectorId

      public final String detectorId()

      The unique ID of the GuardDuty detector for the account in which the investigation is created.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

      Returns:
      The unique ID of the GuardDuty detector for the account in which the investigation is created.

      To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    • triggerPrompt

      public final String triggerPrompt()

      A natural-language description of what to investigate. For example:

      • "Investigate finding 1ab2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 in account 123456789012"

      • "Analyze findings in account with id 123456789012"

      • "Analyze findings in my organization"

      Returns:
      A natural-language description of what to investigate. For example:

      • "Investigate finding 1ab2c3d4e5f6a7b8c9d0e1f2a3b4c5d6 in account 123456789012"

      • "Analyze findings in account with id 123456789012"

      • "Analyze findings in my organization"

    • clientToken

      public final String clientToken()

      The idempotency token for the create request.

      Returns:
      The idempotency token for the create request.

    • toBuilder

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

    • builder

      public static CreateInvestigationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.

    • sdkFieldNameToField

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