Package software.amazon.awssdk.services.auditmanager.model

Class AssessmentReport

java.lang.Object

software.amazon.awssdk.services.auditmanager.model.AssessmentReport

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AssessmentReport.Builder,AssessmentReport>

@Generated("software.amazon.awssdk:codegen")
public final class AssessmentReport
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AssessmentReport.Builder,AssessmentReport>

A finalized document that's generated from an Audit Manager assessment. These reports summarize the relevant evidence that was collected for your audit, and link to the relevant evidence folders. These evidence folders are named and organized according to the controls that are specified in your assessment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssessmentReport.Builder

Method Summary

Modifier and Type	Method	Description
String	assessmentId()	The identifier for the specified assessment.
String	assessmentName()	The name of the associated assessment.
String	author()	The name of the user who created the assessment report.
String	awsAccountId()	The identifier for the specified Amazon Web Services account.
static AssessmentReport.Builder	builder()
Instant	creationTime()	Specifies when the assessment report was created.
String	description()	The description of the specified assessment report.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier for the assessment report.
String	name()	The name that's given to the assessment report.
List<SdkField<?>>	sdkFields()
static Class<? extends AssessmentReport.Builder>	serializableBuilderClass()
AssessmentReportStatus	status()	The current status of the specified assessment report.
String	statusAsString()	The current status of the specified assessment report.
AssessmentReport.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The unique identifier for the assessment report.

Returns:

The unique identifier for the assessment report.

name

public final String name()

The name that's given to the assessment report.

Returns:

The name that's given to the assessment report.

description

public final String description()

The description of the specified assessment report.

Returns:

The description of the specified assessment report.

awsAccountId

public final String awsAccountId()

The identifier for the specified Amazon Web Services account.

Returns:

The identifier for the specified Amazon Web Services account.

assessmentId

public final String assessmentId()

The identifier for the specified assessment.

Returns:

The identifier for the specified assessment.

assessmentName

public final String assessmentName()

The name of the associated assessment.

Returns:

The name of the associated assessment.

author

public final String author()

The name of the user who created the assessment report.

Returns:

The name of the user who created the assessment report.

status

public final AssessmentReportStatus status()

The current status of the specified assessment report.

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

Returns:

The current status of the specified assessment report.

See Also:

AssessmentReportStatus

statusAsString

public final String statusAsString()

The current status of the specified assessment report.

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

Returns:

The current status of the specified assessment report.

See Also:

AssessmentReportStatus

creationTime

public final Instant creationTime()

Specifies when the assessment report was created.

Returns:

Specifies when the assessment report was created.

toBuilder

public AssessmentReport.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssessmentReport.Builder,AssessmentReport>

builder

public static AssessmentReport.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo