software.amazon.awssdk.services.inspector.model

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:

ToCopyableBuilder<GetAssessmentReportRequest.Builder,GetAssessmentReportRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class GetAssessmentReportRequest
extends InspectorRequest
implements ToCopyableBuilder<GetAssessmentReportRequest.Builder,GetAssessmentReportRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetAssessmentReportRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assessmentRunArn() The ARN that specifies the assessment run for which you want to generate a report.
static GetAssessmentReportRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
ReportFileFormat	reportFileFormat() Specifies the file format (html or pdf) of the assessment report that you want to generate.
String	reportFileFormatAsString() Specifies the file format (html or pdf) of the assessment report that you want to generate.
ReportType	reportType() Specifies the type of the assessment report that you want to generate.
String	reportTypeAsString() Specifies the type of the assessment report that you want to generate.
static Class<? extends GetAssessmentReportRequest.Builder>	serializableBuilderClass()
GetAssessmentReportRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

assessmentRunArn

public 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 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:

ReportFileFormat

reportFileFormatAsString

public 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:

ReportFileFormat

reportType

public 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:

ReportType

reportTypeAsString

public 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:

ReportType

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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