Class CreateAssessmentReportRequest

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

  • Method Details

    • name

      public final String name()

      The name of the new assessment report.

      Returns:
      The name of the new assessment report.

    • description

      public final String description()

      The description of the assessment report.

      Returns:
      The description of the assessment report.

    • assessmentId

      public final String assessmentId()

      The identifier for the assessment.

      Returns:
      The identifier for the assessment.

    • queryStatement

      public final String queryStatement()

      A SQL statement that represents an evidence finder query.

      Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.

      To use this parameter, the enablementStatus of evidence finder must be ENABLED.

      For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide.

      Returns:
      A SQL statement that represents an evidence finder query.

      Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually added to a report using the console, or associated with a report using the API.

      To use this parameter, the enablementStatus of evidence finder must be ENABLED.

      For examples and help resolving queryStatement validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User Guide.

    • toBuilder

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

    • builder

      public static CreateAssessmentReportRequest.Builder builder()

    • serializableBuilderClass

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