Class GetAssessmentReportRequest

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

  • Method Details

    • assessmentRunArn

      public final String assessmentRunArn()

      The ARN that specifies the assessment run for which you want to generate a report.

      Returns:
      The ARN that specifies the assessment run for which you want to generate a report.

    • reportFileFormat

      public final ReportFileFormat reportFileFormat()

      Specifies the file format (html or pdf) of the assessment report that you want to generate.

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

      Returns:
      Specifies the file format (html or pdf) of the assessment report that you want to generate.
      See Also:

    • reportFileFormatAsString

      public final String reportFileFormatAsString()

      Specifies the file format (html or pdf) of the assessment report that you want to generate.

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

      Returns:
      Specifies the file format (html or pdf) of the assessment report that you want to generate.
      See Also:

    • reportType

      public final ReportType reportType()

      Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.

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

      Returns:
      Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.
      See Also:

    • reportTypeAsString

      public final String reportTypeAsString()

      Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.

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

      Returns:
      Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.
      See Also:

    • toBuilder

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

    • builder

      public static GetAssessmentReportRequest.Builder builder()

    • serializableBuilderClass

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