software.amazon.awssdk.services.auditmanager.model

Class AssessmentMetadata

java.lang.Object

software.amazon.awssdk.services.auditmanager.model.AssessmentMetadata

All Implemented Interfaces:

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

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

The metadata that's associated with the specified assessment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssessmentMetadata.Builder

Method Summary

Modifier and Type	Method and Description
AssessmentReportsDestination	assessmentReportsDestination() The destination that evidence reports are stored in for the assessment.
static AssessmentMetadata.Builder	builder()
String	complianceType() The name of the compliance standard that's related to the assessment, such as PCI-DSS.
Instant	creationTime() Specifies when the assessment was created.
List<Delegation>	delegations() The delegations that are associated with the assessment.
String	description() The description of the assessment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDelegations() For responses, this returns true if the service returned a value for the Delegations property.
int	hashCode()
boolean	hasRoles() For responses, this returns true if the service returned a value for the Roles property.
String	id() The unique identifier for the assessment.
Instant	lastUpdated() The time of the most recent update.
String	name() The name of the assessment.
List<Role>	roles() The roles that are associated with the assessment.
Scope	scope() The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.
List<SdkField<?>>	sdkFields()
static Class<? extends AssessmentMetadata.Builder>	serializableBuilderClass()
AssessmentStatus	status() The overall status of the assessment.
String	statusAsString() The overall status of the assessment.
AssessmentMetadata.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

name

public final String name()

The name of the assessment.

Returns:

The name of the assessment.

id

public final String id()

The unique identifier for the assessment.

Returns:

The unique identifier for the assessment.

description

public final String description()

The description of the assessment.

Returns:

The description of the assessment.

complianceType

public final String complianceType()

The name of the compliance standard that's related to the assessment, such as PCI-DSS.

Returns:

The name of the compliance standard that's related to the assessment, such as PCI-DSS.

status

public final AssessmentStatus status()

The overall status of the assessment.

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

Returns:

The overall status of the assessment.

See Also:

AssessmentStatus

statusAsString

public final String statusAsString()

The overall status of the assessment.

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

Returns:

The overall status of the assessment.

See Also:

AssessmentStatus

assessmentReportsDestination

public final AssessmentReportsDestination assessmentReportsDestination()

The destination that evidence reports are stored in for the assessment.

Returns:

The destination that evidence reports are stored in for the assessment.

scope

public final Scope scope()

The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.

Returns:

The wrapper of Amazon Web Services accounts and services that are in scope for the assessment.

hasRoles

public final boolean hasRoles()

For responses, this returns true if the service returned a value for the Roles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

roles

public final List<Role> roles()

The roles that are associated with the assessment.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoles() method.

Returns:

The roles that are associated with the assessment.

hasDelegations

public final boolean hasDelegations()

For responses, this returns true if the service returned a value for the Delegations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

delegations

public final List<Delegation> delegations()

The delegations that are associated with the assessment.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDelegations() method.

Returns:

The delegations that are associated with the assessment.

creationTime

public final Instant creationTime()

Specifies when the assessment was created.

Returns:

Specifies when the assessment was created.

lastUpdated

public final Instant lastUpdated()

The time of the most recent update.

Returns:

The time of the most recent update.

toBuilder

public AssessmentMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssessmentMetadata.Builder,AssessmentMetadata>

builder

public static AssessmentMetadata.Builder builder()

serializableBuilderClass

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